← 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: mbp at sourcefrog
  • Date: 2005-03-09 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

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 :doc:`eol-help`.
20
 
Keyword support is provided by the `keywords plugin
21
 
<http://doc.bazaar.canonical.com/plugins/en/keywords-plugin.html>`_.
22
 
 
23
 
Files
24
 
-----
25
 
 
26
 
Default rules for all branches are defined in the optional file
27
 
``BZR_HOME/rules``. 
28
 
 
29
 
Rule Patterns
30
 
-------------
31
 
 
32
 
Patterns are ordered and searching stops as soon as one matches.
33
 
As a consequence, more explicit patterns should be placed towards
34
 
the top of the file. Rule patterns use exactly the same conventions
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.