| dsp | |
| durin42 |
| hg-reviewers |
Previously, [include] was implicit and pattern lines before a
[section] were added to includes.
Because the format may change in the future and explicit behavior,
well, more explicit, this commit changes the config parser to
reject pattern lines that don't occur in a [section].
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
Change looks good to me. I am in favor of that BC change. /cc @durham for an opinion tho.
| Path | Packages | |||
|---|---|---|---|---|
| M | hgext/sparse.py (3 lines) | |||
| M | mercurial/sparse.py (15 lines) | |||
| M | tests/test-sparse-profiles.t (13 lines) |
| with ``#`` are ignored. | with ``#`` are ignored. | ||||
| Lines beginning with ``%include `` denote another sparse config file | Lines beginning with ``%include `` denote another sparse config file | ||||
| to include. e.g. ``%include tests.sparse``. The filename is relative | to include. e.g. ``%include tests.sparse``. The filename is relative | ||||
| to the repository root. | to the repository root. | ||||
| The special lines ``[include]`` and ``[exclude]`` denote the section | The special lines ``[include]`` and ``[exclude]`` denote the section | ||||
| for includes and excludes that follow, respectively. It is illegal to | for includes and excludes that follow, respectively. It is illegal to | ||||
| have ``[include]`` after ``[exclude]``. If no sections are defined, | have ``[include]`` after ``[exclude]``. | ||||
| entries are assumed to be in the ``[include]`` section. | |||||
| Non-special lines resemble file patterns to be added to either includes | Non-special lines resemble file patterns to be added to either includes | ||||
| or excludes. The syntax of these lines is documented by :hg:`help patterns`. | or excludes. The syntax of these lines is documented by :hg:`help patterns`. | ||||
| Patterns are interpreted as ``glob:`` by default and match against the | Patterns are interpreted as ``glob:`` by default and match against the | ||||
| root of the repository. | root of the repository. | ||||
| Exclusion patterns take precedence over inclusion patterns. So even | Exclusion patterns take precedence over inclusion patterns. So even | ||||
| if a file is explicitly included, an ``[exclude]`` entry can remove it. | if a file is explicitly included, an ``[exclude]`` entry can remove it. | ||||
| def parseconfig(ui, raw): | def parseconfig(ui, raw): | ||||
| """Parse sparse config file content. | """Parse sparse config file content. | ||||
| Returns a tuple of includes, excludes, and profiles. | Returns a tuple of includes, excludes, and profiles. | ||||
| """ | """ | ||||
| includes = set() | includes = set() | ||||
| excludes = set() | excludes = set() | ||||
| current = includes | |||||
| profiles = set() | profiles = set() | ||||
| current = None | |||||
| havesection = False | |||||
| for line in raw.split('\n'): | for line in raw.split('\n'): | ||||
| line = line.strip() | line = line.strip() | ||||
| if not line or line.startswith('#'): | if not line or line.startswith('#'): | ||||
| # empty or comment line, skip | # empty or comment line, skip | ||||
| continue | continue | ||||
| elif line.startswith('%include '): | elif line.startswith('%include '): | ||||
| line = line[9:].strip() | line = line[9:].strip() | ||||
| if line: | if line: | ||||
| profiles.add(line) | profiles.add(line) | ||||
| elif line == '[include]': | elif line == '[include]': | ||||
| if current != includes: | if havesection and current != includes: | ||||
| # TODO pass filename into this API so we can report it. | # TODO pass filename into this API so we can report it. | ||||
| raise error.Abort(_('sparse config cannot have includes ' + | raise error.Abort(_('sparse config cannot have includes ' + | ||||
| 'after excludes')) | 'after excludes')) | ||||
| havesection = True | |||||
| current = includes | |||||
| continue | continue | ||||
| elif line == '[exclude]': | elif line == '[exclude]': | ||||
| havesection = True | |||||
| current = excludes | current = excludes | ||||
| elif line: | elif line: | ||||
| if current is None: | |||||
| raise error.Abort(_('sparse config entry outside of ' | |||||
| 'section: %s') % line, | |||||
| hint=_('add an [include] or [exclude] line ' | |||||
| 'to declare the entry type')) | |||||
| if line.strip().startswith('/'): | if line.strip().startswith('/'): | ||||
| ui.warn(_('warning: sparse profile cannot use' + | ui.warn(_('warning: sparse profile cannot use' + | ||||
| ' paths starting with /, ignoring %s\n') % line) | ' paths starting with /, ignoring %s\n') % line) | ||||
| continue | continue | ||||
| current.add(line) | current.add(line) | ||||
| return includes, excludes, profiles | return includes, excludes, profiles | ||||
| test sparse | test sparse | ||||
| $ hg init myrepo | $ hg init myrepo | ||||
| $ cd myrepo | $ cd myrepo | ||||
| $ cat > .hg/hgrc <<EOF | $ cat > .hg/hgrc <<EOF | ||||
| > [extensions] | > [extensions] | ||||
| > sparse= | > sparse= | ||||
| > purge= | > purge= | ||||
| > strip= | > strip= | ||||
| > rebase= | > rebase= | ||||
| > EOF | > EOF | ||||
| Config file without [section] is rejected | |||||
| $ cat > bad.sparse <<EOF | |||||
| > *.html | |||||
| > EOF | |||||
| $ hg debugsparse --import-rules bad.sparse | |||||
| abort: sparse config entry outside of section: *.html | |||||
| (add an [include] or [exclude] line to declare the entry type) | |||||
| [255] | |||||
| $ rm bad.sparse | |||||
| $ echo a > index.html | $ echo a > index.html | ||||
| $ echo x > data.py | $ echo x > data.py | ||||
| $ echo z > readme.txt | $ echo z > readme.txt | ||||
| $ cat > webpage.sparse <<EOF | $ cat > webpage.sparse <<EOF | ||||
| > # frontend sparse profile | > # frontend sparse profile | ||||
| > [include] | > [include] | ||||
| > *.html | > *.html | ||||
| > EOF | > EOF | ||||
| $ hg init sparseperm | $ hg init sparseperm | ||||
| $ cd sparseperm | $ cd sparseperm | ||||
| $ cat > .hg/hgrc <<EOF | $ cat > .hg/hgrc <<EOF | ||||
| > [extensions] | > [extensions] | ||||
| > sparse= | > sparse= | ||||
| > EOF | > EOF | ||||
| $ touch a b | $ touch a b | ||||
| $ cat > .hgsparse <<EOF | $ cat > .hgsparse <<EOF | ||||
| > [include] | |||||
| > a | > a | ||||
| > EOF | > EOF | ||||
| $ hg commit -Aqm 'initial' | $ hg commit -Aqm 'initial' | ||||
| $ chmod a+x b | $ chmod a+x b | ||||
| $ hg commit -qm 'make executable' | $ hg commit -qm 'make executable' | ||||
| $ cat >> .hgsparse <<EOF | $ cat >> .hgsparse <<EOF | ||||
| > b | > b | ||||
| > EOF | > EOF | ||||
| $ hg commit -qm 'update profile' | $ hg commit -qm 'update profile' | ||||
| $ hg up -q 0 | $ hg up -q 0 | ||||
| $ hg debugsparse --enable-profile .hgsparse | $ hg debugsparse --enable-profile .hgsparse | ||||
| $ hg up -q 2 | $ hg up -q 2 | ||||
| $ ls -l b | $ ls -l b | ||||
| -rwxr-xr-x* b (glob) | -rwxr-xr-x* b (glob) | ||||
| #endif | #endif | ||||