##// END OF EJS Templates
doc, help: stream-line use of inline-literals
Martin Geisler -
r9624:585d2ffe default
parent child Browse files
Show More
@@ -43,14 +43,14 b' of how to configure these files. Look fo'
43 43 "ui" section.
44 44
45 45 To control Mercurial's handling of files that it manages, see the
46 |hg(1)|_ man page. Look for the "``-I``" and "``-X``" options.
46 |hg(1)|_ man page. Look for the ``-I`` and ``-X`` options.
47 47
48 48 SYNTAX
49 49 ------
50 50
51 51 An ignore file is a plain text file consisting of a list of patterns,
52 with one pattern per line. Empty lines are skipped. The "``#``"
53 character is treated as a comment character, and the "``\``" character
52 with one pattern per line. Empty lines are skipped. The ``#``
53 character is treated as a comment character, and the ``\`` character
54 54 is treated as an escape character.
55 55
56 56 Mercurial supports several pattern syntaxes. The default syntax used
@@ -71,9 +71,9 b' The chosen syntax stays in effect when p'
71 71 follow, until another syntax is selected.
72 72
73 73 Neither glob nor regexp patterns are rooted. A glob-syntax pattern of
74 the form "``*.c``" will match a file ending in "``.c``" in any directory,
75 and a regexp pattern of the form "``\.c$``" will do the same. To root a
76 regexp pattern, start it with "``^``".
74 the form ``*.c`` will match a file ending in ``.c`` in any directory,
75 and a regexp pattern of the form ``\.c$`` will do the same. To root a
76 regexp pattern, start it with ``^``.
77 77
78 78 EXAMPLE
79 79 -------
@@ -86,8 +86,8 b' ones.'
86 86 SYNTAX
87 87 ------
88 88
89 A configuration file consists of sections, led by a "``[section]``" header
90 and followed by "``name: value``" entries; "``name=value``" is also accepted.
89 A configuration file consists of sections, led by a ``[section]`` header
90 and followed by ``name: value`` entries; ``name=value`` is also accepted.
91 91
92 92 ::
93 93
@@ -101,15 +101,15 b' they are treated as continuations of tha'
101 101
102 102 Leading whitespace is removed from values. Empty lines are skipped.
103 103
104 Lines beginning with "``#``" or "``;``" are ignored and may be used to provide
104 Lines beginning with ``#`` or ``;`` are ignored and may be used to provide
105 105 comments.
106 106
107 A line of the form "``%include file``" will include ``file`` into the
107 A line of the form ``%include file`` will include ``file`` into the
108 108 current configuration file. The inclusion is recursive, which means
109 109 that included files can include other files. Filenames are relative to
110 110 the configuration file in which the ``%include`` directive is found.
111 111
112 A line with "``%unset name``" will remove ``name`` from the current
112 A line with ``%unset name`` will remove ``name`` from the current
113 113 section, if it has been set previously.
114 114
115 115
@@ -167,9 +167,9 b' Example::'
167 167 Supported arguments:
168 168
169 169 ``prefix``
170 Either "``*``" or a URI prefix with or without the scheme part.
170 Either ``*`` or a URI prefix with or without the scheme part.
171 171 The authentication entry with the longest matching prefix is used
172 (where "``*``" matches everything and counts as a match of length
172 (where ``*`` matches everything and counts as a match of length
173 173 1). If the prefix doesn't include a scheme, the match is performed
174 174 against the URI with its scheme stripped as well, and the schemes
175 175 argument, q.v., is then subsequently consulted.
@@ -204,9 +204,9 b' localization/canonicalization of files.'
204 204
205 205 Filters consist of a filter pattern followed by a filter command.
206 206 Filter patterns are globs by default, rooted at the repository root.
207 For example, to match any file ending in "``.txt``" in the root
208 directory only, use the pattern "``*.txt``". To match any file ending
209 in "``.c``" anywhere in the repository, use the pattern "``**.c``".
207 For example, to match any file ending in ``.txt`` in the root
208 directory only, use the pattern ``*.txt``. To match any file ending
209 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
210 210
211 211 The filter command can start with a specifier, either "pipe:" or
212 212 "tempfile:". If no specifier is given, "pipe:" is used by default.
@@ -349,16 +349,16 b' Mercurial has an extension mechanism for'
349 349 enable an extension, create an entry for it in this section.
350 350
351 351 If you know that the extension is already in Python's search path,
352 you can give the name of the module, followed by "``=``", with nothing
353 after the "``=``".
352 you can give the name of the module, followed by ``=``, with nothing
353 after the ``=``.
354 354
355 Otherwise, give a name that you choose, followed by "``=``", followed by
356 the path to the "``.py``" file (including the file name extension) that
355 Otherwise, give a name that you choose, followed by ``=``, followed by
356 the path to the ``.py`` file (including the file name extension) that
357 357 defines the extension.
358 358
359 359 To explicitly disable an extension that is enabled in an hgrc of
360 broader scope, prepend its path with "``!``", as in
361 "``hgext.foo = !/ext/path``" or "``hgext.foo = !``" when path is not
360 broader scope, prepend its path with ``!``, as in
361 ``hgext.foo = !/ext/path`` or ``hgext.foo = !`` when path is not
362 362 supplied.
363 363
364 364 Example for ``~/.hgrc``::
@@ -594,7 +594,7 b' called with at least three keyword argum'
594 594 "ui"), a repository object (keyword "repo"), and a "hooktype"
595 595 keyword that tells what kind of hook is used. Arguments listed as
596 596 environment variables above are passed as keyword arguments, with no
597 "``HG_``" prefix, and names in lower case.
597 ``HG_`` prefix, and names in lower case.
598 598
599 599 If a Python hook returns a "true" value or raises an exception, this
600 600 is treated as a failure.
@@ -719,7 +719,7 b' serve repositories from different users.'
719 719
720 720 This section specifies what users and groups are trusted. The
721 721 current user is always trusted. To trust everybody, list a user or a
722 group with name "``*``".
722 group with name ``*``.
723 723
724 724 ``users``
725 725 Comma-separated list of trusted users.
@@ -755,7 +755,7 b' User interface controls.'
755 755 in the same format as a repository-wide .hgignore file. This
756 756 option supports hook syntax, so if you want to specify multiple
757 757 ignore files, you can do so by setting something like
758 "``ignore.other = ~/.hgignore2``". For details of the ignore file
758 ``ignore.other = ~/.hgignore2``. For details of the ignore file
759 759 format, see the |hgignore(5)|_ man page.
760 760 ``interactive``
761 761 Allow to prompt the user. True or False. Default is True.
@@ -788,10 +788,10 b' merge-tools section.'
788 788 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
789 789 trusted user or group. True or False. Default is True.
790 790 ``slash``
791 Display paths using a slash ("``/``") as the path separator. This
791 Display paths using a slash (``/``) as the path separator. This
792 792 only makes a difference on systems where the default path
793 793 separator is not the slash character (e.g. Windows uses the
794 backslash character ("``\``")).
794 backslash character (``\``)).
795 795 Default is False.
796 796 ``ssh``
797 797 command to use for SSH connections. Default is 'ssh'.
@@ -837,7 +837,7 b' Web interface configuration.'
837 837 Whether to allow pulling from the repository. Default is true.
838 838 ``allow_push``
839 839 Whether to allow pushing to the repository. If empty or not set,
840 push is not allowed. If the special value "``*``", any remote user can
840 push is not allowed. If the special value ``*``, any remote user can
841 841 push, including unauthenticated users. Otherwise, the remote user
842 842 must have been authenticated, and the authenticated user name must
843 843 be present in this list (separated by whitespace or ","). The
@@ -850,7 +850,7 b' Web interface configuration.'
850 850 user is unauthenticated or not present in the list (separated by
851 851 whitespace or ","), then access is denied for the user. If the
852 852 list is empty or not set, then access is permitted to all users by
853 default. Setting allow_read to the special value "``*``" is equivalent
853 default. Setting allow_read to the special value ``*`` is equivalent
854 854 to it not being set (i.e. access is permitted to all users). The
855 855 contents of the allow_read list are examined after the deny_read
856 856 list.
@@ -866,7 +866,7 b' Web interface configuration.'
866 866 Defaults to ui.username or ``$EMAIL`` or "unknown" if unset or empty.
867 867 ``deny_push``
868 868 Whether to deny pushing to the repository. If empty or not set,
869 push is not denied. If the special value "``*``", all remote users are
869 push is not denied. If the special value ``*``, all remote users are
870 870 denied push. Otherwise, unauthenticated users are all denied, and
871 871 any authenticated user name present in this list (separated by
872 872 whitespace or ",") is also denied. The contents of the deny_push
@@ -876,7 +876,7 b' Web interface configuration.'
876 876 not empty, unauthenticated users are all denied, and any
877 877 authenticated user name present in this list (separated by
878 878 whitespace or ",") is also denied access to the repository. If set
879 to the special value "``*``", all remote users are denied access
879 to the special value ``*``, all remote users are denied access
880 880 (rarely needed ;). If deny_read is empty or not set, the
881 881 determination of repository access depends on the presence and
882 882 content of the allow_read list (see description). If both
@@ -7,17 +7,17 b' patterns.'
7 7 Alternate pattern notations must be specified explicitly.
8 8
9 9 To use a plain path name without any pattern matching, start it with
10 "path:". These path names must completely match starting at the
10 ``path:``. These path names must completely match starting at the
11 11 current repository root.
12 12
13 To use an extended glob, start a name with "glob:". Globs are rooted
14 at the current directory; a glob such as "``*.c``" will only match
15 files in the current directory ending with ".c".
13 To use an extended glob, start a name with ``glob:``. Globs are rooted
14 at the current directory; a glob such as ``*.c`` will only match files
15 in the current directory ending with ``.c``.
16 16
17 The supported glob syntax extensions are "``**``" to match any string
18 across path separators and "{a,b}" to mean "a or b".
17 The supported glob syntax extensions are ``**`` to match any string
18 across path separators and ``{a,b}`` to mean "a or b".
19 19
20 To use a Perl/Python regular expression, start a name with "re:".
20 To use a Perl/Python regular expression, start a name with ``re:``.
21 21 Regexp pattern matching is anchored at the root of the repository.
22 22
23 23 Plain examples::
General Comments 0
You need to be logged in to leave comments. Login now