Differences between revisions 1 and 36 (spanning 35 versions)

Quick Start

(see also UnderstandingMercurial and ["Tutorial"])

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

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"]).

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 1 as of 2005-09-09 00:49:32 → 
  Size: 1839
  Editor: mpm
  Comment:
+   ← Revision 36 as of 2008-02-10 11:06:49 → ⇥
  Size: 2981
  Editor: abuehl
  Comment: +toc
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-== Setting up a Mercurial project ==
+= Quick Start =
''(see also UnderstandingMercurial and ["Tutorial"])''

[[TableOfContents]]

== 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:
-Line 5:
+Line 32:
-$ hg init         # creates .hg
$ hg addremove    # add all unknown files and remove all missing files
$ hg commit       # commit all changes, edit changelog entry
+$ hg init           # creates .hg
-Line 10:
+Line 35:
-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 ==
+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 17:
+Line 39:
-$ hg clone linux linux-work    # create a new branch
$ cd linux-work
+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
}}}

== Clone, Commit, Merge ==

{{{
$ hg clone project project-work    # clone repository
$ cd project-work
-Line 21:
+Line 70:
-$ cd ../linux
$ hg pull ../linux-work     # pull changesets from linux-work
$ hg update -m              # merge the new tip from linux-work into
                            # 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 28:
+Line 76:
-== Importing patches ==
+See also: [:Clone], [:Commit], [:Pull], [:Merge]
-Line 30:
+Line 78:
-Fast:
{{{
 $ patch < ../p/foo.patch
 $ hg addremove
 $ 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:
+== Exporting a patch ==
-Line 53:
+Line 83:
-$ hg tip
28237:747a537bd090880c29eae861df4d81b245aa0190
$ hg export 28237 > foo.patch    # export changeset 28237
+$ hg export tip    # export the most recent commit
-Line 58:
+Line 86:
-Network support:
+See also: [:Export]

== Network support ==
-Line 61:
+Line 91:
-# pull from the primary Mercurial repo
+# clone from the primary Mercurial repo
-Line 64:
+Line 94:
+# update an existing repo
foo$ hg pull http://selenic.com/hg/
-Line 68:
+Line 101:
-# pushing changes to a remote repo with SSH
foo$ hg push ssh://user@example.com/~/hg/
+# push changes to a remote repo with SSH
foo$ hg push ssh://user@example.com/hg/
}}}
-Line 71:
+Line 105:
-# merge changes from a remote machine
bar$ hg pull http://foo/
bar$ hg update -m        # merge changes into your working directory
+See also: [:Serve], [:Push], [:Pull]
-Line 75:
+Line 107:
-# Set up a CGI server on your webserver
foo$ cp hgweb.cgi ~/public_html/hg/index.cgi
foo$ emacs ~/public_html/hg/index.cgi # adjust the defaults
}}}
+----
'''translations:''' [:QuickStartDe:german] [:QuickStartPtBr:portuguese]

Diff for "QuickStart"