Commit Graph

95 Commits

Author SHA1 Message Date
Matt Mackall
c8c26720e0 fileset: add a help topic
Add crosslinking with patterns topic.
2011-06-18 16:53:49 -05:00
Matt Mackall
1d5abac148 help: consolidate topic hooks in help.py
This removes loops like cmdutil->revset->help->extensions->cmdutil and
simplifies the code.
2011-05-13 12:57:27 -05:00
Matt Mackall
9fd29f01e9 extensions: move moduledoc to break import loop with help 2011-05-13 11:04:51 -05:00
Matt Mackall
d184ed2af2 extensions: drop maxlength from enabled and disabled
This is a bad/silly API. Instead calculate maxlength in one place in help
it's used and simplify all the callers.
2011-05-13 11:04:51 -05:00
Dan Villiom Podlaski Christiansen
511c941422 prevent transient leaks of file handle by using new helper functions
These leaks may occur in environments that don't employ a reference
counting GC, i.e. PyPy.

This implies:
 - changing opener(...).read() calls to opener.read(...)
 - changing opener(...).write() calls to opener.write(...)
 - changing open(...).read(...) to util.readfile(...)
 - changing open(...).write(...) to util.writefile(...)
2011-05-02 10:11:18 +02:00
Yun Lee
c6804b1629 help: move hgignore man page into built-in help (issue2769) 2011-04-17 23:08:35 +08:00
Yun Lee
fd8965dcbb help: sort help topics to make the output more readable (issue2751) 2011-04-05 12:40:47 +08:00
Patrick Mezard
d297dd65c7 help: extract items doc generation function 2011-03-12 12:46:31 +01:00
Patrick Mezard
4f21d24f6f Add subrepos help topic
Edited by:
Martin Geisler <mg@lazybytes.net>
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
2010-10-24 19:28:44 +02:00
Patrick Mezard
88087f644b help: add topic rewriting hooks
They are useful when updating help topics dynamically from extensions.
2010-10-23 19:21:49 +02:00
Martin Geisler
5afa27a390 help: add "revset" alias for "revsets" help topic 2010-10-23 17:45:49 +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
Matt Mackall
51b3b09c8f backout most of 26e0b9a8ce0d 2010-09-24 12:46:54 -05:00
Brodie Rao
7362459729 cleanup: use x in (a, b) instead of x == a or x == b 2010-09-23 00:02:31 -05:00
Martin Geisler
76b0f88494 help: make "hg help hgrc" an alias for "hg help config" 2010-09-02 12:53:28 +02:00
Martin Geisler
4e818c92d7 help: make helptable a list instead of a tuple
The table should always have been a list so that extensions can append
their own help topics -- hgsubversion would like to do this now.
2010-07-22 21:43:45 +02:00
Martin Geisler
66a319e69f help: new revsets topic
Based on a patch by timeless which in turn is based on

  http://selenic.com/pipermail/mercurial-devel/2010-June/021638.html
2010-06-17 17:21:39 +03:00
Faheem Mitha
45dd4bd055 help: add "glossary" topic
Joint work with Vishakh Harikumar, Pradeepkumar Gayam, David Champion,
Mark Booth, timeless, Matt Mackall, Heinrik Stuart, Greg Ward, and
Martin Geisler.
2010-06-16 15:20:22 +05:30
Matt Mackall
6f4ee16a11 help: add some help for hgweb.config files 2010-04-26 11:03:40 -05:00
Benoit Boissinot
f11d48adc1 help: it's not necessary to escape quotes 2010-03-16 16:41:22 +01:00
Brodie Rao
91c6eab10f dispatch: provide help for disabled extensions and commands
Before a command is declared unknown, each extension in hgext is searched,
starting with hgext.<cmdname>. If there's a matching command, a help message
suggests the appropriate extension and how to enable it.

Every extension could potentially be imported, but for cases like rebase,
relink, etc. only one extension is imported.

For the case of "hg help disabledext", if the extension is in hgext, the
extension description is read and a similar help suggestion is printed.
No extension import occurs.
2010-02-07 14:01:43 +01:00
Matt Mackall
8d99be19f0 many, many trivial check-code fixups 2010-01-25 00:05:27 -06:00
Matt Mackall
595d66f424 Update license to GPLv2+ 2010-01-19 22:20:08 -06:00
Martin Geisler
d9281d88ed help: add "hg help config" topic
This is a condensed version of the first two sections of hgrc.5.txt.
After a slight upgrade of minirst, we can move the whole of hgrc.5.txt
into the config help topic and just let the man page include it.
2009-11-07 22:12:50 +01:00
Benoit Boissinot
f7540399b7 remove unused imports 2009-10-31 16:56:58 +01:00
Martin Geisler
524b665b54 help: move help topics from mercurial/help.py to help/*.txt
The help topics are loaded on demand so we wont hit the disk unless we
really have to.
2009-10-04 09:59:13 +02:00
Mads Kiilerich
8ff24147fd cmdutil: templating keywords latesttag and latesttagdistance
This can be used for referring to revisions in a reasonable
meaningful, stable and monotonically increasing way, suitable for
releases or builds directly from a repository.

The latest tag is found by searching through untagged ancestors and
finding the latest tagged ancestor based on tag date. The distance is
found from the length of the longest path to the tagged revision.

For example:
  hg log -l1 --template '{latesttag}+{latesttagdistance}\n'
can return
  1.3.1+197

This is mostly work by Gilles Moris <gilles.moris@free.fr>
2009-10-03 18:31:20 +02:00
Martin Geisler
0f0f34a99a help: align columns "hg help templates" output 2009-08-18 13:59:30 +02:00
Martin Geisler
531c6ddba3 Merge with crew-stable 2009-08-18 13:55:34 +02:00
Martin Geisler
01be01a4e5 help: show results of all date filters 2009-08-18 13:40:19 +02:00
Martin Geisler
482ea06365 help: document isodatesec and rfc3339 filters (issue1799) 2009-08-18 13:00:13 +02:00
Stuart W Marks
7e4c51534f help: improve "hg help revisions"
Add info about branch names, and other clarifications.
2009-08-02 19:21:47 -07:00
David Wolever
638caa9499 help: add #revision syntax to the example valid URLs. 2009-07-04 12:40:34 +02:00
Martin Geisler
4c26f6e453 Merge with crew-stable 2009-08-03 10:28:09 +02:00
Martin Geisler
5b186a8d1b help: un-indent list in "hg help diffs" 2009-08-03 00:02:00 +02:00
Martin Geisler
9eeff5ebc9 help: add "templates" as an alias for "templating" help topic 2009-08-03 00:01:59 +02:00
Martin Geisler
4986571bd9 help: use field lists for lists of extensions 2009-08-03 00:01:50 +02:00
Martin Geisler
64b507518b help: format templating help topic with a field list 2009-08-02 23:38:08 +02:00
Martin Geisler
4a259d887b help: mark literal blocks 2009-08-02 16:34:25 +02:00
Martin Geisler
e806769158 help: wrap help strings at 70 characters 2009-07-26 02:12:53 +02:00
Martin Geisler
f92187f9e3 help: fix bad indentation in template filters list
The indentation showed up in the hg.1.html file.
2009-07-16 23:25:26 +02:00
Martin Geisler
92882a99d0 doc: use reStructuredText for man and HTML pages
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.
2009-07-16 23:25:26 +02:00
Martin Geisler
3951831e0b commands: use minirst parser when displaying help 2009-07-16 23:25:26 +02:00
Martin Geisler
0edf2321f8 help: wrapped help strings at 78 characters 2009-07-08 17:14:24 +02:00
David Wolever
a527dcec27 help: add #revision syntax to the example valid URLs. 2009-07-04 12:40:34 +02:00
Martin Geisler
1454ed1684 commands: wrap short descriptions in 'hg help'
The code for wrapping a single line of text with a hanging indent was
duplicated in commands and help -- it's now moved to a new function
called wrap in util.

The function defaults to a line width is 78 chars, and this un-wraps
some command line flag descriptions, hence the test output changes.
2009-06-24 19:15:58 +02:00
Dirkjan Ochtman
26c979b536 help: rewrap extension description line length at 78 instead of 70 2009-06-24 13:10:05 +02:00
Cédric Duval
6d8eae2087 help: fixing non-matching example texts 2009-06-21 20:35:20 +02:00
Martin Geisler
f0f091167f help: wrap extension descriptions 2009-06-22 00:02:31 +02:00
Greg Ward
d4545cca8c help: improve grammar/wording of 'extensions' topic 2009-06-21 11:23:16 -04:00