|
3398.1.20
by Ian Clatworthy
add rules help topic |
1 |
Rules |
2 |
===== |
|
3 |
||
4 |
Introduction |
|
5 |
------------ |
|
6 |
||
7 |
Rules are defined in ini file format where the sections are file glob |
|
8 |
patterns and the contents of each section are the preferences for files |
|
|
3943.3.3
by Marius Kruger
update rules topic |
9 |
matching that pattern(s). For example:: |
|
3398.1.20
by Ian Clatworthy
add rules help topic |
10 |
|
|
3398.1.32
by Ian Clatworthy
namespace keyword changed to name |
11 |
[name *.bat] |
|
3398.1.20
by Ian Clatworthy
add rules help topic |
12 |
eol = dos |
13 |
||
|
3943.3.3
by Marius Kruger
update rules topic |
14 |
[name *.html *.xml] |
|
4303.1.1
by Neil Martinsen-Burrell
update the rules documentation to match the currently supported users of rules |
15 |
keywords = xml_escape |
|
3398.1.20
by Ian Clatworthy
add rules help topic |
16 |
|
17 |
Preferences like these are useful for commands and plugins wishing to |
|
|
4303.1.1
by Neil Martinsen-Burrell
update the rules documentation to match the currently supported users of rules |
18 |
provide custom behaviour for selected files. For more information on |
|
4927.2.3
by Ian Clatworthy
improve formatting: better linking, notes, etc. |
19 |
end of line conversion see :doc:`eol-help`. |
20 |
Keyword support is provided by the `keywords plugin |
|
21 |
<http://doc.bazaar.canonical.com/plugins/en/keywords-plugin.html>`_. |
|
|
3398.1.20
by Ian Clatworthy
add rules help topic |
22 |
|
23 |
Files |
|
24 |
----- |
|
25 |
||
|
3606.2.5
by Robert Collins
Cherry pick Robert's 'disable .bzrrules in-tree' patch |
26 |
Default rules for all branches are defined in the optional file |
27 |
``BZR_HOME/rules``. |
|
|
3398.1.20
by Ian Clatworthy
add rules help topic |
28 |
|
|
3515.1.1
by Ian Clatworthy
Rule-based preferences (Ian Clatworthy) |
29 |
Rule Patterns |
30 |
------------- |
|
|
3398.1.20
by Ian Clatworthy
add rules help topic |
31 |
|
32 |
Patterns are ordered and searching stops as soon as one matches. |
|
33 |
As a consequence, more explicit patterns should be placed towards |
|
|
3398.1.26
by Ian Clatworthy
jam feedback - make patterns a separate help topic |
34 |
the top of the file. Rule patterns use exactly the same conventions |
|
4927.2.3
by Ian Clatworthy
improve formatting: better linking, notes, etc. |
35 |
as ignore patterns. See :doc:`patterns-help` for details. |
36 |
||
37 |
.. note:: |
|
38 |
||
39 |
Patterns containing square brackets or spaces should be |
|
40 |
surrounded in quotes to ensure they are correctly parsed. |