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..
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.
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.
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.
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.
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']
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.
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.
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.
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.
Displaying the output from the failing call to "which" didn't prevent
make from doing stupid things later. We now only search for "rst2html"
and fallback to "rst2html.py". If neither name is found, make will
eventually abort when we try to use $(RST2HTML).
The man pages can actually be translated by building them in a
different locale. However, the man pages contain internal links to
certain sections, and when the section titles are translated, the
links change too. So it is currently not recommended to build the man
pages in anything by the "C" locale.
* it's bad to specify only foreground color:
http://www.w3.org/QA/Tips/color
* some people prefer dark background
* `color: #111' is mostly the same as `color: black',
which is the default of almost all popular browsers.
so it's preferable to delete `color: #111', rather than adding
`background-color: white'.
designed loosely based on:
http://mercurial.selenic.com/css/styles.css
with some modifications by intention:
* visited links are colored differently
* no fixed size
* works without typeface.js
we keep most styles, which is from docutils, untouched.
tested with:
* MSIE 6.0 on Windows
* Firefox 3.5 on Linux
Man pages have uppercased section titles but other formats do not.
Letting rst2man handle the tranformation allows better reuse of text
between man pages and other formats.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
This exposed a bug in rst2man where it neglects to escape a literal
backslash. A patch has been applied upstream, but not yet packaged in,
say, Debian unstable. A forward-compatible work-around has therefore
been put in place.
The rst2man writer leaves no space between a literal block and the
following paragraph. This patch corrects this.
It has also been applied upstream. This does not conflict with this
change since any number of newlines can be added without effecting the
rendered man page.
The Makefile now requires the rst2html and rst2man programs. Both can
be found in Debian testing or downloaded from the Docutils homepage:
http://docutils.sf.net/http://docutils.sf.net/sandbox/manpage-writer/
The new HTML and man pages no longer contain huge amounts of
un-wrapping literal blocks, thanks to how snippets of reStructuredText
can easily be included inside other reStructuredText documents.
The HTML pages now have anchors for all sections, including the help
topics in hgrc.1 which were missing from the old HTML pages.
This extends the httpshandler with the means to utilise the auth
section to provide it with a PEM encoded certificate key file and
certificate chain file. This works also with sites that both require
client certificate authentication and basic or digest password
authentication, although the latter situation may require the user to
enter the PEM password multiple times.
The intent is to fix many issues involving patching when win32ext is enabled.
With win32ext, the working directory and repository files EOLs are not the same
which means that patches made on a non-win32ext host do not apply cleanly
because of EOLs discrepancies. A theorically correct approach would be
transform either the patched file or the patch content with the
encoding/decoding filters used by win32ext. This solution is tricky to
implement and invasive, instead we prefer to address the win32ext case, by
offering a way to ignore input EOLs when patching and rewriting them when
saving the patched result.
The quotes would go wrong in many places due to differences between
asciidoc version 8.2.7 used by Benoit and 8.4.5 used by me. Between
those versions asciidoc stopped interpreting the content of `quoted
strings`, and so `*` would start bold text in the old version, but do
nothing in the new version.
To complicate things further, `\*` would escape the bold tag in the
old version, but in the new version the backslash was inserted
literally into the output (because the backtick quotes it).
I've now replaced backticks with non-quoting plusses and escaped
backslashes as appropriate.
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.
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...
