|
Size: 2866
Comment: a clone is not a branch
|
Size: 4564
Comment: update links
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| (see also UnderstandingMercurial and ["Tutorial"]) | #pragma section-numbers 2 = Quick Start = An introduction for the impatient. <<TableOfContents>> |
| Line 5: | 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 Win system {{{%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(https://www.mercurial-scm.org/doc/hgrc.5.html)>> (or on a Windows system in ''`%USERPROFILE%\Mercurial.ini`'') by creating it and adding lines like the following: |
| Line 10: | Line 14: |
| username = Author Name <email@address> | username = John Doe <john@example.com> |
| Line 15: | 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 [[https://www.mercurial-scm.org/repo/hg]]), you can grab a copy like so: |
| Line 18: | Line 22: |
| $ hg clone http://selenic.com/hg | $ hg clone https://www.mercurial-scm.org/repo/hg mercurial-repo 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 |
| Line 21: | Line 32: |
| 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"]). | 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 25: | Line 49: |
| 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 32: | Line 56: |
| 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(https://www.mercurial-scm.org/doc/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 47: | Line 70: |
| Test your .hgignore file with: |
Test your ''`.hgignore`'' file with '`status`': |
| Line 53: | Line 75: |
| 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 57: | Line 79: |
| $ 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 60: | Line 83: |
| == Clone, Commit, Merge == | To get help on commands, simply run: {{{ $ hg help }}} == Clone, commit, merge == |
| Line 68: | Line 97: |
| $ <make other changes> $ hg commit |
|
| Line 70: | Line 101: |
| $ hg parents # see the revisions that have been merged into the working directory | |
| Line 72: | Line 104: |
See also: ["Clone"], ["Commit"], ["Merge"] |
|
| Line 80: | Line 110: |
| $ hg export tip # export the most recent commit | $ hg export tip # display the full details of the most recent commit |
| Line 87: | Line 117: |
| foo$ hg clone http://selenic.com/hg/ foo$ cd hg |
$ hg clone https://www.mercurial-scm.org/repo/hg $ cd hg |
| Line 90: | Line 120: |
| # 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 https://www.mercurial-scm.org/repo/hg |
| Line 93: | Line 123: |
| # 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 96: | Line 126: |
| # 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 99: | Line 129: |
== See also == * [[BeginnersGuides|Beginner's guides]] * A basic [[Tutorial|tutorial]] * [[ManPages|Manual pages]] |
|
| Line 100: | Line 137: |
| '''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 https://www.mercurial-scm.org/repo/hg), you can grab a copy like so:
$ hg clone https://www.mercurial-scm.org/repo/hg mercurial-repo 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 # display the full details of the most recent commit
6. Network support
# clone from the primary Mercurial repo $ hg clone https://www.mercurial-scm.org/repo/hg $ cd hg # pull new changesets from an existing other repo into the repository (.hg) $ hg pull https://www.mercurial-scm.org/repo/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