Since a few years we wanted to get rid of the latex+latex2html manual.
Now that all chapters of it have an equivalent in the wiki in one form
or another (getting started, features, best practices,...) and that
we switched the website to being the wiki, the only remaining piece of
documentation missing from the wiki was a command reference. This is
the point of this bundle:
* introduce `darcs help markdown` similar to `darcs help manpage`,
which moreover lists the flags of each command like the latex manual,
all of this in the markdown format. The only so-so part are the
tables for the flags that are generated using html tags. This
is perfectly acceptable with markdown, but it makes the output of
`darcs help markdown` less human-readable. Maybe someone will
improve that later.
* slightly modify the help strings of the darcs commands so that
they are in markdown. The main changes are things like `foo' that
had to be converted to `foo`, and sometimes to \"foo\" or *foo*
when the semantics required it.
* port some paragraphs from the latex manual into the help strings
of certain commands.
* remove the ./doc/ directory from the repository (that is the website
and the latex manual).
I suggest that after each stable release we redirect `darcs help markdown`
into http://{www,wiki}.darcs.net/Commands.
We will most probably have to extend `darcs help markdown` with help about
environment variables and matcher flags (present in `darcs help manpage`).
However before that it may be time to think about extracting the matcher
flags help from Darcs.Patch.* into Darcs.UI.* ?
9 patches for repository http://darcs.net:
Fri Jul 6 22:50:39 ART 2012 Guillaume Hoffmann <guillaumh@gmail.com>
* introduce darcs help markdown, convert help messages to markdown
Sat Jul 7 13:39:25 ART 2012 Guillaume Hoffmann <guillaumh@gmail.com>
* extend push command help with data from manual
Sat Jul 7 13:46:02 ART 2012 Guillaume Hoffmann <guillaumh@gmail.com>
* copy --creator-hash flag help from manual to annotate command help
Sat Jul 7 13:46:24 ART 2012 Guillaume Hoffmann <guillaumh@gmail.com>
* extend apply command help with data from manual
Sat Jul 7 13:46:33 ART 2012 Guillaume Hoffmann <guillaumh@gmail.com>
* extend pull command help with data from manual
Sat Jul 7 13:46:54 ART 2012 Guillaume Hoffmann <guillaumh@gmail.com>
* complete send command help with data from manual
Sat Jul 7 18:59:15 ART 2012 Guillaume Hoffmann <guillaumh@gmail.com>
* extend record command help with data from manual
Sat Jul 7 19:15:02 ART 2012 Guillaume Hoffmann <guillaumh@gmail.com>
* document command flags in darcs help markdown
Thu Jul 5 17:57:12 ART 2012 Guillaume Hoffmann <guillaumh@gmail.com>
* remove website and manual
Attachments
|
