← 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

  • Committer: John Arbash Meinel
  • Date: 2008-09-05 02:29:34 UTC
  • mto: (3697.7.4 1.7)
  • mto: This revision was merged to the branch mainline in revision 3748.
  • Revision ID: john@arbash-meinel.com-20080905022934-s8692mbwpkdwi106
Cleanups to the algorithm documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/rules.txt
6
6
 
7
7
Rules are defined in ini file format where the sections are file glob
8
8
patterns and the contents of each section are the preferences for files
9
 
matching that pattern(s). For example::
 
9
matching that pattern. For example::
10
10
 
11
11
    [name *.bat]
12
12
    eol = dos
13
13
 
14
 
    [name *.html *.xml]
15
 
    keywords = xml_escape
 
14
    [name *.html]
 
15
    keywords = escape
16
16
 
17
17
Preferences like these are useful for commands and plugins wishing to
18
 
provide custom behaviour for selected files.  For more information on 
19
 
end of line conversion see ``bzr help eol``.  Keyword support is provided
20
 
by the bzr-keywords plugin (http://launchpad.net/bzr-keywords).
 
18
provide custom behaviour for selected files in selected branches.
 
19
 
21
20
 
22
21
Files
23
22
-----
24
23
 
25
 
Default rules for all branches are defined in the optional file
26
 
``BZR_HOME/rules``. 
 
24
Branch-specific rules are defined in ``.bzrrules`` in the root of the
 
25
working tree. Default rules for all branches are defined in
 
26
``BZR_HOME/rules``. Either or both files may be missing. If a rule is
 
27
matched by a pattern in the branch level file, searching stops.
 
28
 
27
29
 
28
30
Rule Patterns
29
31
-------------
33
35
the top of the file. Rule patterns use exactly the same conventions
34
36
as ignore patterns. See ``bzr help patterns`` for details.
35
37
 
36
 
Note: Patterns containing square brackets or spaces should be
37
 
surrounded in quotes to ensure they are correctly parsed.
 
38
Note: Patterns containing square brackets should be surrounded in
 
39
quotes to ensure they are corrected parsed.