view tests/test-debugextensions.t @ 27372:a79cba6cb206

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.

  $ hg debugextensions

  $ debugpath=`pwd`/extwithoutinfos.py

  $ cat > extwithoutinfos.py <<EOF
  > EOF

  $ cat >> $HGRCPATH <<EOF
  > [extensions]
  > color=
  > histedit=
  > patchbomb=
  > rebase=
  > mq=
  > ext1 = $debugpath
  > EOF

  $ hg debugextensions
  color
  ext1 (untested!)
  histedit
  mq
  patchbomb
  rebase

  $ hg debugextensions -v
  color
    location: */hgext/color.pyc (glob)
    tested with: internal
  ext1
    location: */extwithoutinfos.pyc (glob)
  histedit
    location: */hgext/histedit.pyc (glob)
    tested with: internal
  mq
    location: */hgext/mq.pyc (glob)
    tested with: internal
  patchbomb
    location: */hgext/patchbomb.pyc (glob)
    tested with: internal
  rebase
    location: */hgext/rebase.pyc (glob)
    tested with: internal

  $ hg debugextensions -Tjson | sed 's|\\\\|/|g'
  [
   {
    "buglink": "",
    "name": "color",
    "source": "*/hgext/color.pyc", (glob)
    "testedwith": "internal"
   },
   {
    "buglink": "",
    "name": "ext1",
    "source": "*/extwithoutinfos.pyc", (glob)
    "testedwith": ""
   },
   {
    "buglink": "",
    "name": "histedit",
    "source": "*/hgext/histedit.pyc", (glob)
    "testedwith": "internal"
   },
   {
    "buglink": "",
    "name": "mq",
    "source": "*/hgext/mq.pyc", (glob)
    "testedwith": "internal"
   },
   {
    "buglink": "",
    "name": "patchbomb",
    "source": "*/hgext/patchbomb.pyc", (glob)
    "testedwith": "internal"
   },
   {
    "buglink": "",
    "name": "rebase",
    "source": "*/hgext/rebase.pyc", (glob)
    "testedwith": "internal"
   }
  ]