Differences between revisions 18 and 25 (spanning 7 versions)
Revision 18 as of 2007-07-02 20:29:22
Size: 3210
Comment: Add named branches
Revision 25 as of 2007-10-16 13:40:45
Size: 2066
Editor: CMPC009-121
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
(see also UnderstandingMercurial and Tutorial)

== Setting a username ==

By default Mercurial uses a username of the form 'user@localhost' for commits.
This is often meaningless. It's best to configure a proper email address in {{{~/.hgrc}}} (or on a Win system {{{%USERPROFILE%\Mercurial.ini}}}) by adding lines such as the following:

{{{
[ui]
username = Author Name <email@address>
}}}

== Working on an existing Mercurial project ==

If you have a URL to a browsable project repository (eg: http://selenic.com/hg), you can grab a copy like so:

{{{
$ hg clone http://selenic.com/hg
}}}

This will create a new directory called hg (by default), grab the complete project history, and check out the tipmost changeset.

== Setting up a new Mercurial project ==

You'll want to start by creating an hg repository:
== Setting up a Mercurial project ==
Line 30: Line 6:
}}}

Mercurial will look for a file named [".hgignore"] in the root of your
repository which contains a set of glob patterns and regular expressions to ignore in file paths. Here's an example .hgignore file:

{{{
syntax: glob
*.orig
*.rej
*~
*.o
tests/*.err

syntax: regexp
.*\#.*\#$
}}}

Test your .hgignore file with:

{{{
$ hg status # show all non-ignored files
}}}

This will list all files that are not ignored with a '?' flag (not tracked). Edit your .hgignore file until only files you want to track are listed by status. You'll want to track your .hgignore file too! But you'll probably not want to track files generated by your build process. Once you're satisfied, schedule your files to be added, then commit:

{{{
$ <create .hgignore file>
$ hg status # show all non-ignored files
Line 60: Line 12:
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.
Line 62: Line 18:
There are two ways to do this in recent mercurial releases.
First, you can make branches outside of your working directory:
Line 66: Line 19:
$ hg clone project project-work # create a new branch
$ cd project-work
$ hg clone linux linux-work # create a new branch
$ cd linux-work
Line 70: Line 23:
$ cd ../project
$ hg pull ../project-work # pull changesets from project-work
$ hg merge # merge the new tip from project-work into our working directory
$ cd ../linux
$ hg pull ../linux-work # pull changesets from linux-work
$ hg merge # merge the new tip from linux-work into
                            # (old versions used "hg update -m" instead)
                            # our working directory
Line 76: Line 31:
or using named branches which appeared in Mercurial 0.9.4: == Importing patches ==

Fast:
Line 78: Line 35:
$ hg branch work # create a new branch
$ hg checkout work # switch to it
<make changes>
$ patch < ../p/foo.patch
$ hg add # add files added by the patch
$ hg remove --after # remove files removed by the patch
Line 82: Line 39:
$ hg checkout default # switch back to default branch
$ hg merge work # merge the branches
$ hg commit # commit the result of the merge
Line 86: Line 40:
Note: Named branches can currently not be removed!
Faster:
{{{
$ patch < ../p/foo.patch
$ hg commit `lsdiff -p1 ../p/foo.patch`
}}}

Fastest:
{{{
$ cat ../p/patchlist | xargs hg import -p1 -b ../p
}}}
Line 93: Line 57:
$ hg export tip # export the most recent commit $ hg tip
28237:747a537bd090880c29eae861df4d81b245aa0190
$ hg export 28237 > foo.patch # export changeset 28237
Line 99: Line 65:
# clone from the primary Mercurial repo # pull from the primary Mercurial repo
Line 102: Line 68:

# update an existing repo
foo$ hg pull http://selenic.com/hg/
Line 109: Line 72:
# push changes to a remote repo with SSH
foo$ hg push ssh://user@example.com/hg/
# 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 merge # merge changes into your working directory

# Set up a CGI server on your webserver
foo$ cp hgwebdir.cgi ~/public_html/hg/index.cgi
foo$ emacs ~/public_html/hg/index.cgi # adjust the defaults
Line 112: Line 83:
----
'''translations:''' [:QuickStartDe:german]

Setting up a Mercurial project

$ cd project/
$ hg init           # creates .hg
$ <create .hgignore file>
$ hg status         # show all non-ignored files  
$ hg add            # add those 'unknown' 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 merge                  # merge the new tip from linux-work into
                            # (old versions used "hg update -m" instead)
                            # our working directory
$ hg commit                 # commit the result of the merge

Importing patches

Fast:

$ patch < ../p/foo.patch
$ hg add            # add files added by the patch
$ hg remove --after # remove files removed by the patch
$ 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 merge # merge changes into your working directory

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

QuickStart (last edited 2024-05-20 06:56:26 by AntonShestakov)