Commit Graph

440 Commits

Author SHA1 Message Date
Martin Geisler
f6008443c8 doc/Makefile: docs now also depend on extensions
After 782257d279ce the hg(1) manpage contains a section with help
extracted from the extensions, so we should depend on them too.
2010-11-04 17:52:40 +01:00
Dan Villiom Podlaski Christiansen
f385faac7a *: kill all unnecessary shebangs. 2010-10-26 12:18:39 +02:00
Martin Geisler
549ae660d7 doc/Makefile: do not include hg.1.gendoc.txt in MANIFEST
It is an intermediate file used to produce the hg.1 and .hg.1.html
files and is not useful for people who download the tarball. It will
be regenerated automatically by the Makefile if users want to rebuild
the documentation.
2010-10-23 20:10:18 +02:00
Martin Geisler
ce3f69d067 doc/Makefile: cleanup clean target 2010-10-23 20:02:46 +02:00
Patrick Mezard
e03174184a hgrc: document [subpaths] section 2010-10-24 18:39:02 +02:00
Martin Geisler
63ce42a571 gendoc: do not strip 'hg ' from synopsis
This was an old left-over from when the synopsis line was used as a
header. We now have the command name by itself as the header and the
synopsis as a literal block immediately after..
2010-10-23 00:18:10 +02:00
Martin Geisler
526cbba402 gendoc: support multi-line synopses 2010-10-23 00:11:39 +02:00
Martin Geisler
fc7340c8f7 gendoc: re-add indentation to global option table
The indentation was lost in 5a8c9ce7fb90.
2010-10-23 00:01:09 +02:00
Martin Geisler
7e2dd66daa merge-tools: fixed typos
Spotted by Patrick Mézard.
2010-10-21 21:34:30 +02:00
Erik Zielke
40bca26fc6 gendoc: added styling for extension TOC
Uses CSS3 columns for the list of extensions, so it is not just a long
list of extension names.
2010-10-20 17:47:46 +02:00
Erik Zielke
efadd693cc gendoc: automatically create help for default extensions.
Adds a section in the hg.1 manpage and corresponding hg.1.html
file. Each extension is listed with its module docstring, followed by
the commands defined by that extendsion.

Creates help for extensions by extracting doc strings from the extension modules
and its commands.
2010-10-20 17:45:09 +02:00
Erik Zielke
6a81d064ce gendoc: dedent documentation from docstrings
When getting docstrings from the source they are indented to look good
in the code. This indentation interferes with how the text is parsed
by rst. Therefore this indentation is removed.
2010-10-19 13:50:03 +02:00
Martin Geisler
d6c5b6360c gendoc: add subsection for each command 2010-10-20 18:08:37 +02:00
Martin Geisler
6cbb755d15 gendoc: move section commands to module scope 2010-10-20 18:07:50 +02:00
Erik Zielke
9ef6ae89b7 help: help topic for merge tools
I have made a help topic for merge tools. The text in the topic is
based on the http://mercurial.selenic.com/wiki/MergeProgram page from
the wiki, along with some extra information on the internal merge tools.
2010-10-20 16:54:34 +02:00
Erik Zielke
b55d97e2ae gendoc: refactor get_cmd
Refactors the get_cmd to take the table as argument, instad
of just referencing the global table, thereby enabling reuse
for extension command tables.
2010-10-18 14:37:52 +02:00
Adrian Buehlmann
bdf7d7f1bc doc: add [format] dotencode description 2010-10-10 23:32:09 +02:00
Mads Kiilerich
665d2722d8 doc: clarify that https cert verification requires web.cacerts 2010-10-01 00:48:50 +02:00
Anthony Foiani
5a82d7f2a7 doc: clarify smtp.password usage 2010-09-23 00:27:04 -06:00
Martin Geisler
db0d34b21b url: limit expansion to safe auth keys (Issue2328)
Mads Kiilerich pointed out that 1e4ade283b02 was too eager since the
prefix and password keys may contain $-signs. So this only add the
username to the list of keys that are expanded.

This also updates the documentation to match.
2010-08-13 10:53:10 +02:00
Martin Geisler
a7c1749596 hgrc.5: fix "hg hg status" -> "hg status" 2010-08-13 10:13:38 +02:00
Nicolas Dumazet
0e9b05da3e runrst: try to be more helpful if docutils is not installed 2010-07-30 14:41:47 +09:00
Nicolas Dumazet
4a63431eda doc: remove has_key usage in hgmanpage 2010-07-22 14:33:50 +09:00
Nicolas Dumazet
0616cfa31f gendoc: remove callable usage (check-code) 2010-07-22 14:30:29 +09:00
Mads Kiilerich
8a38c3ba07 doc: make sure we use our own code for generating man pages
docutils would in some situations pick up its own manpage.py instead of
doc/manpage.py. Renaming to hgmanpage.py makes it less ambiguous.
2010-07-21 17:51:37 +02:00
Chad Dombrova
22bbfbd44a provide pre- and post- hooks with parsed command line arguments.
python hooks are passed two new keyword arguments:
- opts: a dict of options; unsepcified options are set to their default
- pats: a list of arguments

shell hooks receive two new variables containing string representations
of the above data:
- $HG_OPTS
- $HG_PATS

for example, the opts and pats for 'hg -f v1.1' would be:
{'force': True, 'message': '', 'rev': '', 'user': '', 'date': '', 'local': None, 'remove': None, 'mq': None}
['v1.1']
2010-06-10 09:32:19 -07:00
FUJIWARA Katsunori
ce06b102df help: show value requirement and multiple occurrence of options
this helps users to know what kind of option is:

  - no value is required(flag option)
  - value is required
  - value is required, and multiple occurrences are allowed

each kinds are shown as below:

 -f --force              force push
 -e --ssh CMD            specify ssh command to use
 -b --branch BRANCH [+]  a specific branch you would like to push

if one or more 3rd type options are shown, explanation for '[+]' mark
is also shown as footnote.
2010-06-06 17:25:00 +09:00
Matt Mackall
3daed7cd59 hgrc: improve docs for the trusted section 2010-06-04 20:13:51 -05:00
Martin Geisler
ae18c6a910 win32text: mark this extension as deprecated 2010-06-02 14:54:25 +02:00
Martin Geisler
bb828f2f9b doc: document expansion of %include and ui.username 2010-05-27 10:37:14 +02:00
Martin Geisler
f8280fc5b0 Merge with stable 2010-05-25 18:45:44 +02:00
Angel Ezquerra
9be5ff2737 doc: clarify that sections can be split 2010-05-25 18:19:40 +02:00
Angel Ezquerra
08d2753759 doc: clarify that keys can be overridden 2010-05-25 18:19:16 +02:00
David Champion
b8cccccefd merge: tool.check = prompt will force an interactive merge check
tool.check = prompt can be used when the exit status of a merge
tool is unreliable but an explicit user signoff on the merge result is
acceptable.
2010-05-10 11:04:56 -05:00
David Champion
884303ae82 merge: introduce tool.check parameter
tool.check is a list of check options, and can be used in place of
tool.checkchanged and tool.checkconflicts:

Equivalences:
tool.checkchanged = yes
tool.checkconflicts = no
tool.check = changed

tool.checkchanged = no
tool.checkconflicts = yes
tool.check = conflicts

tool.checkchanged = yes
tool.checkconflicts = yes
tool.check = changed, conflicts

Add _toollist() wrapper for ui.configlist() to implement this consistently.

checkchanged and checkconflicts are still supported, but check is
preferred for implementing new check options.
2010-05-10 11:04:56 -05:00
David Champion
14b32f640c merge: tool.premerge=keep will leave premerge markers in $local 2010-04-21 11:57:45 -05:00
Matt Mackall
ae3b272f12 docs: document default for web.encoding 2010-04-26 11:03:40 -05:00
Henrik Stuart
1c5ca1f5d8 ui: support quotes in configlist (issue2147)
Several places that use ui.configlist, predominantly in authentication
scenarios need to interface with systems that can contain spaces in usernames
(e.g. when client certificates are usernames, or Windows usernames).

This changeset introduces a parser that supports quoting of strings, and
escape quotation marks that get decoded into a single quotation mark that
adopts the usual behavior one would expect from quoting strings. The Python
library shlex module is not used, on purpose, as that raises if it cannot
match quotation marks in the given input.
2010-04-25 17:38:41 +02:00
Martin Geisler
68483a49bd Merge with stable 2010-04-25 17:11:50 +02:00
Martin Geisler
aa7bc3741f hgrc.5: mention lists as well 2010-04-25 17:11:36 +02:00
Martin Geisler
e334ff8231 Merge with stable 2010-04-25 16:46:44 +02:00
Martin Geisler
61ede1530c hgrc.5: describe form of config values 2010-04-25 16:46:26 +02:00
Martin Geisler
886975f7a6 doc: add links from hgrc.5 to hg.1 2010-04-23 09:55:47 +02:00
Martin Geisler
7f5b9a0a43 doc: make links for hg role
The system has a bit of smartness:

  :hg:`update`     -> links to hg.1.html#update
  :hg:`help diffs` -> links to hg.1.html#diffs
2010-04-23 09:53:25 +02:00
Martin Geisler
1d06245892 doc, minirst: support hg interpreted text role 2010-04-22 10:04:53 +02:00
Martin Geisler
ce3c2717e9 doc: add generic frontend to rst2man and rst2html
This will allow us to easily register new roles and directives.
2010-04-22 09:57:04 +02:00
Nicolas Dumazet
7f1a963829 pylint, pyflakes: remove unused or duplicate imports 2010-04-14 17:58:10 +09:00
Martin Geisler
01d542a46d doc/ja: remove old Japanese man page translations
They were added way back in 2005 and haven't been updated since. They
are no longer referenced by the Makefiles at upper levels and have not
been shipped with a recent version of Mercurial.
2010-03-02 21:34:24 +01:00
Wagner Bruna
7733a703e9 doc/Makefile: fix doc generation when LANGUAGE is set 2010-02-24 13:47:59 -03:00
Steve Borho
aad9ecf6aa hgrc.5: document use of environment variables on Windows
This feature was introduced in c7a5a2c7063a
2010-02-15 20:28:42 -06:00