|
Size: 1839
Comment:
|
Size: 5451
Comment:
|
| 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 [[QuickStart2]])'' <<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}}} <<FootNote(http://www.selenic.com/mercurial/hgrc.5.html)>> (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 real URL is http://www.selenic.com/hg/ requesting all changes adding changesets adding manifests adding file changes added 9633 changesets with 19124 changes to 1271 files updating to branch default 1084 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]] from the default branch (see [[http://www.selenic.com/mercurial/hg.1.html#clone|clone]]). See which revision was checked out (see [[http://www.selenic.com/mercurial/hg.1.html#parents|parents]]): {{{ $ cd mercurial-repo $ hg parents changeset: 9632:16698d87ad20 tag: tip user: Nicolas Dumazet <...> date: Mon Sep 21 19:21:32 2009 +0200 summary: util: use sys.argv[0] if $HG is unset and 'hg' is not in PATH }}} The [[http://www.selenic.com/mercurial/hg.1.html#summary|summary]] command (introduced with Mercurial 1.4) will summarize the state of the [[WorkingDirectory|working directory]]. Command names may be abbreviated, so entering just {{{hg sum}}} is enough: {{{ $ hg sum parent: 9632:16698d87ad20 tip util: use sys.argv[0] if $HG is unset and 'hg' is not in PATH branch: default commit: (clean) update: (current) }}} {{{commit: (clean)}}} means that there no local changes, {{{update: (current)}}} means that the checked out files (in the working directory) are updated to the newest revsion in the repository. == Setting up a new Mercurial project == You'll want to start by creating a repository (see [[http://www.selenic.com/mercurial/hg.1.html#init|init]]): |
| Line 5: | Line 68: |
| $ 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 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 == |
Mercurial will look for a file named [[.hgignore]] <<FootNote(http://www.selenic.com/mercurial/hgignore.5.html)>> 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 75: |
| $ 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 (see [[http://www.selenic.com/mercurial/hg.1.html#status|status]]): {{{ $ 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 [[http://www.selenic.com/mercurial/hg.1.html#add|add]]ed, then [[http://www.selenic.com/mercurial/hg.1.html#commit|commit]]: {{{ $ hg add # add those 'unknown' files $ hg commit # commit all changes, edit changelog entry $ hg parents # see the currently checked out revision }}} For a detailed description of all command see http://www.selenic.com/mercurial/hg.1.html or enter {{{ $ hg help }}} to get an overview of all commands. Help for a specific command is available by giving the command name {{{ $ hg help add }}} == Clone, Commit, Merge == {{{ $ hg clone project project-work # clone repository $ cd project-work |
| Line 21: | Line 120: |
| $ 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 $ <make other changes> $ hg commit $ hg pull ../project-work # pull changesets from project-work $ hg merge # merge the new tip from project-work into our working directory $ hg parents # see the revisions that have been merged into the working directory |
| Line 28: | Line 129: |
| == Importing patches == | See also: [[Clone]], [[Commit]], [[Pull]], [[Merge]], [[Parent]] |
| Line 30: | Line 131: |
| 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 136: |
| $ hg tip 28237:747a537bd090880c29eae861df4d81b245aa0190 $ hg export 28237 > foo.patch # export changeset 28237 |
$ hg export tip # export the most recent commit |
| Line 58: | Line 139: |
| Network support: | See also: [[Export]] == Network support == |
| Line 61: | Line 144: |
| # pull from the primary Mercurial repo foo$ hg clone http://selenic.com/hg/ foo$ cd hg |
# clone from the primary Mercurial repo $ hg clone http://selenic.com/hg/ $ cd hg |
| Line 65: | Line 148: |
| # export your current repo via HTTP with browsable interface foo$ hg serve -n "My repo" -p 80 |
# pull new changes from an existing repo $ hg pull http://selenic.com/hg/ |
| Line 68: | Line 151: |
| # pushing changes to a remote repo with SSH foo$ hg push ssh://user@example.com/~/hg/ |
# update checked out files to the newest revision in the repository $ hg update |
| Line 71: | Line 154: |
| # merge changes from a remote machine bar$ hg pull http://foo/ bar$ hg update -m # merge changes into your working directory |
# export your current repo via HTTP with browsable interface on port 8000 $ hg serve -n "My repo" |
| Line 75: | Line 157: |
| # 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 |
# push changes to a remote repo with SSH $ hg push ssh://user@example.com/hg/ |
| Line 79: | Line 160: |
See also: [[Serve]], [[Push]], [[Pull]] ---- '''translations:''' [[ChineseQuickStart|Chinese]] [[FrenchQuickStart|Français]] [[QuickStartDe|German]] [[QuickStartPtBr|Portuguese]] [[JapaneseQuickStart|Japanese]] [[ThaiQuickStart|Thai]] |
Quick Start
(see also UnderstandingMercurial and Tutorial and QuickStart2)
Contents
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 1 (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 (for example http://selenic.com/hg), you can grab a copy like so:
$ hg clone http://selenic.com/hg mercurial-repo real URL is http://www.selenic.com/hg/ requesting all changes adding changesets adding manifests adding file changes added 9633 changesets with 19124 changes to 1271 files updating to branch default 1084 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 check out the tipmost changeset from the default branch (see clone).
See which revision was checked out (see parents):
$ cd mercurial-repo $ hg parents changeset: 9632:16698d87ad20 tag: tip user: Nicolas Dumazet <...> date: Mon Sep 21 19:21:32 2009 +0200 summary: util: use sys.argv[0] if $HG is unset and 'hg' is not in PATH
The summary command (introduced with Mercurial 1.4) will summarize the state of the working directory. Command names may be abbreviated, so entering just hg sum is enough:
$ hg sum parent: 9632:16698d87ad20 tip util: use sys.argv[0] if $HG is unset and 'hg' is not in PATH branch: default commit: (clean) update: (current)
commit: (clean) means that there no local changes, update: (current) means that the checked out files (in the working directory) are updated to the newest revsion in the repository.
3. Setting up a new Mercurial project
You'll want to start by creating a repository (see init):
$ cd project/ $ hg init # creates .hg
Mercurial will look for a file named .hgignore 2 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 (see status):
$ 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 $ hg parents # see the currently checked out revision
For a detailed description of all command see http://www.selenic.com/mercurial/hg.1.html or enter
$ hg help
to get an overview of all commands. Help for a specific command is available by giving the command name
$ hg help add
4. Clone, Commit, Merge
$ hg clone project project-work # clone repository $ cd project-work $ <make changes> $ hg commit $ cd ../project $ <make other changes> $ hg commit $ hg pull ../project-work # pull changesets from project-work $ hg merge # merge the new tip from project-work into our working directory $ hg parents # see the revisions that have been merged into the working directory $ hg commit # commit the result of the merge
See also: Clone, Commit, Pull, Merge, Parent
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 $ hg clone http://selenic.com/hg/ $ cd hg # pull new changes from an existing repo $ hg pull http://selenic.com/hg/ # update checked out files to the newest revision in the repository $ hg update # export your current repo via HTTP with browsable interface on port 8000 $ hg serve -n "My repo" # push changes to a remote repo with SSH $ hg push ssh://user@example.com/hg/
translations: Chinese Français German Portuguese Japanese Thai