← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/en/rules.txt

Merge with prepare-shelf

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/rules.txt
 
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
 
9
matching that pattern. For example::
 
10
 
 
11
    [name *.bat]
 
12
    eol = dos
 
13
 
 
14
    [name *.html]
 
15
    keywords = escape
 
16
 
 
17
Preferences like these are useful for commands and plugins wishing to
 
18
provide custom behaviour for selected files in selected branches.
 
19
 
 
20
 
 
21
Files
 
22
-----
 
23
 
 
24
Default rules for all branches are defined in the optional file
 
25
``BZR_HOME/rules``. 
 
26
 
 
27
Rule Patterns
 
28
-------------
 
29
 
 
30
Patterns are ordered and searching stops as soon as one matches.
 
31
As a consequence, more explicit patterns should be placed towards
 
32
the top of the file. Rule patterns use exactly the same conventions
 
33
as ignore patterns. See ``bzr help patterns`` for details.
 
34
 
 
35
Note: Patterns containing square brackets should be surrounded in
 
36
quotes to ensure they are corrected parsed.