##// END OF EJS Templates
upstream » mercurial-mirror
RSS

Clone from https://www.mercurial-scm.org/repo/hg-all

doc: show short description of each commands in generated documents...
doc: show short description of each commands in generated documents Before this patch, short description of each commands is not shown in generated documents (HTML file and UNIX man page). This omitting may prevent users from understanding about commands. This patch show it as the 1st paragraph in the help section of each commands. This style is chosen because: - showing it as the section title in "command - short desc" style disallows referencing by "#command" in HTML file: in "en" locale, hyphen concatenated title is used as the section ID in HTML file for this style - showing it as the 1st paragraph in "command - short desc" style seems to be redundant: "command" appears also just before as the section title - showing it just after synopsis like "hg help command" seems not to be reasonable in UNIX man page This patch just writes short description ("d['desc'][0]") before "::", because it should be already "strip()"-ed in "get_desc()", or empty string for the command without description.
Martin Geisler - - Load All Authors

File last commit:

r9419:3516a4e8 default
r20689:401f9b66 default
Show More
README
11 lines | 416 B | text/plain | TextLexer
/ doc / README
History | Source | Raw |Copy content |Copy permalink
Martin Geisler
doc: update README with links to Docutils
 r9172 Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:
jake@edge2.net
adding doc directory and files
 r177
Martin Geisler
doc: update README with links to Docutils
 r9172 http://docutils.sourceforge.net/rst.html
jake@edge2.net
adding doc directory and files
 r177
Martin Geisler
doc: update README with links to Docutils
 r9172 It's also convertible to a variety of other formats including standard
Martin Geisler
doc/README: simplify instructions
 r9419 UNIX man page format and HTML. You'll need to install Docutils:
jake@edge2.net
adding doc directory and files
 r177
Martin Geisler
doc: update README with links to Docutils
 r9172 http://docutils.sourceforge.net/
jake@edge2.net
adding doc directory and files
 r177
Martin Geisler
doc: update README with links to Docutils
 r9172 Use the Makefile in this directory to generate the man and HTML pages.