/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 breezy/plugins/bash_completion/README.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:
breezy/plugins/bash_completion/README.txt
2
2
 
3
3
  Copyright (C) 2010 Canonical Ltd
4
4
 
5
 
  This file is part of bzr-bash-completion
 
5
  This file is part of Breezy.
6
6
 
7
 
  bzr-bash-completion free software: you can redistribute it and/or
 
7
  Breezy is free software: you can redistribute it and/or
8
8
  modify it under the terms of the GNU General Public License as
9
9
  published by the Free Software Foundation, either version 2 of the
10
10
  License, or (at your option) any later version.
11
11
 
12
 
  bzr-bash-completion is distributed in the hope that it will be
 
12
  Breezy is distributed in the hope that it will be
13
13
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
14
14
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15
15
  General Public License for more details.
18
18
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
19
 
20
20
==========================
21
 
bzr bash-completion plugin
 
21
bash-completion plugin
22
22
==========================
23
23
 
24
24
This plugin generates a shell function which can be used by bash to
25
25
automatically complete the currently typed command when the user
26
26
presses the completion key (usually tab).
27
27
 
28
 
It is intended as a bzr plugin, but can be used to some extend as a
 
28
It is intended as a Breezy plugin, but can be used to some extend as a
29
29
standalone python script as well.
30
30
 
31
31
| Copyright (C) 2009, 2010 Canonical Ltd
36
36
Bundled and standalone versions
37
37
-------------------------------
38
38
 
39
 
This plugin has been merged_ into the main source tree of Bazaar.
40
 
Starting with the bzr 2.3 series, a common bzr installation will
 
39
This plugin has been merged_ into the main source tree of Breezy.
 
40
Starting with the brz 2.3 series, a common brz installation will
41
41
include this plugin.
42
42
 
43
 
There is still a standalone version available. It makes the plugin
44
 
available for users of older bzr versions. When using both versions,
45
 
local configuration might determine which version actually gets used,
46
 
and some installations might even overwrite one another, so don't use
47
 
the standalone version if you have the bundled one, unless you know
48
 
what you are doing. Some effort will be made to keep the two versions
49
 
reasonably in sync for some time yet.
50
 
 
51
 
This text here documents the bundled version.
52
 
 
53
 
.. _merged: http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev/revision/5240
54
 
 
55
43
-----
56
44
Using
57
45
-----
60
48
-----------------
61
49
 
62
50
This is the preferred method of generating the completion function, as
63
 
it will ensure proper bzr initialization.
 
51
it will ensure proper brz initialization.
64
52
 
65
53
::
66
54
 
67
 
  eval "`bzr bash-completion`"
 
55
  eval "`brz bash-completion`"
68
56
 
69
57
Lazy initialization
70
58
-------------------
74
62
To avoid this problem, you can delay the generation of the completion
75
63
function until you actually need it.
76
64
 
77
 
To do so, source the file ``contrib/bash/bzr`` shipped with the bzr
 
65
To do so, source the file ``contrib/bash/brz`` shipped with the brz
78
66
source distribution from your ``~/.bashrc`` file
79
67
or add it to your ``~/.bash_completion`` if
80
68
your setup uses such a file. On a system-wide installation, the
82
70
completion scripts.
83
71
 
84
72
Note that the full completion function is generated only once per
85
 
shell session. If you update your bzr installation or change the set
 
73
shell session. If you update your brz installation or change the set
86
74
of installed plugins, then you might wish to regenerate the completion
87
75
function manually as described above in order for completion to take
88
76
these changes into account.
94
82
The plugin is designed to generate a completion function
95
83
containing all the required information about the possible
96
84
completions. This is usually only done once when bash
97
 
initializes. After that, no more invocations of bzr are required. This
 
85
initializes. After that, no more invocations of brz are required. This
98
86
makes the function much faster than a possible implementation talking
99
 
to bzr for each and every completion. On the other hand, this has the
100
 
effect that updates to bzr or its plugins won't show up in the
 
87
to brz for each and every completion. On the other hand, this has the
 
88
effect that updates to brz or its plugins won't show up in the
101
89
completions immediately, but only after the completion function has
102
90
been regenerated.
103
91
 
106
94
-------
107
95
 
108
96
As this is built upon a bash completion script originally included in
109
 
the bzr source tree, and as the bzr sources are covered by the GPL 2,
 
97
the brz source tree, and as the brz sources are covered by the GPL 2,
110
98
this plugin here is licensed under these same terms.
111
99
 
112
100
If you require a more liberal license, you'll have to contact all
119
107
 
120
108
The plugin was created by Martin von Gagern in 2009, building on a
121
109
static completion function of very limited scope distributed together
122
 
with bzr.
 
110
with brz.
123
111
 
124
 
A version of it was merged into the bzr source tree in May 2010.
 
112
A version of it was merged into the brz source tree in May 2010.
125
113
 
126
114
----------
127
115
References