Commit Graph

356 Commits

Author SHA1 Message Date
Martin Geisler
a734140a12 hgrc.5: do not mention "name: value" syntax
This was supported in versions prior to 1.3 where we used the standard
Python ConfigParser. The new config parser never supported it.
2009-11-07 18:47:04 +01:00
Martin Geisler
38d09c8d4d hgrc.5: mark more inline literals 2009-11-07 15:51:32 +01:00
Martin Geisler
1b91a31aa9 hgrc.5: do not turn random URLs into links
URLs and email addresses are automatically turned into links. We don't
want that when talking about example links and addresses.
2009-11-07 14:41:03 +01:00
Martin Geisler
7285aa3ae7 hgrc.5: use enumerated list for email charsets 2009-11-07 14:30:58 +01:00
Christian Ebert
966f02c857 hgrc.5: order of email charsets is not a top level literal block
- it belongs under email charsets, not email in general
- enumerate order
2009-11-07 13:54:47 +01:00
Dirkjan Ochtman
12c5890a70 kill trailing whitespace 2009-11-05 10:44:36 +01:00
Martin Geisler
7e40bdcf3d hg.1: kill spurious backslash
I believe the backslash prevented asciidoc from automatically turning
"(C)" into a real copyright symbol. This replacement is not done in
reST in the first place.
2009-11-02 21:55:59 +01:00
Martin Geisler
05e89d7e15 doc/Makefile: add help/*.txt as a dependency 2009-11-02 21:38:42 +01:00
Martin Geisler
8ae9f6093b doc: add some internal links to man pages 2009-11-02 21:32:42 +01:00
Martin Geisler
7ad329e8b8 hgrc.5: combined short paragraphs into one
Short and precise sentences are good, but we can have more than one
such sentence per paragraph.
2009-11-02 21:08:33 +01:00
Martin Geisler
2ae29e4fd0 doc: use reST note directive
The 'NOTE: bla bla' syntax was for asciidoc and is still present in a
couple of docstrings. The docstrings will be converted to reST format
when minirst knows how to handle it.
2009-11-02 21:02:56 +01:00
Martin Geisler
77e5054cc9 hgrc.5: capitalize True and False consistently 2009-11-02 20:53:34 +01:00
Martin Geisler
0d60e93784 hgrc.5: document ui.traceback setting 2009-11-02 20:50:30 +01:00
Adrian Buehlmann
da618c2315 hgrc.5.txt: mention hgrc categories with higher precedence first
Reordering the FILES section accordingly.

The previous ordering of categories might have been nice from the
viewpoint of a site admin doing an initial install, but presenting a
higher-precedence-first ordering is more relevant and natural for the
average end user, since he will most likely resort to editing rc files
in the order of their precedence, overriding whatever "sane" defaults
are coming from more general files.

Note that this patch does not change the texts, it just moves them.
So, whatever bugs, grammar errors, or typos may have been in the texts
before this patch: they are still there. On purpose. Because this patch
here does not want to reword texts while moving them.
2009-10-21 13:40:55 +02:00
Adrian Buehlmann
b4da330562 doc/hgrc.5.txt: deprecate [defaults]
Quoting Matt:

"Defaults are a bad idea. They are deprecated. Don't use them. Don't
recommend them. Forget they existed. Use aliases."

in http://selenic.com/pipermail/mercurial-devel/2009-October/016095.html
2009-10-22 00:46:54 +02:00
Martin Geisler
598ceacdbb rst2man: highlight inline literals in bold
The old code would switch to Courier, but that doesn't really help
much in a manpage.
2009-10-22 00:30:24 +02:00
Martin Geisler
c03dbf4a91 rst2man: avoid italic for references
The links to other manpages used both italic and bold text nested
within each other. The \fP (select previous font) macro was used
incorrectly to "reset" the nested fonts resulting in:

  <roman> text <italic> <bold> hg <italic> (1) <bold> more text

with no switch back to roman. This stops the bleeding and removes the
ugly italic (underline) from the manpage links.
2009-10-22 00:27:08 +02:00
Martin Geisler
b04344b176 doc: add a style sheet to the generated HTML pages 2009-10-21 23:40:01 +02:00
Martin Geisler
bd199c7536 doc, help: stream-line use of inline-literals 2009-10-20 22:43:17 +02:00
Martin Geisler
7411f95959 gendoc: fix synopsis
The synopsis is used as an inline literal when generating the manpage.
There should not be any whitespace on the inside of the quotation
marks in inline literals.

Commands with an empty synopsis (such as tags) produces ``tags `` as
synopsis, which triggers a warning.
2009-10-20 22:42:49 +02:00
Adrian Buehlmann
75ad7600e0 doc: clarify license footers
Mercurial is licensed under version 2 of the GPL
2009-10-01 11:40:53 +02:00
Martin Geisler
1d1318a176 test-gendoc: add tests for all languages
This ensures that we catch errors in the reST syntax early and for all
languages. The only change needed in gendoc.py was to correct the
computation of section underlines for Asian languages.
2009-09-27 10:12:02 +02:00
Martin Geisler
7b90d8d58a gendoc: do not wrap encoded string
- it breaks multi-byte characters
- it is not needed since Docutils will take care of wrapping the
  strings as necessary
2009-09-27 10:04:51 +02:00
Martin Geisler
946a84caa7 doc/Makefile: make rst2html and rst2man halt on warnings 2009-09-13 17:08:31 +02:00
Martin Geisler
24e70f5cb2 doc/Makefile: do not create files in case of errors
When stdout is redirected to the target file directly, the file is
created as an empty file even when an error occurs. Since the file is
there, 'make' wont try to re-create it in subsequent runs.

This fix is similar to the one in 5c3820db5c29, but it also takes care
of rst2html and gendoc.py.
2009-09-13 17:05:38 +02:00
Martin Geisler
8de4494620 doc: add TOC to hg.1.html and hgrc.5.html 2009-09-04 22:26:57 +02:00
Martin Geisler
0cd7fbbd55 doc/README: simplify instructions 2009-09-03 21:40:45 +02:00
Martin Geisler
8ee86503c8 doc: use our own rst2man.py script (issue1746)
The rst2man tool has not yet been part of an official Docutils
release, and it is not present in most distributions. This poses a
problem for people who want to install Mercurial from source, or who
want to create a Mercurial package for such a distribution -- how to
specify the build-dependencies?

By including the rst2man.py script with Mercurial people only need a
normal Docutils installation in order to install Mercurial.
2009-09-03 21:36:44 +02:00
Martin Geisler
c52cd57ed2 doc/README: rst2man is now in Docutils proper 2009-08-28 20:28:06 +02:00
Mads Kiilerich
2cd7eecc00 doc/Makefile: detect the right name for rst2man and rst2html
docutils uses the .py extension on the commands, and so do their installer.
Distribution packages might strip the .py, but the official name should work too.
2009-08-20 23:35:46 +02:00
Mads Kiilerich
d476cb112b doc/Makefile: Don't show Makefile comments in output
The comments makes sense when editing Makefile, but not when watching its
output where it looks too much like error messages.
2009-08-20 23:35:47 +02:00
Mads Kiilerich
1f8cac4ff1 doc/Makefile: detect rst2man errors
Make couldn't detect rst2man errors when it wasn't the last command, so empty
man page files would be installed.
2009-08-20 23:35:37 +02:00
Martin Geisler
e2912b8950 Merge with crew-stable 2009-08-22 10:52:53 +02:00
Martin Geisler
b139d35cc0 hgrc.5: document %unset directive 2009-08-22 10:50:29 +02:00
Martin Geisler
73b766980d Merge with crew-stable 2009-08-22 01:37:28 +02:00
Martin Geisler
96c88eb0e0 hgrc.5: document %include directive 2009-08-22 01:34:56 +02:00
Dirkjan Ochtman
d96058fd14 hgweb: add web.descend configuration variable 2009-08-19 12:47:04 +02:00
Cédric Duval
5f07139d53 gendoc: don't translate topic strings twice (issue1760) 2009-07-24 12:20:40 +02:00
Martin Geisler
b596922c24 hgignore.5: expanded description
- explain that .hgignore must be created manually
- hint that it is typically put under revision control
2009-07-21 12:06:32 +02:00
Cédric Duval
ba6555759d gendoc: fall back to pure modules if C extensions are not available (issue1711) 2009-07-10 19:45:31 +02:00
Henri Wiechers
65cbcd91fd hgignore.5.txt: improved description of matching
Improved the description of the matching behavior used with .hgignore.
Made some minor language improvements.
2009-07-12 07:56:43 +02:00
Cédric Duval
044fa1649f gendoc: fix localization of help topic
When a topic provides a callable method for its text, most likely
this text will be generated from different parts, so it does not
make sense to apply gettext on the whole result, rather the method
should provide translation by itself.

This is the case with the extensions topic, which triggers a double
gettext call, making the ASCII codec fail when it encounters 8 bit
characters, and prevents the documentation from being built.
2009-07-04 12:12:36 +02:00
Dirkjan Ochtman
567b1cc6eb Backed out changeset e07e58e3faab (depends on other changes, no tests) 2009-08-05 16:32:38 +02:00
Cédric Duval
2b3b3cf99a gendoc: documentation section describing available extensions 2009-08-05 14:44:36 +02:00
Martin Geisler
fcc8159264 gendoc: make anchors for help topic names 2009-08-02 17:42:36 +02:00
Martin Geisler
b9abfaca93 gendoc: rename underlined/bold to section/subsection 2009-07-31 11:40:03 +02:00
Martin Geisler
7b2133abae Merge with crew-stable 2009-07-24 15:28:29 +02:00
Martin Geisler
09ecb9d836 hgignore.5: mark file names and cmdline options as literal text 2009-07-21 12:19:53 +02:00
Martin Geisler
b6d3a25fa7 merge with crew-stable 2009-07-21 12:09:32 +02:00
Martin Geisler
6333eff1b0 doc: update README with links to Docutils 2009-07-18 22:28:28 +02:00