← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Ian Clatworthy
  • Date: 2007-12-13 03:07:45 UTC
  • mto: (3105.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3106.
  • Revision ID: ian.clatworthy@internode.on.net-20071213030745-qhw4i0g5nbspx0ws
fix some broken links and make doc more Windows user friendly

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/plugins.txt
34
34
-----------------------
35
35
 
36
36
Installing a plugin is very easy! If not already created, create a
37
 
``plugins`` directory under your Bazaar configuration directory
38
 
($BZR_HOME), i.e. ``~/.bazaar/`` on Linux and
 
37
``plugins`` directory under your Bazaar configuration directory,
 
38
``~/.bazaar/`` on Linux and
39
39
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\``
40
 
on Windows. Within this directory, each plugin is placed in its own
41
 
subdirectory.
 
40
on Windows. Within this directory (referred to as $BZR_HOME below),
 
41
each plugin is placed in its own subdirectory.
42
42
 
43
43
Plugins work particularly well with Bazaar branches. For example, to
44
44
install the bzrtools plugins for your main user account on Linux,
47
47
    bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
48
48
    ~/.bazaar/plugins/bzrtools
49
49
 
50
 
When installing plugins the directories that you install them in must
 
50
When installing plugins, the directories that you install them in must
51
51
be valid python identifiers. This means that they can only contain
52
52
certain characters, notably they cannot contain hyphens (``-``). Rather
53
 
than installing ``bzr-gtk`` to ``~/.bazaar/plugins/bzr-gtk``, install it
54
 
to ``~/.bazaar/plugins/gtk``.
 
53
than installing ``bzr-gtk`` to ``$BZR_HOME/plugins/bzr-gtk``, install it
 
54
to ``$BZR_HOME/plugins/gtk``.
55
55
 
56
56
Alternative plugin locations
57
57
----------------------------