/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-09-02 11:51:19 UTC
  • mto: (7490.40.109 work)
  • mto: This revision was merged to the branch mainline in revision 7526.
  • Revision ID: jelmer@jelmer.uk-20200902115119-otuspc349t9rmhua
add test for git file merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/bash_completion/README.txt
 
1
.. comment
 
2
 
 
3
  Copyright (C) 2010 Canonical Ltd
 
4
 
 
5
  This file is part of Breezy.
 
6
 
 
7
  Breezy is free software: you can redistribute it and/or
 
8
  modify it under the terms of the GNU General Public License as
 
9
  published by the Free Software Foundation, either version 2 of the
 
10
  License, or (at your option) any later version.
 
11
 
 
12
  Breezy is distributed in the hope that it will be
 
13
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 
14
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
15
  General Public License for more details.
 
16
 
 
17
  You should have received a copy of the GNU General Public License
 
18
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
19
 
 
20
==========================
 
21
bash-completion plugin
 
22
==========================
 
23
 
 
24
This plugin generates a shell function which can be used by bash to
 
25
automatically complete the currently typed command when the user
 
26
presses the completion key (usually tab).
 
27
 
 
28
It is intended as a Breezy plugin, but can be used to some extend as a
 
29
standalone python script as well.
 
30
 
 
31
| Copyright (C) 2009, 2010 Canonical Ltd
 
32
 
 
33
.. contents::
 
34
 
 
35
-------------------------------
 
36
Bundled and standalone versions
 
37
-------------------------------
 
38
 
 
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
include this plugin.
 
42
 
 
43
-----
 
44
Using
 
45
-----
 
46
 
 
47
Using as a plugin
 
48
-----------------
 
49
 
 
50
This is the preferred method of generating the completion function, as
 
51
it will ensure proper brz initialization.
 
52
 
 
53
::
 
54
 
 
55
  eval "`brz bash-completion`"
 
56
 
 
57
Lazy initialization
 
58
-------------------
 
59
 
 
60
Running the above command automatically from your ``~/.bashrc`` file
 
61
or similar can cause annoying delays in the startup of your shell.
 
62
To avoid this problem, you can delay the generation of the completion
 
63
function until you actually need it.
 
64
 
 
65
To do so, source the file ``contrib/bash/brz`` shipped with the brz
 
66
source distribution from your ``~/.bashrc`` file
 
67
or add it to your ``~/.bash_completion`` if
 
68
your setup uses such a file. On a system-wide installation, the
 
69
directory ``/usr/share/bash-completion/`` might contain such bash
 
70
completion scripts.
 
71
 
 
72
Note that the full completion function is generated only once per
 
73
shell session. If you update your brz installation or change the set
 
74
of installed plugins, then you might wish to regenerate the completion
 
75
function manually as described above in order for completion to take
 
76
these changes into account.
 
77
 
 
78
--------------
 
79
Design concept
 
80
--------------
 
81
 
 
82
The plugin is designed to generate a completion function
 
83
containing all the required information about the possible
 
84
completions. This is usually only done once when bash
 
85
initializes. After that, no more invocations of brz are required. This
 
86
makes the function much faster than a possible implementation talking
 
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
 
89
completions immediately, but only after the completion function has
 
90
been regenerated.
 
91
 
 
92
-------
 
93
License
 
94
-------
 
95
 
 
96
As this is built upon a bash completion script originally included in
 
97
the brz source tree, and as the brz sources are covered by the GPL 2,
 
98
this plugin here is licensed under these same terms.
 
99
 
 
100
If you require a more liberal license, you'll have to contact all
 
101
those who contributed code to this plugin, be it for bash or for
 
102
python.
 
103
 
 
104
-------
 
105
History
 
106
-------
 
107
 
 
108
The plugin was created by Martin von Gagern in 2009, building on a
 
109
static completion function of very limited scope distributed together
 
110
with brz.
 
111
 
 
112
A version of it was merged into the brz source tree in May 2010.
 
113
 
 
114
----------
 
115
References
 
116
----------
 
117
 
 
118
Breezy homepage
 
119
  | https://www.breezy-vcs.org/
 
120
 
 
121
 
 
122
 
 
123
.. vim: ft=rst
 
124
 
 
125
.. emacs
 
126
   Local Variables:
 
127
   mode: rst
 
128
   End: