Diff for "ForestExtension"

Differences between revisions 1 and 9 (spanning 8 versions)

Forest Extension

This extension is not being distributed along with Mercurial.

Author: Robin FarineBR Maintainer: Simon Law <simon@akoha.org>

Download site: [http://www.terminus.org/hg/hgforest public development repository].

Note: As of 9/3/2007, the version at this repository does not work with Mercurial 0.9.4. Simon is presently consolidating updates, and hopes to have a new version for packaging shortly. — shap

Overview

The Forest extension allows operations on trees with nested Mercurial repositories, called forests.

It provides some additional commands that apply to the forest. These commands are both standard Mercurial commands, such as 'clone' or 'status', that are applied recursively, and commands that involve a snapshot file, to represent the state of a forest at a given time.

The new commands defined by the extension are: fclone, fpull, fpush, fseed, fsnap, ftrees and fupdate

Configuration

Configure your .hgrc to enable the extension by adding following lines:

[extensions]
hgext.forest=
# or, if forest.py is not in the hgext dir:
# forest=/path/to/forest.py

Some additional configuration can be done using the '[forest]' stanza in your configuration file:

[forest]
# will nested repositories directly under a .hg directory be skipped (0|no|false) or not (1|yes|true)?.
# The default value is 0. (don't skip them)
walkhg = (0|no|false|1|yes|true)

Usage

To clone a forest:

hg fclone [OPTIONS] SOURCE DESTINATION

To pull/push/update all repos in the forest:

hg fpull [OPTIONS] SNAPSHOT-FILE PATH-ALIAS

hg fpush [OPTIONS] SNAPSHOT-FILE PATH-ALIAS

hg fupdate [OPTIONS] (--tip | SNAPSHOT-FILE)

To take a snapshot of a forest:

hg fsnap [OPTIONS] [SNAPSHOT-FILE]

To populate a forest according to a snapshot file:

hg fseed [OPTIONS] SNAPSHOT-FILE [PATH-ALIAS]

To display the status of the forest:

hg fstatus [OPTIONS]

To list the roots of repositories:

hg ftrees [OPTIONS]

CategoryExtension

-  ⇤ ← Revision 1 as of 2007-01-17 16:28:25 → 
  Size: 511
  Editor: RafaelVillarBurke
  Comment: Forest extension initial page
+   ← Revision 9 as of 2007-09-03 17:57:47 → ⇥
  Size: 2182
  Editor: dsl092-046-242
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 3:
+'''This extension is not being distributed along with Mercurial.'''

''Author: Robin Farine''[[BR]]
''Maintainer: Simon Law <simon@akoha.org>''

Download site: [http://www.terminus.org/hg/hgforest public development repository].

'''Note:''' As of 9/3/2007, the version at this repository does not work with Mercurial 0.9.4. Simon is presently consolidating updates, and hopes to have a new version for packaging shortly. &mdash; shap

=== Overview ===
-Line 4:
+Line 15:
-It provides commands that apply to the forest. These commands are both standard Mercurial commands, such as 'clone' or 'status', and commands that involve a snapshot file, to represent the state of a forest at a given time.
-Line 6:
+Line 16:
-The forest extension is being developed by Robin Farine and can be downloaded from its [http://www.terminus.org/hg/hgforest public development repository].
+It provides some additional commands that apply to the forest. These commands are both standard Mercurial commands, such as 'clone' or 'status', that are applied recursively, and commands that involve a snapshot file, to represent the state of a forest at a given time.

The new commands defined by the extension are: {{{fclone}}}, {{{fpull}}}, {{{fpush}}}, {{{fseed}}},  {{{fsnap}}}, {{{ftrees}}} and {{{fupdate}}}

=== Configuration ===
Configure your .hgrc to enable the extension by adding following lines:

{{{
[extensions]
hgext.forest=
# or, if forest.py is not in the hgext dir:
# forest=/path/to/forest.py
}}}

Some additional configuration can be done using the '[forest]' stanza in your configuration file:

{{{
[forest]
# will nested repositories directly under a .hg directory be skipped (0|no|false) or not (1|yes|true)?.
# The default value is 0. (don't skip them)
walkhg = (0|no|false|1|yes|true)
}}}


=== Usage ===

To clone a forest:

{{{hg fclone [OPTIONS] SOURCE DESTINATION}}}

To pull/push/update all repos in the forest:

{{{hg fpull [OPTIONS] SNAPSHOT-FILE PATH-ALIAS}}}

{{{hg fpush [OPTIONS] SNAPSHOT-FILE PATH-ALIAS}}}

{{{hg fupdate [OPTIONS] (--tip | SNAPSHOT-FILE)}}}

To take a snapshot of a forest:

{{{hg fsnap [OPTIONS] [SNAPSHOT-FILE]}}}

To populate a forest according to a snapshot file:

{{{hg fseed [OPTIONS] SNAPSHOT-FILE [PATH-ALIAS]}}}

To display the status of the forest:

{{{hg fstatus [OPTIONS]}}}

To list the roots of repositories:

{{{hg ftrees [OPTIONS]}}}

----
CategoryExtension