Differences between revisions 6 and 40 (spanning 34 versions)
Revision 6 as of 2006-09-12 23:28:44
Size: 1992
Editor: Metaperl
Comment:
Revision 40 as of 2008-05-26 22:20:32
Size: 3303
Editor: abuehl
Comment: adding clone output
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
== Setting up a Mercurial project == #pragma section-numbers 2
= Quick Start =
''(see also [:UnderstandingMercurial] and [:Tutorial] and [:QuickStart])''

[[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 Windows system in {{{%USERPROFILE%\Mercurial.ini}}}) by adding lines such as the following:

{{{
[ui]
username = John Doe <john@example.com>
}}}

== 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
requesting all changes
adding changesets
adding manifests
adding file changes
added 6623 changesets with 12734 changes to 911 files
updating working directory
796 files updated, 0 files merged, 0 files removed, 0 files unresolved
}}}

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

== Setting up a new Mercurial project ==

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

{{{
Line 12: Line 71:
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 ==
== Clone, Commit, Merge ==
Line 19: Line 74:
$ hg clone linux linux-work # create a new branch
$ cd linux-work
$ hg clone project project-work # clone repository
$ cd project-work
Line 23: Line 78:
$ cd ../linux
$ hg pull ../linux-work   # pull changesets from linux-work
$ hg merge # 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 30: Line 84:
== Importing patches ==

Fast:
{{{
$ patch < ../p/foo.patch
$ hg add # add files added by the patch
$ hg remove --after # remove files 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
}}}
See also: [:Clone], [:Commit], [:Pull], [:Merge]
Line 56: Line 91:
$ hg tip
28237:747a537bd090880c29eae861df4d81b245aa0190
$ hg export 28237 > foo.patch # export changeset 28237
$ hg export tip # export the most recent commit
Line 60: Line 93:

See also: [:Export]
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/
# push changes to a remote repo with SSH
foo$ hg push ssh://user@example.com/hg/
}}}
Line 74: Line 113:
# merge changes from a remote machine
bar$ hg pull http://foo/
bar$ hg merge # merge changes into your working directory
See also: [:Serve], [:Push], [:Pull]
Line 78: Line 115:
# 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
}}}
----
'''translations:''' [:QuickStartDe:german] [:QuickStartPtBr:portuguese]

Quick Start

(see also [:UnderstandingMercurial] and [:Tutorial] and [:QuickStart])

TableOfContents

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 Windows system in %USERPROFILE%\Mercurial.ini) by adding lines such as the following:

[ui]
username = John Doe <john@example.com>

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
requesting all changes
adding changesets
adding manifests
adding file changes
added 6623 changesets with 12734 changes to 911 files
updating working directory
796 files updated, 0 files merged, 0 files removed, 0 files unresolved

This will create a new directory called mercurial-repo, grab the complete project history, and [:Update:check out] the [:Tip:tip]most [: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

See also: [:Export]

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/

See also: [:Serve], [:Push], [:Pull]


translations: [:QuickStartDe:german] [:QuickStartPtBr:portuguese]

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