Differences between revisions 9 and 27 (spanning 18 versions)
Revision 9 as of 2006-10-07 12:05:45
Size: 2034
Comment: hg addremove is no longer deprecated
Revision 27 as of 2007-10-16 13:41:47
Size: 3210
Editor: acuc35
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
== Setting up a Mercurial project == (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:
Line 6: Line 30:
$ <create .hgignore file>
$ hg status # show all non-ignored files
}}}

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:

{{{
Line 12: Line 60:
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 18: Line 62:
There are two ways to do this in recent mercurial releases.
First, you can make branches outside of your working directory:
Line 19: Line 66:
$ hg clone linux linux-work # create a new branch
$ cd linux-work
$ hg clone project project-work # create a new branch
$ cd project-work
Line 23: Line 70:
$ 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
$ cd ../project
$ hg pull ../project-work # pull changesets from project-work
$ hg merge # merge the new tip from project-work into our working directory
Line 31: Line 76:
== Importing patches ==

Fast:
or using named branches which appeared in Mercurial 0.9.4:
Line 35: Line 78:
$ patch < ../p/foo.patch
$ hg addremove # add and remove files added/removed by the patch
$ hg branch work # create a new branch
$ hg checkout work # switch to it
<make changes>
Line 38: Line 82:
$ hg checkout default # switch back to default branch
$ hg merge work # merge the branches
$ hg commit # commit the result of the merge
Line 39: Line 86:

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

Fastest:
{{{
$ cat ../p/patchlist | xargs hg import -p1 -b ../p
}}}
Note: Named branches can currently not be removed!
Line 56: Line 93:
$ hg tip
28237:747a537bd090880c29eae861df4d81b245aa0190
$ hg export 28237 > foo.patch # export changeset 28237
$ hg export tip # export the most recent commit
Line 64: Line 99:
# pull from the primary Mercurial repo # clone from the primary Mercurial repo
Line 67: Line 102:

# update an existing repo
foo$ hg pull http://selenic.com/hg/
Line 71: Line 109:
# 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
# push changes to a remote repo with SSH
foo$ hg push ssh://user@example.com/hg/
Line 82: Line 112:
----
'''translations:''' [:QuickStartDe:german]

(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:

$ cd project/
$ hg init           # creates .hg

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:

$ hg add            # add those 'unknown' files
$ hg commit         # commit all changes, edit changelog entry

Branching and merging

There are two ways to do this in recent mercurial releases. First, you can make branches outside of your working directory:

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

or using named branches which appeared in Mercurial 0.9.4:

$ hg branch work # create a new branch
$ hg checkout work # switch to it
<make changes>
$ hg commit
$ hg checkout default # switch back to default branch
$ hg merge work # merge the branches
$ hg commit # commit the result of the merge

Note: Named branches can currently not be removed!

Exporting a patch

(make changes)
$ hg commit
$ hg export tip    # export the most recent commit

Network support

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

# update an existing repo
foo$ hg pull http://selenic.com/hg/

# export your current repo via HTTP with browsable interface
foo$ hg serve -n "My repo" -p 80

# push changes to a remote repo with SSH
foo$ hg push ssh://user@example.com/hg/


translations: [:QuickStartDe:german]

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