Diff for "QuickStart"

Differences between revisions 14 and 23 (spanning 9 versions)

(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 turning your project directory into a Mercurial 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

$ 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]

-  ⇤ ← Revision 14 as of 2007-04-20 23:10:21 → 
  Size: 2694
  Editor: inet-netcache2-o
  Comment:
+   ← Revision 23 as of 2007-08-13 01:50:40 → ⇥
  Size: 2779
  Editor: ThurnerRupert
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
+#language en
-Line 5:
+Line 6:
-By default Mercurial uses a username of the form 'user@localhost' for commits.
+By default Mercurial uses a username of the form '{{{user@localhost}}}' for commits.
-Line 15:
+Line 16:
-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 (eg: {{{http://selenic.com/hg}}}), you can grab a copy like so:
-Line 21:
+Line 22:
-This will create a new directory called hg (by default), grab the complete project history, and check out the topmost changeset.
+This will create a new directory called {{{hg}}} (by default), grab the complete project history, and check out the tipmost changeset.
-Line 25:
+Line 26:
-You'll want to start by creating an hg repository:
+You'll want to start by turning your project directory into a Mercurial repository:
-Line 32:
+Line 33:
-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. Here's an example .hgignore file:
+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:
-Line 54:
+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: