|
Size: 2694
Comment:
|
Size: 3942
Comment: Link to French translation added
|
| 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 = ''(see also [[UnderstandingMercurial]] and [[Tutorial]] and [[QuickStart2]])'' <<TableOfContents>> |
| Line 5: | Line 9: |
| 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: |
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: |
| 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 (eg: 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 18: | Line 22: |
| $ hg clone http://selenic.com/hg | $ 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 6908 changesets with 13429 changes to 976 files updating working directory 861 files updated, 0 files merged, 0 files removed, 0 files unresolved |
| Line 21: | Line 33: |
| This will create a new directory called hg (by default), grab the complete project history, and check out the tipmost changeset. | 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]]). See which revision was checked out: {{{ $ cd mercurial-repo $ hg parents changeset: 6907:6dcbe191a9b5 tag: tip user: Matt Mackall <mpm@selenic.com> date: Mon Aug 18 16:50:36 2008 -0500 summary: Fix up tests }}} |
| Line 25: | Line 49: |
| You'll want to start by creating an hg repository: | You'll want to start by creating a repository: |
| Line 32: | Line 56: |
| 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. Here's an example .hgignore file: |
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: |
| Line 54: | Line 77: |
| This will list all files that are not ignored with a 'U' flag (unknown). 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: | 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 59: | Line 82: |
| $ hg parents # see the currently checked out revision | |
| Line 61: | Line 85: |
| == Branching and merging == | == Clone, Commit, Merge == |
| Line 64: | Line 88: |
| $ hg clone project project-work # create a new branch | $ hg clone project project-work # clone repository |
| Line 69: | Line 93: |
| $ <make other changes> $ hg commit |
|
| Line 71: | Line 97: |
| $ hg parents # see the revisions that have been merged into the working directory | |
| Line 73: | Line 100: |
See also: [[Clone]], [[Commit]], [[Pull]], [[Merge]], [[Parent]] |
|
| Line 82: | Line 111: |
| See also: [[Export]] |
|
| Line 86: | Line 117: |
| foo$ hg clone http://selenic.com/hg/ foo$ cd hg |
$ hg clone http://selenic.com/hg/ $ cd hg |
| Line 90: | Line 121: |
| foo$ hg pull http://selenic.com/hg/ | $ hg pull http://selenic.com/hg/ |
| Line 92: | 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 127: |
| foo$ hg push ssh://user@example.com/hg/ | $ hg push ssh://user@example.com/hg/ |
| Line 98: | Line 129: |
See also: [[Serve]], [[Push]], [[Pull]] |
|
| Line 99: | Line 133: |
| '''translations:''' [:QuickStartDe:german] | '''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 (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 6908 changesets with 13429 changes to 976 files updating working directory 861 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 (see also Clone).
See which revision was checked out:
$ cd mercurial-repo $ hg parents changeset: 6907:6dcbe191a9b5 tag: tip user: Matt Mackall <mpm@selenic.com> date: Mon Aug 18 16:50:36 2008 -0500 summary: Fix up tests
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:
$ hg add # add those 'unknown' files $ hg commit # commit all changes, edit changelog entry $ hg parents # see the currently checked out revision
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 # update an existing repo $ hg pull http://selenic.com/hg/ # 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