docs: add new user guide
This has also been reviewed to death on evolve-testers. There are
still a couple of short sections to write (clearly marked "TODO"), and
one example to add. But (if I may be so bold) this is a gigantic
improvement over the current docs, so it really should get merged.
Incidentally, the figures are all SVG files created with Inkscape.
They're not perfect, but they're pretty nice. Anyone who knows a
better way to create technical diagrams is welcome to contribute.
One wart: there's a test script that accompanies the document and
largely duplicates it, but I haven't unified them. I've been
concentrating on writing the best possible content, not on fiddling
with tools. I suspect that unifying them will be non-trivial, but
definitely worth doing.
$ cat >> $HGRCPATH <<EOF
> [web]
> push_ssl = false
> allow_push = *
> [phases]
> publish=False
> [alias]
> odiff=diff --rev 'limit(obsparents(.),1)' --rev .
> [extensions]
> hgext.graphlog=
> EOF
$ mkcommit() {
> echo "$1" > "$1"
> hg add "$1"
> hg ci -m "add $1"
> }
create commit
$ hg init repo
$ cd repo
$ mkcommit a
$ mkcommit b
$ hg up -q 0
$ mkcommit c
created new head
forge old style relation files
$ hg log -r 2 --template='{node} ' > .hg/obsolete-relations
$ hg log -r 1 --template='{node}' >> .hg/obsolete-relations
enable the extensions
$ echo "obsolete=$(echo $(dirname $TESTDIR))/hgext/obsolete.py" >> $HGRCPATH
$ hg glog
abort: old format of obsolete marker detected!
run `hg debugconvertobsolete` once.
[255]
$ hg debugconvertobsolete --traceback
1 obsolete marker converted
$ hg glog
@ changeset: 2:d67cd0334eee
| tag: tip
| parent: 0:1f0dee641bb7
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: add c
|
o changeset: 0:1f0dee641bb7
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: add a
$ hg debugobsolete
7c3bad9141dcb46ff89abf5f61856facd56e476c d67cd0334eeecfded222fed9009f0db4beb57585 0 {'date': '* *', 'user': 'test'} (glob)
$ hg debugconvertobsolete
nothing to do
0 obsolete marker converted
Convert json
$ cat > .hg/store/obsoletemarkers << EOF
> [
> {
> "reason": "import from older format.",
> "subjects": [
> "3218406b50ed13480765e7c260669620f37fba6e"
> ],
> "user": "Pierre-Yves David <pierre-yves.david@ens-lyon.org>",
> "date": [
> 1336503323.9768269,
> -7200
> ],
> "object": "3e03d82708d4da97a92158558dd13386d8f09ad5",
> "id": "4743f676eaf3923cb98c921ee06b2e91052c365b"
> },
> {
> "reason": "import from older format.",
> "user": "Pierre-Yves David <pierre-yves.david@logilab.fr>",
> "date": [
> 1336557472.7875929,
> -7200
> ],
> "object": "5c722672795c3a2cb94d0cc9a821c394c1475f87",
> "id": "1fd90a84b7225d2e3062b7e1b3100aa2e060fc72"
> },
> {
> "reason": "import from older format.",
> "subjects": [
> "0000000000000000000000000000000000000000"
> ],
> "user": "Pierre-Yves David <pierre-yves.david@logilab.fr>",
> "date": [
> 1336557472.784307,
> -7200
> ],
> "object": "2c3784e102bb34ccc93862af5bd6d609ee30c577",
> "id": "7d940c5ee1f886c8a6c0d805b43e522cb3ef7a15"
> }
> ]
> EOF
$ hg glog
abort: old format of obsolete marker detected!
run `hg debugconvertobsolete` once.
[255]
$ hg debugconvertobsolete --traceback
3 obsolete marker converted
$ hg debugobsolete
7c3bad9141dcb46ff89abf5f61856facd56e476c d67cd0334eeecfded222fed9009f0db4beb57585 0 {'date': '* *', 'user': 'test'} (glob)
3e03d82708d4da97a92158558dd13386d8f09ad5 3218406b50ed13480765e7c260669620f37fba6e 0 {'date': '* *', 'user': 'Pierre-Yves David <pierre-yves.david@ens-lyon.org>'} (glob)
5c722672795c3a2cb94d0cc9a821c394c1475f87 0 {'date': '* *', 'user': 'Pierre-Yves David <pierre-yves.david@logilab.fr>'} (glob)
2c3784e102bb34ccc93862af5bd6d609ee30c577 0 {'date': '* *', 'user': 'Pierre-Yves David <pierre-yves.david@logilab.fr>'} (glob)