Mercurial > hg
annotate doc/README @ 39282:828a45233036
debugcommands: introduce debugrevlogindex (BC)
`hg debugindex` was originally invented for displaying revlog index
data and is highly tailored towards that. e.g. it accepts a --format
option to display index data for a particular revlog version and
displays things like offset and length.
As we support non-revlog storage, it makes sense for `hg debugindex`
to display generic index data and for there to exist storage-specific
or storage-aware debug* commands for dumping non-generic index data.
This commit effectively renames `hg debugindex` to
`hg debugrevlogindex` and replaces `hg debugindex` with a version that
is storage agnostic.
Tests using --format have been updated to use `hg debugrevlogindex`.
Output is backwards compatible. The replacement command uses the
formatter, which means output can be templatized.
At some point, we may want to tweak output (e.g. to add the revision
size). But I don't feel like taking a bigger BC break at the moment.
The renamed command/function had to be moved because check-code
enforces alphabetical ordering of commands in this file.
Differential Revision: https://phab.mercurial-scm.org/D4358
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Tue, 21 Aug 2018 00:01:54 +0000 |
parents | 3516a4e877c1 |
children |
rev | line source |
---|---|
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
1 Mercurial's documentation is kept in reStructuredText format, which is |
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
2 a simple plain text format that's easy to read and edit: |
177 | 3 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
4 http://docutils.sourceforge.net/rst.html |
177 | 5 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
6 It's also convertible to a variety of other formats including standard |
9419
3516a4e877c1
doc/README: simplify instructions
Martin Geisler <mg@lazybytes.net>
parents:
9406
diff
changeset
|
7 UNIX man page format and HTML. You'll need to install Docutils: |
177 | 8 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
9 http://docutils.sourceforge.net/ |
177 | 10 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
11 Use the Makefile in this directory to generate the man and HTML pages. |