|
Size: 3304
Comment:
|
Size: 4519
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| ''(see also [:UnderstandingMercurial] and [:Tutorial] and [:QuickStart2])'' | |
| Line 5: | Line 4: |
| [[TableOfContents]] | An introduction for the impatient. <<TableOfContents>> |
| Line 9: | Line 10: |
| 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: |
The first thing you should do is set the username Mercurial will use for commits. 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 creating it and adding lines like the following: |
| Line 19: | Line 19: |
| 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 23: |
| real URL is http://www.selenic.com/hg/ | |
| Line 27: | Line 28: |
| 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 33: |
| 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 check out the most recent [[ChangeSet|changeset]] on the default branch. The '`summary`' command 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) }}} Here {{{commit: (clean)}}} means that there no [[LocalModifications|local changes]], {{{update: (current)}}} means that the checked out files (in the working directory) are updated to the newest revision in the repository. |
| Line 36: | Line 50: |
| You'll want to start by creating a repository: | You'll want to start by creating a repository in the directory containing your project: |
| Line 43: | Line 57: |
| 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: |
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 58: | Line 71: |
| Test your .hgignore file with: |
Test your ''`.hgignore`'' file with '`status`': |
| Line 64: | Line 76: |
| 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 added, then commit: |
| Line 68: | Line 80: |
| $ 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 84: |
| == Clone, Commit, Merge == | To get help on commands, simply run: {{{ $ hg help }}} == Clone, commit, merge == |
| Line 79: | Line 98: |
| $ <make other changes> $ hg commit |
|
| Line 81: | Line 102: |
| $ hg parents # see the revisions that have been merged into the working directory | |
| Line 83: | Line 105: |
See also: [:Clone], [:Commit], [:Pull], [:Merge] |
|
| Line 94: | Line 114: |
| See also: [:Export] |
|
| Line 100: | Line 118: |
| foo$ hg clone http://selenic.com/hg/ foo$ cd hg |
$ hg clone http://selenic.com/hg/ $ cd hg |
| Line 103: | Line 121: |
| # 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 124: |
| # 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 127: |
| # 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 131: |
| See also: [:Serve], [:Push], [:Pull] | == See also == * [[BeginnersGuides|Beginner's guides]] * A basic [[Tutorial|tutorial]] * [[ManPages|Manual pages]] |
| Line 116: | Line 138: |
| '''translations:''' [:QuickStartDe:german] [:QuickStartPtBr:portuguese] | [[QuickStartDe|Deutsch]], [[FrenchQuickStart|Français]], [[BrazilianPortugueseQuickStart|Português]], [[ThaiQuickStart|ภาษาไทย]], [[ChineseQuickStart|中文]], [[JapaneseQuickStart|日本語]] |
Quick Start
An introduction for the impatient.
Contents
1. Setting a username
The first thing you should do is set the username Mercurial will use for commits. It's best to configure a proper email address in ~/.hgrc 1 (or on a Windows system in %USERPROFILE%\Mercurial.ini) by creating it and adding lines like 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 most recent changeset on the default branch.
The 'summary' command 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)
Here 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 in the directory containing your project:
$ 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 '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)
To get help on commands, simply run:
$ hg help
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
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 $ 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/
7. See also
A basic tutorial