Mercurial > hg
view doc/README @ 50417:d27b6fc7c1bf
rustdoc: summary line for hg_path_to_os_string
The main motivation of this change is to avoid the TODO being
the summary line, even though this leads to a pretty obvious summary.
Then doc-comments for the other functions are introduced for
consistency.
author | Georges Racinet <georges.racinet@octobus.net> |
---|---|
date | Mon, 03 Apr 2023 16:03:41 +0200 |
parents | 3516a4e877c1 |
children |
line wrap: on
line source
Mercurial's documentation is kept in reStructuredText format, which is a simple plain text format that's easy to read and edit: http://docutils.sourceforge.net/rst.html It's also convertible to a variety of other formats including standard UNIX man page format and HTML. You'll need to install Docutils: http://docutils.sourceforge.net/ Use the Makefile in this directory to generate the man and HTML pages.