[PATCH 1 of 8 techdocs] help: add documentation for changegroup formats

Matt Harbison mharbison72 at gmail.com
Sun Dec 13 21:20:21 CST 2015


On Sun, 13 Dec 2015 14:46:54 -0500, Gregory Szorc  
<gregory.szorc at gmail.com> wrote:

> # HG changeset patch
> # User Gregory Szorc <gregory.szorc at gmail.com>
> # Date 1445728785 -3600
> #      Sun Oct 25 00:19:45 2015 +0100
> # Node ID d222327955686e4cbc7e1b3c6fe08d78691e3602
> # Parent  944af8e2eb4cddf96ba5b8a96854528b40979715
> help: add documentation for changegroup formats
>
> There is no formal location for spec-like technical/internal docs. The
> repository makes sense as such a location because spec-like
> documentation should be reviewed (ruling out a wiki). mpm has also
> stated that he would like this documentation to be part of the
> built-in help system. So, we establish an "internals" sub-directory
> to hold this class of documentation.
>
> The format of changegroups does not appear to be documented anywhere,
> even in source code. It therefore seemed like an appropriate first thing
> to document.
>
> This patch adds low-level documentation of versions 1 and 2 of the
> changegroup foromat. It currently only describes the raw data format.
> There is probably room to write higher-level documentation on strategies
> for producing and consuming the data. We'll leave that for another day.
>
> The added file is not yet accessible via `hg help` nor via hgweb.
> Support for this will follow in subsequent patches.
>
> diff --git a/mercurial/help/internals/changegroups.txt  
> b/mercurial/help/internals/changegroups.txt
> new file mode 100644
> --- /dev/null
> +++ b/mercurial/help/internals/changegroups.txt

I think this and #2 need a Wix update.  See  
https://selenic.com/pipermail/mercurial-devel/2015-December/076849.html



More information about the Mercurial-devel mailing list