/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/en/admin-guide/hooks-plugins.txt

  • Committer: Jelmer Vernooij
  • Date: 2020-08-22 22:46:24 UTC
  • mfrom: (7490.40.105 work)
  • mto: This revision was merged to the branch mainline in revision 7521.
  • Revision ID: jelmer@jelmer.uk-20200822224624-om4a4idsr7cn8jew
merge lp:brz/3.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/admin-guide/hooks-plugins.txt
8
8
specific tasks are specified by *hooks* that run during certain steps of the
9
9
version control process.  
10
10
 
11
 
For full documentation on the available hooks, see ``bzr help hooks``.  Among
 
11
For full documentation on the available hooks, see ``brz help hooks``.  Among
12
12
those, some of the most significant hooks from an administration
13
13
standpoint are `pre_commit`, `post_commit` and `post_change_branch_tip`.
14
14
A `pre_commit` hook can inspect a commit before it happens and cancel it if
24
24
Information on the whole range of Bazaar plugins is available at
25
25
http://doc.bazaar.canonical.com/plugins/en/.  For purposes of installation,
26
26
plugins are simply python packages.  They can be installed alongside Bazaar in
27
 
the ``bzrlib.plugins`` package using each plugin's ``setup.py``.  They can
28
 
also be installed in the plugin path which is the user's ``~/.bazaar/plugins``
29
 
directory or can be specified with the ``BZR_PLUGIN_PATH`` environment
30
 
variable.  See ``bzr help configuration`` for more on specifying the location
31
 
of plugins.
 
27
the ``breezy.plugins`` package using each plugin's ``setup.py``.  They can
 
28
also be installed in the plugin path which is the user's
 
29
``~/.config/breezy/plugins`` directory or can be specified with the
 
30
``BRZ_PLUGIN_PATH`` environment variable.  See ``brz help configuration`` for
 
31
more on specifying the location of plugins.
32
32
 
33
33
 
34
34
Email Notification
55
55
in the ``locations.conf`` file or individually in each branch's
56
56
``branch.conf`` file.  The sender's email address can be specified as
57
57
``post_commit_sender`` if it is different than the email address reported by
58
 
``bzr whoami``.  The ``post_commit_mailer`` option specifies how the
 
58
``brz whoami``.  The ``post_commit_mailer`` option specifies how the
59
59
mail should be sent.  If it isn't set, email is sent via ``/usr/bin/mail``.
60
60
It can also be configured to communicate directly with an SMTP server.
61
61
For more details on configuring this plugin, see
62
 
http://doc.bazaar-vcs.org/plugins/en/email-plugin.html.  As examples, consider
63
 
the following two possible configurations.  A minimal one (uses
 
62
http://doc.bazaar.canonical.com/plugins/en/email-plugin.html.  As examples,
 
63
consider the following two possible configurations.  A minimal one (uses
64
64
``/usr/bin/mail``)
65
65
 
66
66
::
96
96
 
97
97
::
98
98
 
99
 
  $ bzr_hookless_email.py --email=projectx-commits@example.com \
 
99
  $ brz_hookless_email.py --email=projectx-commits@example.com \
100
100
  --recurse /srv/bzr
101
101
 
102
102
email-notifier
143
143
 
144
144
::
145
145
 
146
 
  $ bzr-email-notifier.py --config=/srv/bzr/email-notifier.conf /srv/bzr/projectx
 
146
  $ brz-email-notifier.py --config=/srv/bzr/email-notifier.conf /srv/bzr/projectx
147
147
 
148
148
will watch all branches under the given directory for commits, branch
149
149
creations and branch deletions.
166
166
``branch.atom`` files.
167
167
 
168
168
In addition, there are other tools that are not plugins for creating news
169
 
feeds from Bazaar branches.  See http://bazaar-vcs.org/FeedGenerators for more
170
 
on those tools.
 
169
feeds from Bazaar branches.  See
 
170
http://wiki.bazaar.canonical.com/FeedGenerators for more on those tools.
171
171
 
172
172
Mirroring
173
173
---------
287
287
This plugin is a more advanced version of `checkeol` that can check such
288
288
coding style guidelines such as trailing whitespace, long lines and files that
289
289
don't end with a newline.  It is configured using Bazaar's built in rules
290
 
specification in ``BZR_HOME/rules`` (see ``bzr help rules`` for more
 
290
specification in ``BRZ_HOME/rules`` (see ``bzr help rules`` for more
291
291
information.  For different types of undesired changes, you can specify
292
292
different types of actions.  For example
293
293