A Scalable, User-Friendly Source Control System.
Go to file
Bryan O'Sullivan 22c1455510 Merge with MPM.
2005-08-24 12:50:11 -07:00
contrib Merge with MPM. 2005-08-24 12:50:11 -07:00
doc Teach annotate about binary files 2005-08-23 20:21:52 -07:00
mercurial Merge with MPM. 2005-08-24 12:50:11 -07:00
templates Add web:style option 2005-08-21 15:00:02 -07:00
tests Fix up help for binary options 2005-08-24 00:09:56 -07:00
.hgignore In-progress Emacs snapshot. 2005-08-19 06:41:29 -08:00
comparison.txt Minor updates to comparison 2005-05-23 16:05:05 -08:00
CONTRIBUTORS Added Tristan Wibberley to contributors. 2005-08-06 21:59:22 +01:00
COPYING Add COPYING 2005-06-17 09:32:13 -08:00
hg Whitespace cleanups 2005-06-29 10:42:35 -08:00
hgeditor Don't show the diff in hgeditor if there are no changes in file contents. 2005-08-22 19:56:52 +02:00
hgmerge Cleaned up trap handling: 2005-08-04 17:43:05 +01:00
hgweb.cgi hgweb: pull cgitb into CGI script example, where it can easily be disabled 2005-06-17 08:50:11 -08:00
hgwebdir.cgi Add a multi-repository server 2005-08-19 16:38:25 -08:00
Makefile Add default make rule 2005-08-24 00:36:12 -07:00
MANIFEST.in Add Makefile to the manifest 2005-08-24 00:38:36 -07:00
notes.txt Some tweaking of notes.txt 2005-06-05 00:42:44 -08:00
PKG-INFO Minor packaging fixups 2005-06-23 13:51:22 -08:00
README Minor README updates 2005-08-20 00:49:41 -07:00
rewrite-log Simple script to recompress a log file 2005-05-23 16:06:25 -08:00
setup.py More whitespace cleanups 2005-07-02 13:40:15 -08:00

MERCURIAL QUICK-START

Setting up Mercurial:

 Note: some distributions fails to include bits of distutils by
 default, you'll need python-dev to install. You'll also need a C
 compiler and a 3-way merge tool like merge, tkdiff, or kdiff3.

 First, unpack the source:

 $ tar xvzf mercurial-<ver>.tar.gz
 $ cd mercurial-<ver>

 To install system-wide:

 $ python setup.py install   # change python to python2.3 if 2.2 is default

 To install in your home directory (~/bin and ~/lib, actually), run:

 $ python2.3 setup.py install --home=~
 $ export PYTHONPATH=${HOME}/lib/python  # (or lib64/ on some systems)
 $ export PATH=${HOME}/bin:$PATH         # add these to your .bashrc

 And finally:

 $ hg                                    # test installation, show help

 If you get complaints about missing modules, you probably haven't set
 PYTHONPATH correctly.

Setting up a Mercurial project:

 $ cd project/
 $ hg init         # creates .hg
 $ hg addremove    # add all unknown files and remove all missing files
 $ hg commit       # commit all changes, edit changelog entry

 Mercurial will look for a file named .hgignore in the root of your
 repository which contains a set of regular expressions to ignore in
 file paths.

Branching and merging:

 $ hg clone linux linux-work    # create a new branch
 $ cd linux-work
 $ <make changes>
 $ hg commit
 $ cd ../linux
 $ hg pull ../linux-work     # pull changesets from linux-work
 $ hg update -m              # merge the new tip from linux-work into
                             # our working directory
 $ hg commit                 # commit the result of the merge

Importing patches:

 Fast:
 $ patch < ../p/foo.patch
 $ hg addremove
 $ hg commit

 Faster:
 $ patch < ../p/foo.patch
 $ hg commit `lsdiff -p1 ../p/foo.patch`

 Fastest:
 $ cat ../p/patchlist | xargs hg import -p1 -b ../p 

Exporting a patch:

 (make changes)
 $ hg commit
 $ hg tip
 28237:747a537bd090880c29eae861df4d81b245aa0190
 $ hg export 28237 > foo.patch    # export changeset 28237

Network support:

 # pull from the primary Mercurial repo
 foo$ hg clone http://selenic.com/hg/ 
 foo$ cd hg

 # export your current repo via HTTP with browsable interface
 foo$ hg serve -n "My repo" -p 80
 
 # pushing changes to a remote repo with SSH
 foo$ hg push ssh://user@example.com/~/hg/

 # merge changes from a remote machine
 bar$ hg pull http://foo/
 bar$ hg update -m        # merge changes into your working directory

 # Set up a CGI server on your webserver
 foo$ cp hgweb.cgi ~/public_html/hg/index.cgi
 foo$ emacs ~/public_html/hg/index.cgi # adjust the defaults

For more info:

 Documentation in doc/
 Mercurial website at http://selenic.com/mercurial
 Mercurial wiki at http://selenic.com/mercurial/wiki