Mercurial

Hg: the chemical symbol for mercury, from the Greek hydrargyrum.

mercurial: relating to or having characteristics (eloquence, shrewdness, swiftness, thievishness) attributed to the god Mercury.

Mercurial: a fast, lightweight Source Control Management system designed for efficient handling of very large distributed projects.

This is a wiki for the Mercurial ["DistributedSCM"] tool.

Please contribute!

Contributions are most welcome, but please create a user name for yourself before you edit anything (we were hit by too many spammers and kiddies when this wiki was anonymously editable). To do this, click on the "Login" link up in the top right corner of this page and follow the instructions from there. Mercurial itself and all wiki content are available under the [http://www.gnu.org/copyleft/gpl.html GNU GPL].

New to all this stuff?

• Check out the MajorFeatures

• See WhatsNew and read the UpgradeNotes

• ["Download"] the latest source or check for Download BinaryPackages for your system

• UnixInstall describes how to install Mercurial under Linux, MacOS X, and Unix variants

• WindowsInstall describes how to install Mercurial under Windows

Mercurial user survey

BryanOSullivan has published the results of the first Mercurial UserSurvey.

Using Mercurial

• A QuickStart for the impatient

• A QuickStart2 for graduates of the above - read before your first commit!

• ["Tutorial"] for new users (["FrenchTutorial"], ["SpanishTutorial"] , ["JapaneseTutorial"] and ["ChineseTutorial"] available)

• [:FAQ:Frequently Asked Questions] - FAQ

• TipsAndTricks

• [http://www.selenic.com/mercurial/hg.1.html hg(1)], [".hgignore"] and [http://www.selenic.com/mercurial/hgrc.5.html hgrc(5)] manpages and ["TranslatedManPages"]

• XemacsAndEmacsUsers - Here is a .hgignore that users of XEmacs and Emacs will love

• WorkingPractices describing several somewhat sane ways to use Mercurial

• How to handle MultipleCommitters

• CommunicatingChanges describes the various ways Mercurial can exchange changesets

• PublishingRepositories and ServerInstall describes various ways to make your code visible to the world

• NamedBranches gives an introduction to this recent feature

For refugees from CVS and other systems

• CvsConcepts - translations of ["CVS"] concepts into Mercurial terms

• CvsCommands - equivalents of commands provided by ["CVS"]

• ConvertingRepositories from other ["SCM"] formats to Mercurial

• ["Glossary"] of terms (useful if you're not used to distributed source management)
• A ["Tag"] is slightly different in Mercurial than in other ["SCM"] systems
• hg and other SCM commands comparison
  • In hg book, 5.1 example from putting file "a" under source code control.

  Actions	hg	RCS
  init	hg init add-example	mkdir add-example;cd add-example;mkdir RCS
  add file "a"	hg add a	ci -u a
  commit file "a"	hg commit -m 'Added one file'	ci -u a
  check out file "a"	???	co -l a
  find out the status	hg status a ???	rlog a
  stop file "a" tacking	hg remove a	rm RCS/a,v

Extensions

• UsingHgk - how to use the GUI repository browser

• MqExtension - Mercurial Patch Queues

• UsingBisect - how to use the bisect extension to find bugs

• TransplantExtension - cherry-picks patches and rebases branches

• ExtensionHowto - how to write Mercurial extensions

  See CategoryExtension for a more complete list.

Information for contributors

• Tips for ContributingChanges

• The ToDo list and MissingFeatures

• ["Design"] - Mercurial's data structures and how it uses them.

• WhatGoesWhere - the project architecture

• WireProtocol - the push/pull changegroup protocol

• OptionNaming - the conventions used to name command-line options

• DebuggingFeatures - how to poke around in Mercurial's internals

• ["Theming"] - how to create new styles for Mercurial's web interface

• WritingTests - how to add tests to the test suite

• DeveloperRepos - where to find various public repositories of Mercurial work

• The RoadMap and the InternationalizationPlan

• NewFeatureDiscussions - A page of links to discussions about new features.

• NewIdeas - Suggestions for features/extensions that would make someone happy

Further information

• MailingLists:

  • general list:

    [http://www.selenic.com/mailman/listinfo/mercurial/ subscriptions], [http://www.selenic.com/pipermail/mercurial/ archives], and [http://marc.theaimsgroup.com/?l=mercurial&w=2 archive search] developers list:

    [http://www.selenic.com/mailman/listinfo/mercurial-devel/ subscriptions], [http://www.selenic.com/pipermail/mercurial-devel/ archives]

• [http://selenic.com/mercurial/bugs/ Mercurial bug tracker]

• IRC channel: #mercurial on irc.freenode.net

• OtherTools that work with Mercurial

• A list of ["ProjectsUsingMercurial"] and links to their repositories.

• A list of ["Presentations"] and other related events.

• Ideas for Google's SummerOfCode2006.