← 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: 2010-01-13 16:23:07 UTC
  • mto: (4634.119.7 2.0)
  • mto: This revision was merged to the branch mainline in revision 4959.
  • Revision ID: john@arbash-meinel.com-20100113162307-0bs82td16gzih827
Update the MANIFEST.in file.

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(s). For example::
 
10
 
 
11
    [name *.bat]
 
12
    eol = dos
 
13
 
 
14
    [name *.html *.xml]
 
15
    keywords = xml_escape
 
16
 
 
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).
 
21
 
 
22
Files
 
23
-----
 
24
 
 
25
Default rules for all branches are defined in the optional file
 
26
``BZR_HOME/rules``. 
 
27
 
 
28
Rule Patterns
 
29
-------------
 
30
 
 
31
Patterns are ordered and searching stops as soon as one matches.
 
32
As a consequence, more explicit patterns should be placed towards
 
33
the top of the file. Rule patterns use exactly the same conventions
 
34
as ignore patterns. See ``bzr help patterns`` for details.
 
35
 
 
36
Note: Patterns containing square brackets or spaces should be
 
37
surrounded in quotes to ensure they are correctly parsed.