Differences between revisions 65 and 66
Revision 65 as of 2009-11-03 00:25:56
Size: 5978
Editor: abuehl
Comment: add link to the new official quickstart webpage (for completeness sake)
Revision 66 as of 2009-11-03 17:41:35
Size: 165
Editor: abuehl
Comment: no longer maintained, link to successor in official Mercurial website instead
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#pragma section-numbers 2

= Quick Start =
''(see also [[UnderstandingMercurial]], [[Tutorial]], [[QuickStart2]] and http://mercurial.selenic.com/quickstart/)''

<<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}}} <<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:

{{{
[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 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 [[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.

== Setting up a new Mercurial project ==

You'll want to start by creating a repository (see [[http://www.selenic.com/mercurial/hg.1.html#init|init]]):

{{{
$ cd project/
$ hg init # creates .hg
}}}

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:

{{{
syntax: glob
*.orig
*.rej
*~
*.o
tests/*.err

syntax: regexp
.*\#.*\#$
}}}

Test your .hgignore file with (see [[http://www.selenic.com/mercurial/hg.1.html#status|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 [[http://www.selenic.com/mercurial/hg.1.html#add|add]]ed, then [[http://www.selenic.com/mercurial/hg.1.html#commit|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
}}}

== 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 [[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]]

== Exporting a patch ==

{{{
(make changes)
$ hg commit
$ hg export tip # export the most recent commit
}}}

See [[http://www.selenic.com/mercurial/hg.1.html#export|export]]

== 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/
}}}

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]]

----
'''translations:''' [[ChineseQuickStart|Chinese]] [[FrenchQuickStart|Français]] [[QuickStartDe|German]] [[QuickStartPtBr|Portuguese]] [[JapaneseQuickStart|Japanese]] [[ThaiQuickStart|Thai]]
This wiki page is no longer maintained and has been superseded by the respective page in the official Mercurial website at http://mercurial.selenic.com/quickstart/

This wiki page is no longer maintained and has been superseded by the respective page in the official Mercurial website at http://mercurial.selenic.com/quickstart/

QuickStart (last edited 2019-06-07 09:36:00 by aayjaychan)