|
Size: 3304
Comment:
|
Size: 5949
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| #pragma section-numbers 2 = Quick Start = ''(see also [:UnderstandingMercurial] and [:Tutorial] and [:QuickStart2])'' |
= Quick start = ''(see also [[UnderstandingMercurial]], [[Tutorial]], [[QuickStart2]] and http://mercurial.selenic.com/quickstart/)'' |
| Line 5: | Line 4: |
| [[TableOfContents]] | <<TableOfContents>> |
| Line 10: | Line 9: |
| 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: | 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: |
| Line 19: | Line 18: |
| If you have a URL to a browsable project [:Repository:repository] (for example [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 23: | Line 22: |
| real URL is http://www.selenic.com/hg/ | |
| Line 27: | Line 27: |
| added 6623 changesets with 12734 changes to 911 files updating working directory 796 files updated, 0 files merged, 0 files removed, 0 files unresolved |
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 |
| Line 32: | Line 32: |
| 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"]). | This will create a new directory called {{{mercurial-repo}}}, grab the complete project history, and [[http://www.selenic.com/mercurial/hg.1.html#update|check out]] the [[http://www.selenic.com/mercurial/hg.1.html#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 [[http://www.selenic.com/mercurial/hg.1.html#update|update]]d to the newest revision in the repository. |
| Line 36: | Line 63: |
| You'll want to start by creating a repository: | You'll want to start by creating a repository (see [[http://www.selenic.com/mercurial/hg.1.html#init|init]]): |
| Line 43: | Line 70: |
| Mercurial will look for a file named [".hgignore"] in the root of your | Mercurial will look for a file named [[.hgignore]] <<FootNote(http://www.selenic.com/mercurial/hgignore.5.html)>> in the root of your |
| Line 58: | Line 85: |
| Test your .hgignore file with: | Test your .hgignore file with (see [[http://www.selenic.com/mercurial/hg.1.html#status|status]]): |
| Line 64: | Line 91: |
| 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]: | 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]]: |
| Line 68: | Line 95: |
| $ hg commit # commit all changes, edit changelog entry | $ hg commit # commit all changes into a new changeset, edit changelog entry $ hg parents # see the currently checked out revision (or changeset) |
| Line 71: | Line 99: |
| == Clone, Commit, Merge == | For a detailed description of all commands 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 == |
| Line 79: | Line 120: |
| $ <make other changes> $ hg commit |
|
| Line 81: | Line 124: |
| $ hg parents # see the revisions that have been merged into the working directory | |
| Line 84: | Line 128: |
| See also: [:Clone], [:Commit], [:Pull], [:Merge] | See [[http://www.selenic.com/mercurial/hg.1.html#clone|clone]], [[http://www.selenic.com/mercurial/hg.1.html#commit|commit]], [[http://www.selenic.com/mercurial/hg.1.html#pull|pull]], [[http://www.selenic.com/mercurial/hg.1.html#merge|merge]] |
| Line 94: | Line 138: |
| See also: [:Export] | See [[http://www.selenic.com/mercurial/hg.1.html#export|export]] |
| Line 100: | Line 144: |
| foo$ hg clone http://selenic.com/hg/ foo$ cd hg |
$ hg clone http://selenic.com/hg/ $ cd hg |
| Line 103: | Line 147: |
| # update an existing repo foo$ hg pull http://selenic.com/hg/ |
# pull new changesets from an existing other repo into the repository (.hg) $ hg pull http://selenic.com/hg/ |
| Line 106: | Line 150: |
| # export your current repo via HTTP with browsable interface foo$ hg serve -n "My repo" -p 80 |
# export your current repo via HTTP with browsable interface on port 8000 $ hg serve -n "My repo" |
| Line 109: | Line 153: |
| # push changes to a remote repo with SSH foo$ hg push ssh://user@example.com/hg/ |
# push changesets to a remote repo with SSH $ hg push ssh://user@example.com/hg/ |
| Line 113: | Line 157: |
| See also: [:Serve], [:Push], [:Pull] | See [[http://www.selenic.com/mercurial/hg.1.html#pull|pull]], [[http://www.selenic.com/mercurial/hg.1.html#serve|serve]], [[http://www.selenic.com/mercurial/hg.1.html#push|push]] |
| Line 116: | Line 160: |
| '''translations:''' [:QuickStartDe:german] [:QuickStartPtBr:portuguese] | '''translations:''' [[ChineseQuickStart|Chinese]] [[FrenchQuickStart|Français]] [[QuickStartDe|German]] [[QuickStartPtBr|Portuguese]] [[JapaneseQuickStart|Japanese]] [[ThaiQuickStart|Thai]] |
Quick start
(see also UnderstandingMercurial, Tutorial, QuickStart2 and http://mercurial.selenic.com/quickstart/)
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 revision 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 into a new changeset, edit changelog entry $ hg parents # see the currently checked out revision (or changeset)
For a detailed description of all commands 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 clone, commit, pull, merge
5. Exporting a patch
(make changes) $ hg commit $ hg export tip # export the most recent commit
See export
6. Network support
# clone from the primary Mercurial repo $ hg clone http://selenic.com/hg/ $ cd hg # pull new changesets from an existing other repo into the repository (.hg) $ hg pull http://selenic.com/hg/ # export your current repo via HTTP with browsable interface on port 8000 $ hg serve -n "My repo" # push changesets to a remote repo with SSH $ hg push ssh://user@example.com/hg/
translations: Chinese Français German Portuguese Japanese Thai