[darcs-users] contributing to the darcs manual

Guillaume Hoffmann guillaumh at gmail.com
Sun Jun 30 11:17:39 UTC 2013


Hi Iva,

sorry for the late response!

The manual of darcs is going to change a lot for the next release (2.10).
The one that is available on-line corresponds to darcs 2.8, it is
generated from latex files that used to be in darcs' repository. As it
got more and more out of date (with respect to darcs itself and the
wiki) we decided to remove it.

Instead we added `darcs help markdown`, a command to generate a
reference manual of all commands, environment variables and patterns
of darcs, in the markdown format.  The code to generate it is in
src/Darcs/UI/Commands/Help.hs. We did this in the February sprint.

With this reference manual and some parts that we could directly edit
on the wiki (which is also in markdown), we could easily generate a
manual in various formats (html, pdf, ebook). The structure is not
clearly defined and this will most probably deserve a discussion on
darcs-users before 2.10.

So about the Emacs and Resolution piece of documentation, I think they
belongs to the wiki.

Guillaume


More information about the darcs-users mailing list