A Scalable, User-Friendly Source Control System.
Go to file
Colin McMillen d23819428b Add MOTD display to hgweb and hgwebdir.
The hgweb "footer" template now has space for an optional message of
the day (MOTD). This is used in two contexts:

1) On the hgwebdir index page
2) On various pages of each individual repo

For both cases, the MOTD is read out of an entry named "motd" in the
[web] section of a config file -- the only difference is which file is
used. For #1, you need to add the section to hgweb.config; for #2, you
need to add to the repo's .hgrc file.

I suggest something like this:

[web]
motd = <p>To download these repositories, <a href="http://www.selenic.com/mercurial">get Mercurial</a> and then type something like:</p><p><pre>hg clone http://gs3080.sp.cs.cmu.edu/hg.cgi/cpmpy</pre></p>You can also click the Download links to get an archive of the latest revision.

An online sample is available here:
http://gs3080.sp.cs.cmu.edu/hg.cgi
2006-04-27 22:11:13 -07:00
contrib convert-repo: fix reversed time zone offset 2006-04-19 11:29:41 -07:00
doc Web site and wiki are now the same. 2006-04-01 19:11:59 +02:00
hgext Fix hg qdiff <file> 2006-04-19 11:41:27 -07:00
mercurial Add MOTD display to hgweb and hgwebdir. 2006-04-27 22:11:13 -07:00
templates Add MOTD display to hgweb and hgwebdir. 2006-04-27 22:11:13 -07:00
tests merge with crew. 2006-04-27 22:10:45 -07:00
.hgignore let run-tests run optional code coverage tests. 2006-04-13 17:11:04 -07:00
comparison.txt Cleanup of tabs and trailing spaces. 2005-09-21 07:56:19 +02:00
CONTRIBUTORS Added my name to the contributors list. 2006-04-23 00:18:58 +02:00
COPYING Add COPYING 2005-06-17 09:32:13 -08:00
hg Update copyright notice 2006-02-05 22:21:02 -06:00
hgeditor Run commit message editor in the repo root (like hooks). 2006-02-09 07:01:23 +01:00
hgmerge Try to use /usr/bin/test or /bin/test to work around missing features. 2006-04-07 22:31:54 +02: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 hgwebdir: export collections of repos 2006-02-10 11:25:07 -08:00
Makefile add a target for running only one test 2005-10-24 14:53:36 -07:00
MANIFEST.in Added doc/gendoc.py to MANIFEST.in, so docs can be regenerated on demand. 2006-04-11 06:34:27 +02:00
notes.txt Cleanup of tabs and trailing spaces. 2005-09-21 07:56:19 +02:00
README Web site and wiki are now the same. 2006-04-01 19:11:59 +02:00
rewrite-log Simple script to recompress a log file 2005-05-23 16:06:25 -08:00
setup.py Don't forget version at the end of setup.py, write it only if changed. 2006-03-19 21:26:58 +01: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