author | Matt Mackall <mpm@selenic.com> |
Sat, 16 Dec 2006 14:41:34 -0600 | |
changeset 3911 | fe075ddf3272 |
parent 3847 | 048e9bc5cdc2 |
child 3935 | 1158d7018052 |
permissions | -rw-r--r-- |
445 | 1 |
MERCURIAL QUICK-START |
2 |
||
204
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
3 |
Setting up Mercurial: |
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
4 |
|
204
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
5 |
Note: some distributions fails to include bits of distutils by |
205
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
6 |
default, you'll need python-dev to install. You'll also need a C |
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
7 |
compiler and a 3-way merge tool like merge, tkdiff, or kdiff3. |
204
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
8 |
|
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
9 |
First, unpack the source: |
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
10 |
|
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
11 |
$ tar xvzf mercurial-<ver>.tar.gz |
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
12 |
$ cd mercurial-<ver> |
204
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
13 |
|
2208 | 14 |
When installing, change python to python2.3 or python2.4 if 2.2 is the |
15 |
default on your system. |
|
16 |
||
205
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
17 |
To install system-wide: |
204
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
18 |
|
2208 | 19 |
$ python setup.py install --force |
204
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
20 |
|
205
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
21 |
To install in your home directory (~/bin and ~/lib, actually), run: |
204
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
22 |
|
2208 | 23 |
$ python setup.py install --home=${HOME} --force |
507 | 24 |
$ export PYTHONPATH=${HOME}/lib/python # (or lib64/ on some systems) |
25 |
$ export PATH=${HOME}/bin:$PATH # add these to your .bashrc |
|
205
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
26 |
|
204
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
27 |
And finally: |
161cef501e8d
README: integrate various changes and suggestions from Rafael Villar Burke
mpm@selenic.com
parents:
182
diff
changeset
|
28 |
|
3847
048e9bc5cdc2
Update README to mention hg debuginstall
Matt Mackall <mpm@selenic.com>
parents:
3689
diff
changeset
|
29 |
$ hg debuginstall # run some basic tests |
048e9bc5cdc2
Update README to mention hg debuginstall
Matt Mackall <mpm@selenic.com>
parents:
3689
diff
changeset
|
30 |
$ hg # show help |
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
31 |
|
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
32 |
If you get complaints about missing modules, you probably haven't set |
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
33 |
PYTHONPATH correctly. |
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
34 |
|
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
35 |
Setting up a Mercurial project: |
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
36 |
|
2208 | 37 |
$ hg init project # creates project directory |
38 |
$ cd project |
|
39 |
# copy files in, edit them |
|
40 |
$ hg add # add all unknown files |
|
41 |
$ hg commit # commit all changes, edit changelog entry |
|
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
42 |
|
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
43 |
Mercurial will look for a file named .hgignore in the root of your |
633
f597539c7abd
Slim down and update README a bit
Matt Mackall <mpm@selenic.com>
parents:
631
diff
changeset
|
44 |
repository which contains a set of regular expressions to ignore in |
f597539c7abd
Slim down and update README a bit
Matt Mackall <mpm@selenic.com>
parents:
631
diff
changeset
|
45 |
file paths. |
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
46 |
|
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
47 |
Branching and merging: |
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
48 |
|
3507 | 49 |
$ hg clone project project-work # create a new branch |
50 |
$ cd project-work |
|
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
51 |
$ <make changes> |
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
52 |
$ hg commit |
3507 | 53 |
$ cd ../project |
54 |
$ hg pull ../project-work # pull changesets from project-work |
|
55 |
$ hg merge # merge the new tip from project-work into |
|
261 | 56 |
# our working directory |
633
f597539c7abd
Slim down and update README a bit
Matt Mackall <mpm@selenic.com>
parents:
631
diff
changeset
|
57 |
$ hg commit # commit the result of the merge |
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
58 |
|
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
59 |
Importing patches: |
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
60 |
|
3507 | 61 |
Simple: |
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
62 |
$ patch < ../p/foo.patch |
2208 | 63 |
$ hg commit -A |
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
64 |
|
3507 | 65 |
Fast: |
1308
2073e5a71008
Cleanup of tabs and trailing spaces.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
981
diff
changeset
|
66 |
$ cat ../p/patchlist | xargs hg import -p1 -b ../p |
0
9117c6561b0b
Add back links from file revisions to changeset revisions
mpm@selenic.com
parents:
diff
changeset
|
67 |
|
205
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
68 |
Exporting a patch: |
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
69 |
|
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
70 |
(make changes) |
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
71 |
$ hg commit |
3507 | 72 |
$ hg export tip > foo.patch # export latest change |
205
d255d99a7cbd
README: integrate some changes from Kevin Smith
mpm@selenic.com
parents:
204
diff
changeset
|
73 |
|
63 | 74 |
Network support: |
75 |
||
445 | 76 |
# pull from the primary Mercurial repo |
1308
2073e5a71008
Cleanup of tabs and trailing spaces.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
981
diff
changeset
|
77 |
foo$ hg clone http://selenic.com/hg/ |
633
f597539c7abd
Slim down and update README a bit
Matt Mackall <mpm@selenic.com>
parents:
631
diff
changeset
|
78 |
foo$ cd hg |
1
273ce12ad8f1
Update README to discuss remote pull, rsync, and the hg repo
mpm@selenic.com
parents:
0
diff
changeset
|
79 |
|
3689
25e549e9b7d0
Improved examples for network support in README.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3507
diff
changeset
|
80 |
# make your current repo available via http://server:8000/ |
25e549e9b7d0
Improved examples for network support in README.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3507
diff
changeset
|
81 |
foo$ hg serve |
1308
2073e5a71008
Cleanup of tabs and trailing spaces.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
981
diff
changeset
|
82 |
|
3689
25e549e9b7d0
Improved examples for network support in README.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3507
diff
changeset
|
83 |
# pushing and pulling changes to/from a remote repo with SSH |
25e549e9b7d0
Improved examples for network support in README.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3507
diff
changeset
|
84 |
foo$ hg push ssh://user@example.com/my/repository |
25e549e9b7d0
Improved examples for network support in README.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3507
diff
changeset
|
85 |
foo$ hg pull ssh://user@example.com//home/somebody/his/repository |
327 | 86 |
|
3689
25e549e9b7d0
Improved examples for network support in README.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3507
diff
changeset
|
87 |
# merge changes from a remote machine (e.g. running 'hg serve') |
25e549e9b7d0
Improved examples for network support in README.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3507
diff
changeset
|
88 |
bar$ hg pull http://foo:8000/ |
2208 | 89 |
bar$ hg merge # merge changes into your working directory |
3689
25e549e9b7d0
Improved examples for network support in README.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
3507
diff
changeset
|
90 |
bar$ hg commit # commit merge in to your local repository |
63 | 91 |
|
160 | 92 |
# Set up a CGI server on your webserver |
445 | 93 |
foo$ cp hgweb.cgi ~/public_html/hg/index.cgi |
94 |
foo$ emacs ~/public_html/hg/index.cgi # adjust the defaults |
|
969 | 95 |
|
96 |
For more info: |
|
97 |
||
98 |
Documentation in doc/ |
|
99 |
Mercurial website at http://selenic.com/mercurial |