/breezy/unstable

To get this branch, use:
bzr branch https://code.breezy-vcs.org/breezy/unstable

« back to all changes in this revision

Viewing changes to doc/en/user-guide/controlling_registration.txt

  • Committer: Jelmer Vernooij
  • Date: 2017-05-24 01:39:33 UTC
  • mfrom: (3815.3776.6)
  • Revision ID: jelmer@jelmer.uk-20170524013933-ir4y4tqtrsiz2ka2
New upstream snapshot.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
Controlling file registration
2
2
=============================
3
3
 
4
 
What does Bazaar track?
 
4
What does Breezy track?
5
5
-----------------------
6
6
 
7
 
As explained earlier, ``bzr add`` finds and registers all the things in
8
 
and under the current directory that Bazaar thinks ought to be
 
7
As explained earlier, ``brz add`` finds and registers all the things in
 
8
and under the current directory that Breezy thinks ought to be
9
9
version controlled. These things may be:
10
10
 
11
11
 * files
12
12
 * directories
13
13
 * symbolic links.
14
14
 
15
 
Bazaar has default rules for deciding which files are
 
15
Breezy has default rules for deciding which files are
16
16
interesting and which ones are not. You can tune those rules as
17
17
explained in `Ignoring files`_ below.
18
18
 
19
 
Unlike many other VCS tools, Bazaar tracks directories as first class
 
19
Unlike many other VCS tools, Breezy tracks directories as first class
20
20
items. As a consequence, empty directories are correctly supported -
21
21
you don't need to create a dummy file inside a directory just to
22
22
ensure it gets tracked and included in project exports.
25
25
not the content of the thing the symbolic link is pointing to.
26
26
 
27
27
Note: Support for tracking projects-within-projects ("nested trees")
28
 
is currently under development. Please contact the Bazaar developers
 
28
is currently under development. Please contact the Breezy developers
29
29
if you are interested in helping develop or test this functionality.
30
30
 
31
31
Selective registration
32
32
----------------------
33
33
 
34
34
In some cases, you may want or need to explicitly nominate the things
35
 
to register rather than leave it up to Bazaar to find things. To do this,
 
35
to register rather than leave it up to Breezy to find things. To do this,
36
36
simply provide paths as arguments to the ``add`` command like this::
37
37
 
38
 
  bzr add fileX dirY/
 
38
  brz add fileX dirY/
39
39
 
40
40
Adding a directory implicitly adds all interesting things
41
41
underneath it.
46
46
Many source trees contain some files that do not need to be versioned,
47
47
such as editor backups, object or bytecode files, and built programs.  You
48
48
can simply not add them, but then they'll always crop up as unknown files.
49
 
You can also tell Bazaar to ignore these files by adding them to a file
 
49
You can also tell Breezy to ignore these files by adding them to a file
50
50
called ``.bzrignore`` at the top of the tree.
51
51
 
52
52
This file contains a list of file wildcards (or "globs"), one per line.
67
67
    doc/*.html
68
68
 
69
69
To get a list of which files are ignored and what pattern they matched,
70
 
use ``bzr ignored``::
 
70
use ``brz ignored``::
71
71
 
72
 
    % bzr ignored
 
72
    % brz ignored
73
73
    config.h                 ./config.h
74
74
    configure.in~            *~
75
75
 
81
81
The ``.bzrignore`` file should normally be versioned, so that new copies
82
82
of the branch see the same patterns::
83
83
 
84
 
    % bzr add .bzrignore
85
 
    % bzr commit -m "Add ignore patterns"
 
84
    % brz add .bzrignore
 
85
    % brz commit -m "Add ignore patterns"
86
86
 
87
 
The command ``bzr ignore PATTERN`` can be used to easily add PATTERN to
 
87
The command ``brz ignore PATTERN`` can be used to easily add PATTERN to
88
88
the ``.bzrignore file`` (creating it if necessary and registering it to
89
 
be tracked by Bazaar).  Removing and modifying patterns are done by
 
89
be tracked by Breezy).  Removing and modifying patterns are done by
90
90
directly editing the ``.bzrignore`` file.
91
91
 
92
92
Global ignores
94
94
 
95
95
There are some ignored files which are not project specific, but more user
96
96
specific. Things like editor temporary files, or personal temporary files.
97
 
Rather than add these ignores to every project, bzr supports a global
 
97
Rather than add these ignores to every project, brz supports a global
98
98
ignore file in ``~/.bazaar/ignore`` [#]_. It has the same syntax as the
99
99
per-project ignore file.
100
100
 
101
101
.. [#] On Windows, the users configuration files can be found in the
102
102
   application data directory. So instead of ``~/.bazaar/branch.conf``
103
103
   the configuration file can be found as:
104
 
   ``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
 
104
   ``C:\Documents and Settings\<username>\Application Data\Breezy\2.0\branch.conf``.
105
105
   The same is true for ``locations.conf``, ``ignore``, and the
106
106
   ``plugins`` directory.