Differences between revisions 12 and 39 (spanning 27 versions)

Quick Start

(see also UnderstandingMercurial and ["Tutorial"] and QuickStart2)

1. 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>

2. 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 mercurial-repo

This will create a new directory called mercurial-repo, grab the complete project history, and check out the tipmost [:ChangeSet:changeset] (see also ["Clone"]).

3. 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

4. Clone, Commit, Merge

$ hg clone project project-work    # clone repository
$ 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

See also: [:Clone], [:Commit], [:Pull], [:Merge]

5. Exporting a patch

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

6. 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/

-  ⇤ ← Revision 12 as of 2006-12-30 16:18:27 → 
  Size: 2639
  Editor: ThiloPfennig
  Comment: translations
+   ← Revision 39 as of 2008-03-25 09:15:18 → ⇥
  Size: 3038
  Editor: abuehl
  Comment: #pragma section-numbers
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-(see also UnderstandingMercurial and Tutorial)
+#pragma section-numbers 2
= Quick Start =
''(see also UnderstandingMercurial and ["Tutorial"] and QuickStart2)''

[[TableOfContents]]
-Line 5:
+Line 9:
-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 15:
+Line 19:
-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 18:
+Line 22:
-$ hg clone http://selenic.com/hg
+$ hg clone http://selenic.com/hg mercurial-repo
-Line 21:
+Line 25:
-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 {{{mercurial-repo}}}, grab the complete project history, and check out the tipmost [:ChangeSet:changeset] (see also ["Clone"]).
-Line 25:
+Line 29:
-You'll want to start by creating an hg repository:
+You'll want to start by creating a repository:
-Line 33:
+Line 37:
-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 54:
+Line 57:
-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 61:
+Line 64:
-== Branching and merging ==
+== Clone, Commit, Merge ==
-Line 64:
+Line 67:
-$ hg clone project project-work    # create a new branch
+$ hg clone project project-work    # clone repository
-Line 74:
+Line 77:
+See also: [:Clone], [:Commit], [:Pull], [:Merge]
-Line 81:
+Line 86:
+See also: [:Export]
-Line 98:
+Line 105:
+See also: [:Serve], [:Push], [:Pull]
-Line 99:
+Line 109:
-'''translations:''' [:QuickStartDe:german]
+'''translations:''' [:QuickStartDe:german] [:QuickStartPtBr:portuguese]

Diff for "QuickStart"