Mercurial > hg-stable
changeset 43303:26caf96a5fa9
lfs: dedent documentation section about .hglfs file
The leading ".hglfs::" is interpreted as a macro in generated man page
and, as it is unknown, the whole section does not render. Also, having
the section marked as preformatted (::) makes it render verbatim in
HTML, which is not desired as the text contains formatting markers. So
we just dedent the section and remove the ".hglfs::" line. The example
file is still indented and rendered preformatted.
| author | Denis Laxalde <denis@laxalde.org> |
|---|---|
| date | Mon, 21 Oct 2019 11:08:23 +0200 |
| parents | f0a2c1972e81 |
| children | 8cb5f96db235 |
| files | hgext/lfs/__init__.py |
| diffstat | 1 files changed, 18 insertions(+), 20 deletions(-) [+] |
line wrap: on
line diff
--- a/hgext/lfs/__init__.py Thu Oct 17 16:06:06 2019 +0200 +++ b/hgext/lfs/__init__.py Mon Oct 21 11:08:23 2019 +0200 @@ -53,31 +53,29 @@ file to a usercache, to speed up future access. See the `usercache` config setting described below. -.hglfs:: +The extension reads its configuration from a versioned ``.hglfs`` +configuration file found in the root of the working directory. The +``.hglfs`` file uses the same syntax as all other Mercurial +configuration files. It uses a single section, ``[track]``. - The extension reads its configuration from a versioned ``.hglfs`` - configuration file found in the root of the working directory. The - ``.hglfs`` file uses the same syntax as all other Mercurial - configuration files. It uses a single section, ``[track]``. - - The ``[track]`` section specifies which files are stored as LFS (or - not). Each line is keyed by a file pattern, with a predicate value. - The first file pattern match is used, so put more specific patterns - first. The available predicates are ``all()``, ``none()``, and - ``size()``. See "hg help filesets.size" for the latter. +The ``[track]`` section specifies which files are stored as LFS (or +not). Each line is keyed by a file pattern, with a predicate value. +The first file pattern match is used, so put more specific patterns +first. The available predicates are ``all()``, ``none()``, and +``size()``. See "hg help filesets.size" for the latter. - Example versioned ``.hglfs`` file:: +Example versioned ``.hglfs`` file:: - [track] - # No Makefile or python file, anywhere, will be LFS - **Makefile = none() - **.py = none() + [track] + # No Makefile or python file, anywhere, will be LFS + **Makefile = none() + **.py = none() - **.zip = all() - **.exe = size(">1MB") + **.zip = all() + **.exe = size(">1MB") - # Catchall for everything not matched above - ** = size(">10MB") + # Catchall for everything not matched above + ** = size(">10MB") Configs::