Differences between revisions 28 and 38 (spanning 10 versions)
Revision 28 as of 2009-07-04 21:23:45
Size: 4391
Editor: abuehl
Comment: +[[subrepos]]
Revision 38 as of 2013-03-25 18:30:23
Size: 4662
Editor: 208
Comment: Fixed typo
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#pragma section-numbers 3
== Repository ==
#pragma section-numbers 2
Line 4: Line 3:
= Repository =
Line 13: Line 13:
Local Mercurial repositories are adressed by specifying the path to the repository root (global option `-R` for commands). Local Mercurial repositories are addressed by specifying the path to the repository root (global option `-R` for commands).
Line 20: Line 20:
=== Creation === == Creation ==
Line 22: Line 22:
Repositories can be [[Clone|cloned]] with {{{hg clone}}}, which creates a copy of an existing repository. Repositories can be [[Cmd:clone|cloned]] with {{{hg clone}}}, which creates a copy of an existing repository. If possible,
Mercurial uses hardlinks to save space and speedup the cloning (see HardlinkedClones).
Line 27: Line 28:
=== Tracking Files === == Tracking files ==
Line 29: Line 30:
A file in the working directory that shall be tracked by Mercurial must be added with {{{hg add}}}. [[LocalModifications|Local modifications]] to tracked files in the working directory can be [[Commit|committed]] with {{{hg commit}}}, which adds a new [[ChangeSet|changeset]] to the repository by recording it in the {{{.hg}}} directory. A file in the working directory that shall be tracked by Mercurial must be added with {{{hg add}}}. [[LocalModifications|Local modifications]] to tracked files in the working directory can be [[Cmd:commit|committed]] with {{{hg commit}}}, which adds a new [[ChangeSet|changeset]] to the repository by recording it in the {{{.hg}}} directory.
Line 31: Line 32:
The working directory can be restored with {{{hg update}}} to any previously committed state by specifying the requested changeset with its [[ChangeSetID|changeset ID]] (see [[Update]]). Use {{{hg parents}}} to see the currently checked
out revision (see [[Parent]]).
The working directory can be restored with {{{hg update}}} to any previously committed state by specifying the requested changeset with its [[ChangeSetID|changeset ID]] (see [[Cmd:update|update]]). Use {{{hg parents}}} to see the currently checked
out revision (see [[Cmd:parents|parents]]).
Line 34: Line 35:
The last commit in a repository can be undone with {{{hg rollback}}} (see [[Rollback]]). The last commit in a repository can be undone with {{{hg rollback}}} (see [[Cmd:rollback|rollback]]).
Line 37: Line 38:
=== Transferring Changesets === == Transferring changesets ==
Line 39: Line 40:
Changesets can be transferred from one repository to another with {{{hg pull}}}, {{{hg push}}}, {{{hg export}}} and {{{hg import}}} (see [[Pull]], [[Push]], [[Export]], [[Import]], [[CommunicatingChanges]]). Changesets can be transferred from one repository to another with {{{hg pull}}}, {{{hg push}}}, {{{hg export}}} and {{{hg import}}} (see [[Cmd:pull]], [[Cmd:push]], [[Cmd:export]], [[Cmd:import]], [[CommunicatingChanges]]).
Line 42: Line 43:
=== Checking Integrity === == Checking integrity ==
Line 47: Line 48:
=== Structure === == Structure ==
Line 53: Line 54:
 * The [[Changelog|changelog]] — Files {{{.hg/store/00changelog.i}}} and {{{.hg/store/00changelog.d}}}  * The changelog — Files {{{.hg/store/00changelog.i}}} and {{{.hg/store/00changelog.d}}}
Line 59: Line 60:
 * The [[RequiresFile|requires file]] — File {{{.hg/requires}}}
    Specifies the capabilities needed by a client to access this repository
Line 63: Line 66:
=== Backup === == Backup ==
Line 68: Line 71:
=== See also === == See also ==
Line 70: Line 73:
 * [[ManPages]] | [[RepositoryNaming]] | [[PublishingRepositories]] | [[RepositoryConversion]]
 * [[RepositoryCorruption]] | [[DeveloperRepos]] | [[RepoSamples]] | [[SharedRepository]] | [[subrepos]]
 * [[RepositoryNaming]]
* [[PublishingRepositories]]
* [[SharedRepository]]
 * [[Subrep
ository]]
 * [[RepositoryCorruption]]
* [[UpgradingMercurial]]
Line 75: Line 82:

[[FrenchRepository|Français]]

Repository

(for a short intro of the basic concepts of Mercurial, see UnderstandingMercurial)

Strictly speaking, the term repository refers to the directory named .hg (dot hg) in the repository root directory. The repository root directory is the parent directory of the .hg directory. Mercurial stores its internal data structures – the metadata – inside that .hg directory.

All of the files and directories that coexist with the .hg directory in the repository root are said to live in the working directory.

An easy way to remember the distinction is that the repository contains the history of your project, while the working directory contains a snapshot of your project at a particular point in history.

Local Mercurial repositories are addressed by specifying the path to the repository root (global option -R for commands).

Sometimes Mercurial users and developers also use the term "repository" when referring to the repository root. But strictly speaking, the .hg directory is the "real" repository.

1. Creation

Repositories can be cloned with hg clone, which creates a copy of an existing repository. If possible, Mercurial uses hardlinks to save space and speedup the cloning (see HardlinkedClones).

An existing, already populated but yet untracked directory can be transformed into a repository with hg init, which creates and initializes the .hg subdirectory.

2. Tracking files

A file in the working directory that shall be tracked by Mercurial must be added with hg add. Local modifications to tracked files in the working directory can be committed with hg commit, which adds a new changeset to the repository by recording it in the .hg directory.

The working directory can be restored with hg update to any previously committed state by specifying the requested changeset with its changeset ID (see update). Use hg parents to see the currently checked out revision (see parents).

The last commit in a repository can be undone with hg rollback (see rollback).

3. Transferring changesets

Changesets can be transferred from one repository to another with hg pull, hg push, hg export and hg import (see pull, push, export, import, CommunicatingChanges).

4. Checking integrity

Checking the internal integrity of a repository (the contents of .hg) can be done with hg verify.

5. Structure

The .hg directory of a repository contains (incomplete listing):

  • The manifest — Files .hg/store/00manifest.i and .hg/store/00manifest.d

    • Describes the file contents of the repository at a particular changeset ID. Stored in revlog format.

  • The changelog — Files .hg/store/00changelog.i and .hg/store/00changelog.d

    • Contains all changesets. Stored in revlog format.
  • A revlog per tracked file — Files .hg/store/data/<encoded path>.i and .hg/store/data/<encoded path>.d

    • <encoded path> is the path of the tracked file in the working directory, encoded according to CaseFoldingPlan.

  • The dirstate — File .hg/dirstate

    • Tracks various information about the working directory.
  • The requires file — File .hg/requires

    • Specifies the capabilities needed by a client to access this repository

Note that for small revlogs, the revlog data file (*.d) may be missing, because its content may be interleaved into the corresponding index file (*.i) (see also RevlogNG).

6. Backup

Backing up a repository can be done by using push/pull/clone to a backup repository. A repository which is not actively written to (by other processes concurrently running on the computer) can be backed-up by backing-up the repo directory using normal directory/file backup procedures (like tar, zip, etc). The .hg directory is case folding tolerant, which means, it can for example be copied onto a FAT filesystem (see also BackUp, CaseFoldingPlan).

7. See also


CategoryGlossary

Français

Repository (last edited 2013-03-25 18:30:23 by 208)