Differences between revisions 10 and 33 (spanning 23 versions)
Revision 10 as of 2006-12-10 20:43:33
Size: 3239
Editor: mpm
Comment:
Revision 33 as of 2008-01-20 20:30:27
Size: 2824
Editor: Jose Muanis
Comment: Add link to portuguese brazilian translation
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
(see also UnderstandingMercurial and ["Tutorial"])
Line 3: Line 5:
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}}} by adding lines such as the following:
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:
Line 13: Line 15:
If you have a URL to a browsable project repository (eg: http://selenic.com/hg), you can grab a copy like so: If you have a URL to a browsable project [:Repository:repository] (for example [http://selenic.com/hg]), you can grab a copy like so:
Line 19: Line 21:
This will create a new directory called hg (by default), grab the complete project history, and check out the tipmost changeset. This will create a new directory called {{{hg}}} (by default), grab the complete project history, and check out the tipmost [:ChangeSet:changeset] (see also ["Clone"]).
Line 23: Line 25:
You'll want to start by creating an hg repository: You'll want to start by creating a repository:
Line 31: Line 33:
repository which contains a set of regular expressions to ignore in
file paths. Here's an example .hgignore file:
repository which contains a set of glob patterns and regular expressions to ignore in file paths. Here's an example .hgignore file:
Line 52: Line 53:
This will list all files that are not ignored with a 'U' flag (unknown). 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: 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:commit]:
Line 62: Line 63:
$ 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 66: Line 67:
$ 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 72: Line 71:
}}}

== Importing patches ==

Fast:
{{{
$ patch < ../p/foo.patch
$ hg addremove # add and remove files added/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
Line 99: Line 78:
$ hg tip
28237:747a537bd090880c29eae861df4d81b245aa0190
$ hg export 28237 > foo.patch # export changeset 28237
$ hg export tip # export the most recent commit
Line 107: Line 84:
# pull from the primary Mercurial repo # clone from the primary Mercurial repo
Line 110: Line 87:

# update an existing repo
foo$ hg pull http://selenic.com/hg/
Line 114: Line 94:
# 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 125: Line 97:
----
'''translations:''' [:QuickStartDe:german] [:QuickStartPtBr:portuguese]

(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:repository] (for example [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:changeset] (see also ["Clone"]).

Setting up a new Mercurial project

You'll want to start by creating a 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:commit]:

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

Branching and merging

$ 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

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] [:QuickStartPtBr:portuguese]

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