[PATCH] help: move hgignore man page into built-in help

Martin Geisler mg at aragost.com
Fri Apr 8 04:50:55 CDT 2011


"Md.O.Shayan" <mdoshayan at gmail.com> writes:

> # HG changeset patch
> # User Md.O.Shayan<mdoshayan at gmail.com>
> # Date 1302253980 -19800
> # Node ID 6cbe250742aac8668aa24afce0bf614c7c1cdc78
> # Parent  d3f90ff904b80519ee432241d359d34d75af5475
> help: move hgignore man page into built-in help

That is cool -- will you make a follow-up patch that replaces the text
in doc/hgignore.5.txt with a

  .. include:: ../mercurial/help/hgignore.txt

I think that should just work so that we can keep generating a man page.

> diff -r d3f90ff904b8 -r 6cbe250742aa mercurial/help.py
> --- a/mercurial/help.py	Thu Apr 07 15:08:15 2011 -0500
> +++ b/mercurial/help.py	Fri Apr 08 14:43:00 2011 +0530
> @@ -106,6 +106,7 @@
>      (["subrepo", "subrepos"], _("Subrepositories"), loaddoc('subrepos')),
>      (["hgweb"], _("Configuring hgweb"), loaddoc('hgweb')),
>      (["glossary"], _("Glossary"), loaddoc('glossary')),
> +    (["hgignore", "ignore"], _("Syntax for Mercurial ignore files"), loaddoc('hgignore')),
>  ])

This line is very long and I'm pretty sure check-code will complain when
you run it (always run the full test suite).

> +In addition, a Mercurial configuration file can reference a set of
> +per-user or global ignore files. See the |hgrc(5)|_ man page for details
> +of how to configure these files. Look for the "ignore" entry in the
> +"ui" section.

The substitutions don't work with minirst, so '|hgrc(5)|_' need to be
just 'hgrc(5)' or similar. You could also look into teaching minirst
about such substitutions.

-- 
Martin Geisler

aragost Trifork
Professional Mercurial support
http://mercurial.aragost.com/kick-start/


More information about the Mercurial-devel mailing list