|
Size: 1839
Comment:
|
Size: 3843
Comment: Added a link to Japanese translation
|
| 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}}} (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 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 [: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 }}} == Setting up a new Mercurial project == You'll want to start by creating a repository: |
| Line 5: | Line 53: |
| $ 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 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. == Branching and merging == |
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 17: | Line 60: |
| $ 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: {{{ $ 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:commit]: {{{ $ hg add # add those 'unknown' files $ hg commit # commit all changes, edit changelog entry $ hg parents # see the currently checked out revision }}} == Clone, Commit, Merge == {{{ $ hg clone project project-work # clone repository $ cd project-work |
| Line 21: | Line 92: |
| $ 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 101: |
| == Importing patches == | See also: [:Clone], [:Commit], [:Pull], [:Merge], [:Parent] |
| Line 30: | Line 103: |
| 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 108: |
| $ hg tip 28237:747a537bd090880c29eae861df4d81b245aa0190 $ hg export 28237 > foo.patch # export changeset 28237 |
$ hg export tip # export the most recent commit |
| Line 58: | Line 111: |
| Network support: | See also: [:Export] == Network support == |
| Line 61: | Line 116: |
| # pull from the primary Mercurial repo | # clone from the primary Mercurial repo |
| Line 64: | Line 119: |
# update an existing repo foo$ hg pull http://selenic.com/hg/ |
|
| Line 68: | Line 126: |
| # pushing changes to a remote repo with SSH foo$ hg push ssh://user@example.com/~/hg/ |
# push changes to a remote repo with SSH foo$ hg push ssh://user@example.com/hg/ }}} |
| Line 71: | Line 130: |
| # merge changes from a remote machine bar$ hg pull http://foo/ bar$ hg update -m # merge changes into your working directory |
See also: [:Serve], [:Push], [:Pull] |
| Line 75: | Line 132: |
| # 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 }}} |
---- '''translations:''' [:QuickStartDe:German] [:QuickStartPtBr:Portuguese] [:JapaneseQuickStart:Japanese] |
Quick Start
(see also [:UnderstandingMercurial] and [:Tutorial] and [:QuickStart2])
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: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 [: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
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: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 foo$ hg clone http://selenic.com/hg/ foo$ cd hg # update an existing repo foo$ hg pull http://selenic.com/hg/ # export your current repo via HTTP with browsable interface foo$ hg serve -n "My repo" -p 80 # push changes to a remote repo with SSH foo$ hg push ssh://user@example.com/hg/
See also: [:Serve], [:Push], [:Pull]
translations: [:QuickStartDe:German] [:QuickStartPtBr:Portuguese] [:JapaneseQuickStart:Japanese]