Commit Graph

288 Commits

Author SHA1 Message Date
Martin Geisler
215f869db8 hg.1: highlight references to commands and man pages 2009-06-10 01:14:16 +02:00
Martin Geisler
f906d04b19 hg.1: simplify synopsis
Now that arguments can be mixed with options we can simplify the
synopsis considerably. Also, highlighting the command name in bold
(instead of italics) seem to be the standard convention.
2009-06-10 01:09:21 +02:00
Martin Geisler
6d7eccbdcc hgrc.5: spell check 2009-06-10 00:55:57 +02:00
Martin Geisler
bc5c193ce2 man pages: add meta data
This removes the fixme's that were otherwise inserted.
2009-06-10 00:46:30 +02:00
Martin Geisler
f88e959011 man pages: updated copyright years 2009-06-10 00:13:08 +02:00
Martin Geisler
a5e22ab2f7 hgrc.5: use NOTE admonition paragraph 2009-06-10 00:11:24 +02:00
Martin Geisler
25c277802b hgrc.5: reformatted to avoid big chunks of monospaced text
The man page used to have lines longer than 80 characters, even though
all lines in the hgrc.5.txt file were wrapped nicely. The problem
turned out to be that the indented paragraphs started literal blocks
instead of normal paragraphs. The literal blocks were of course not
wrapped when displayed by man.

In short, the asciidoc rules require lists to be formatted like this:

foo::
  Some description of foo.
+
Another paragraph in the description of foo. It *must* start flush
left and the plus is necessary to indicate that this is a list item
continuation.

Lists with nested lists can be formatted correctly using something
called "open blocks". These blocks are used to group the list items
and are marked by a line above and below with two dashes. See the
asciidoc user guide for the gory details...
2009-06-10 00:06:20 +02:00
Martin Geisler
f4b6037b5b hgrc.5: mark filename patterns as monospaced text 2009-06-09 23:26:16 +02:00
Martin Geisler
6f8338698b hgrc.5: single quotes means italic in asciidoc
Use double quotes instead and mark the * as monospaced text.
2009-06-09 23:24:43 +02:00
Martin Geisler
c4cdb96344 man pages: mark filenames and env vars as fixed text 2009-06-09 23:08:55 +02:00
Martin Geisler
95425236a2 hgrc.5: wrap lines at 70 chars (whitespace cleanup) 2009-06-08 00:14:24 +02:00
Martin Geisler
46e9222615 hgignore.5: wrap lines at 70 chars (whitespace cleanup) 2009-06-08 00:13:58 +02:00
Martin Geisler
7361cab872 hg.1: wrap lines at 70 chars (whitespace cleanup) 2009-06-08 00:13:35 +02:00
timeless
0bd3444de9 hgrc.5: language fixes 2009-06-07 17:34:12 +02:00
Christian Ebert
acc65a6303 hgrc.5: wrap manpage at 80 chars
Checked with asciidoc 8.4.5
2009-06-01 02:17:57 +02:00
Brendan Cully
5189b36798 Move alias into core 2009-05-30 11:32:23 -07:00
Ori Avtalion
c9dc788181 gendoc: add missing space in command synopsis 2009-05-22 20:19:22 +02:00
Brodie Rao
f244d61202 hgrc.5: fix label delimiter 2009-05-09 15:08:46 -04:00
Sune Foldager
4a665141b4 allow http authentication information to be specified in the configuration 2009-05-04 20:26:27 +02:00
Giorgos Keramidas
afd8c70fd6 manpage build: fail early when xmlto is not available
When we try to build manpages with xmlto and sed, but xmlto is
missing fail at the xmlto stage.  Otherwise, one may run `cd doc;
make' and miss the warnings like:

  xmlto: not found
  sed: hg.1: No such file or directory

and end up with empty files installed as manpages.
2009-05-07 15:08:25 +03:00
Nicolas Dumazet
6ebdee6dde profiling: Adding support for kcachegrind output format, using lsprofcalltree 2009-04-08 14:20:57 +02:00
Nicolas Dumazet
f2cfd93c8c profiling: Adding a profiling.format config variable
Allows defining other output formats for profiling.

If an invalid format is given, output a warning and ignore it.
For now, only the standard 'text' value is supported.
2009-04-02 16:01:30 +09:00
Nicolas Dumazet
14ff1a53ae profiling: Adding profiling.output config variable
If specified, outputs profiling data to the said file.
Prints to stderr by default
2009-04-08 14:19:41 +02:00
Alexander Solovyov
609db13729 ability to load hooks from arbitrary python module 2009-03-27 01:28:09 +02:00
Christian Ebert
d3b93918d5 Do not install executable man pages
Default mode of install might be 755, therefore specify 644.
2009-01-25 12:21:57 +01:00
Patrick Mezard
2771395c7d Document how HTML documentation is built under Windows 2009-01-17 15:15:26 +01:00
Christian Ebert
d66ba973f0 hgrc 5: fix email.charsets documentation 2008-12-02 15:31:48 +01:00
Matt Mackall
d5c6f31ce5 doc: handle shortened command synopses 2008-11-14 14:12:16 -06:00
Mark Edgington
bf5852441b hgweb: support for deny_read/allow_read options
reimplementation of a patch provided by Nilton Volpato.

Folded into a single patch by Thomas Arendsen Hein.
2008-10-31 15:28:06 +01:00
Christian Ebert
44f3c4c080 hgrc.5: explain order of mail.charsets
TODO: add mail.charsets section to hgrc.5.ja.txt
2008-10-22 11:57:20 +02:00
Thomas Arendsen Hein
78d2b2a81c Document config option format.usefncache and improve format.usestore docs. 2008-10-24 14:58:24 +02:00
Matt Mackall
e617903e64 Autodetect static-http 2008-10-22 15:41:32 -05:00
Christian Ebert
3ecc265292 Document email.charsets in hgrc.5
hgrc.5.ja.txt probably should include an example like:

[email]
charsets = iso-8859-1, iso-8859-15, windows-1252, iso-8859-2,
           windows-1250, iso-2022-jp, iso-2022-jp-ms
2008-10-16 17:08:46 +02:00
Martin Geisler
090a14a77f i18n: use gettext instead of _
Both gettext and _ trigger a translation at runtime, but _ can only be
used with a string argument since it also triggers string extraction.
2008-09-09 21:32:39 +02:00
Martin Geisler
66070424fd restructure helptable
When looking up a help topic, the key is now only matched against the
short names for each topic, and not the header. So

  hg help 'Environment Variables'

must be replaced with

  hg help env
2008-09-09 21:32:39 +02:00
Christian Ebert
c486b58886 doc/Makefile: rephrase comment (typo) 2008-08-28 13:06:24 +02:00
Benoit Boissinot
0c4a5ee0aa ui: add an option to prompt for the username when it isn't provided
When ui.askusername is set and not username are specified on the command line,
in hgrc or in the variables $HGUSER or $EMAIL, then hg will prompt for the
username.
Feature requested, and documentation provided by Mark Edgington.
2008-08-06 15:10:05 +02:00
Dirkjan Ochtman
c826ee8fa5 merge from crew-stable 2008-06-24 09:34:38 +02:00
Dirkjan Ochtman
331f22c437 use ${PYTHON} var in doc/Makefile as well 2008-06-24 09:33:13 +02:00
Johannes Stezenbach
fd4475d65a help: move "revision syntax" help topics into online help
Move the "Specifying Single Revisions" and "Specifying Multiple
Revisions" help topics from the manual page into the helptable
so they are available both online and in the manual page.
2008-06-03 21:20:52 +02:00
Johannes Stezenbach
2a7f0686c0 help: helptable is an ordered collection
The helptable is used for helptopics listed in the manual
page, so the order of topics should not be random.
Convert it from a dictionary into a tuple of tuples.
Also reorder helptable entries to keep previous manual
page order.
2008-06-03 21:03:51 +02:00
Adrian Buehlmann
ce4d2eca37 doc/hgrc.5.txt: add anchors for sections
Enables links into hgrc.5.html of the form: hgrc.5.html#section
2008-05-14 01:08:51 +02:00
Adrian Buehlmann
855a483848 gendoc: add anchors for commands
Enables links into hg.1.html of the form: hg.1.html#command
2008-04-23 19:40:15 +02:00
Dirkjan Ochtman
e31d0e46c9 Merge from crew-stable. 2008-04-07 09:26:40 +02:00
Christian Ebert
3247bd3127 gendoc: fix indentation 2008-04-06 13:13:31 +02:00
Christian Ebert
e208fbcb2d hg.1: bogus escaping of .hg* not needed anymore
Revert a1f27fda31ea, bbc0eeefe0b3 workarounds.
2008-04-06 13:13:31 +02:00
Christian Ebert
d68174388b doc: escape .hg at bol in manpages with make (issue1072)
This works around a bug in old docbook stylesheets.
Remove .*.swp example from hgignore.5.txt.

Diagnosis and workaround thanks to Alexis S. L. Carvalho.
2008-04-07 09:02:04 +02:00
Christian Ebert
592b27aad1 asciidoc: consistently use 1 space after full stop
Note: the command doc strings included in hg (1) are still
      inconsistent wrt to spaces after full stops.
2008-04-01 14:35:35 +02:00
Christian Ebert
cbc606291c hgrc.5: fix subsection formatting 2008-04-01 14:35:11 +02:00
Matt Mackall
4794cecf39 pager: remove pager code from core 2008-03-20 11:12:35 -05:00