Commit Graph

207 Commits

Author SHA1 Message Date
Nikolaj Sjujskij
a32492fbe8 help: fix search with -k option in non-ASCII locales
Keyword search in help (introduced in d455a324f54f and ff267c569bea by Augie
Fackler) tries to translate already translated strings, which results in
Unicode errors in gettext when non-ASCII locale is used. Also command
descriptions should be translated before searching there (thanks to FUJIWARA
Katsunori for pointing this out and actual fix), (issue3482).
2012-06-04 10:45:56 +04:00
Olav Reinert
243a5a590a help: inline helper function used once only 2012-06-01 12:01:33 +02:00
Olav Reinert
70c42374e2 minirst: generate tables as a list of joined lines 2012-06-01 11:58:23 +02:00
Olav Reinert
b372d3da28 help: move some helper functions to help.py 2012-05-22 22:08:41 +02:00
Augie Fackler
c94e6f7b05 help: add --keyword (-k) for searching help 2012-05-13 06:03:11 -05:00
Augie Fackler
a21ee7f93d help: introduce topicmatch for finding topics matching a keyword 2012-05-13 04:27:08 -05:00
A. S. Budden
95a9277375 help: add reference to template help (issue3413)
There is currently no clear link between the help for log
and the help on templates.  The log option is --template
but the template help is 'help templating' or 'help templates'.
This patch makes 'hg help template' work and also adds a
note into the log help explaining where to find more info.
2012-05-01 22:14:51 +01:00
Martin Geisler
63259931d2 help: consistently use title capitalization for help topics 2012-04-30 11:51:24 +02:00
Yann E. MORIN
fa26f04b05 help: strip doctest from dochelp
When a dochelp string contains doctest code, the doctest
code is not stripped, so the help also displays the doctest.

Just stop parsing dochelp at the first hint of a doctest
section (starting with >>>).

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
2012-03-09 22:54:17 +01:00
FUJIWARA Katsunori
4629df01c9 filemerge: create detail of internal merge tools from documentation string
this patch introduces 'internaltoolsmarker' which creates detail of
each internal merge tools from documentation string for 'hg help merge-tools'.
2012-02-12 21:38:12 +09:00
Matt Mackall
578253989c help: add phases topic 2012-01-26 11:23:14 -06:00
Augie Fackler
c1bfd9e71f windows: check util.mainfrozen() instead of ad-hoc checks everywhere 2011-07-25 16:14:02 -05:00
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
Cédric Duval
16497ecd09 help: more improvements for the extensions topic
- improve help text English (thanks to timeless for corrections)
- rename and simplify functions a little bit, improved comments
2009-06-21 17:52:30 +02:00
Cédric Duval
17141a61d0 extensions: move extensions listing functions from mercurial.help
Includes some small fix-ups to comments in enabled() and disabled().
2009-06-21 16:32:00 +02:00
Cédric Duval
9fac1a66d9 help: expand the extensions topic 2009-06-20 20:55:50 +02:00
Cédric Duval
ecdc3822ca help: refactor extensions listing, and show enabled ones in the dedicated topic 2009-06-20 20:55:49 +02:00
Cédric Duval
06cac940ef help: adding a new help topic about extensions
Currently listing non-enabled extensions and a short introductory text.

Thanks to Dan Villiom Podlaski Christiansen for the preliminary
proof-of-concept code for listing available extensions.
2009-06-20 20:55:43 +02:00
Martin Geisler
c624e91552 fixed typos found in translatable strings
This is from a spell-check of hg.pot.
2009-05-31 14:55:51 +02:00
Henrik Stuart
01c54d72e3 templatefilters: add filter to convert date to local date (issue1674)
Issue1674 suggests the localdate filter be applied as default to log,
but this patch only introduces the filter, not the changed default
behaviour.
2009-05-24 11:41:07 +02:00
Martin Geisler
bbf34c8655 help: document nonempty template filter. 2009-04-28 17:30:00 +02:00
Martin Geisler
750183bdad updated license to be explicit about GPL version 2 2009-04-26 01:08:54 +02:00
Martin Geisler
bf3136d2eb help: document stripdir template filter 2009-04-24 19:39:27 +02:00
Martin Geisler
e99be665d8 help: word-wrap help texts at 70 characters 2009-04-04 23:21:33 +02:00
Martin Geisler
af7a5be45e commands, help: consistently write 'URL' in upper-case 2009-04-04 17:44:18 +02:00
Martin Geisler
12c9385a4d help: expand command names in 'Url Paths' help text 2009-04-04 17:41:22 +02:00
Dongsheng Song
da72eadd2c Clarify the usage of HGRCPATH 2009-03-07 16:06:46 +08:00
Matt Mackall
b6fd334dd0 Merge with -stable 2009-03-24 16:41:41 -05:00
Greg Ward
e688a18c6f Typo fix in help. 2009-03-23 15:04:26 -04:00
Alexander Solovyov
475ce753d3 templater: ability to display diffstat for log-like commands 2009-03-23 10:41:42 +01:00
Dongsheng Song
3cab4b874a Typo fix 2009-03-05 14:44:13 +08:00
Dirkjan Ochtman
f7eaf63265 help: get rid of double spaces 2009-02-28 12:33:24 +01:00
Dirkjan Ochtman
fbf5ef05d7 help: better explanations for some of the template filters
In particular, provide some example data for some of the common filters.
Thanks go to timeless again for pointing out where we were lacking.
2009-02-28 12:25:14 +01:00
Dirkjan Ochtman
5b24c2c694 help: better explanation for some of the environment variables
In particular, the precedence for usernames is explained in more detail.
Thanks to timeless for pointing out the deficiencies here.
2009-02-28 12:23:23 +01:00
timeless
ebb328e76d help: some language fixes for help topics 2009-02-28 12:21:41 +01:00
timeless
8cc41e9367 help: better formatting in "Date Formats" section 2009-02-15 12:56:38 +01:00
Bill Barry
89fd1de384 consolidated url help into urls help topic and added information about path aliases 2009-01-22 11:02:50 -07:00
Dirkjan Ochtman
52dd3220bf help: some improvements for the templating topic 2009-01-22 14:19:29 +01:00
Alexander Solovyov
55cafc7065 help: add a topic about some of the templating features 2009-01-22 14:18:08 +01:00
Matt Mackall
4e3875be62 update help on git diffs 2008-11-18 15:35:34 -06:00
Thomas Arendsen Hein
9ef29ab028 Enhance gitdiffs help text 2008-11-07 13:02:03 +01:00
Dirkjan Ochtman
604b2a1406 kill some trailing spaces 2008-11-01 13:06:36 +01:00
Dirkjan Ochtman
4a5e2178e2 help: add a topic on git diffs (issue1352) 2008-10-30 08:21:20 +01:00
Martin Geisler
d247b977fd i18n: mark help strings for translation
The gettext function is just another name for the normal _ function
and it is used for translating docstrings when using _ would make
pygettext.py output a warning.
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
Matt Mackall
2ff2e83963 fix iso date help 2008-07-11 18:46:02 -05: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
Thomas Arendsen Hein
66db9ab9a2 Document log date ranges and mention 'hg help dates' for all commands (issue998) 2008-02-22 21:18:48 +01:00
Matt Mackall
a2dcecb2de filemerge: remove the hgmerge script
This is now better handled using [merge-tools] and [merge-patterns] in hgrc.
2008-02-03 19:29:05 -06:00
Osku Salerma
7f9d71b715 Use VISUAL in addition to EDITOR when choosing the editor to use. 2007-12-05 20:40:01 +09:00
Thomas Arendsen Hein
ae0d60a260 Simplify/correct finding the hg executable (fixes issue644)
Simply use find_exe('hg') as the default value for $HG and require to manually
set it if you have special requirements.

While the default will not always be 100% correct (i.e. the identical hg
version) for many users it is and for the others the hg executable found in
the PATH should do most things correctly.

Developers or other users with multiple installs can set $HG or run something
like util.set_hgexecutable in their shell or python scripts.

Additionally util.hgexecutable() is now available so extensions can access
the value with a public interface, too.
2007-08-04 22:25:12 +02:00
Thomas Arendsen Hein
2e76adae49 Remember path to 'hg' executable and pass to external tools and hooks as $HG. 2007-06-23 20:21:10 +02:00
Thomas Arendsen Hein
66709dc5f7 Using --date "" isn't possible, so don't document epoch. (see issue447) 2006-12-16 22:13:56 +01:00
Matt Mackall
8e281a7b62 Update dates help topic 2006-12-06 13:36:23 -06:00
Matt Mackall
33b4d3e066 move patterns topics 2006-12-05 16:36:06 -06:00
Matt Mackall
85c7dc0db1 move environment topic 2006-12-05 16:31:08 -06:00
Matt Mackall
6a2edd9f43 Add basic support for help topics and a dates topic 2006-12-05 16:06:13 -06:00