Merge lp:~ian-clatworthy/bzr/user-ref-topics into lp:bzr
- user-ref-topics
- Merge into bzr.dev
Proposed by
Ian Clatworthy
Status: | Merged |
---|---|
Approved by: | Martin Pool |
Approved revision: | not available |
Merged at revision: | not available |
Proposed branch: | lp:~ian-clatworthy/bzr/user-ref-topics |
Merge into: | lp:bzr |
Diff against target: |
542 lines (+125/-94) 15 files modified
NEWS (+8/-1) bzrlib/bugtracker.py (+19/-16) bzrlib/bzrdir.py (+2/-2) bzrlib/commands.py (+3/-2) bzrlib/conflicts.py (+1/-1) bzrlib/doc_generate/autodoc_rstx.py (+44/-32) bzrlib/help_topics/__init__.py (+24/-19) bzrlib/help_topics/en/authentication.txt (+2/-4) bzrlib/help_topics/en/configuration.txt (+1/-1) bzrlib/help_topics/en/conflict-types.txt (+2/-2) bzrlib/help_topics/en/content-filters.txt (+2/-2) bzrlib/help_topics/en/log-formats.txt (+1/-1) bzrlib/help_topics/en/rules.txt (+9/-6) bzrlib/hooks.py (+1/-1) doc/en/user-guide/hooks.txt (+6/-4) |
To merge this branch: | bzr merge lp:~ian-clatworthy/bzr/user-ref-topics |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Martin Pool | Needs Fixing | ||
Review via email:
|
Commit message
Description of the change
To post a comment you must log in.
Revision history for this message
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Ian Clatworthy (ian-clatworthy) wrote : | # |
Revision history for this message
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Martin Pool (mbp) wrote : | # |
The change of 'conflicts' name is good but should be in NEWS; perhaps the reformatting should be too.
Thanks
review:
Needs Fixing
Revision history for this message
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Ian Clatworthy (ian-clatworthy) wrote : | # |
> The change of 'conflicts' name is good but should be in NEWS; perhaps the
> reformatting should be too.
Done.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file 'NEWS' | |||
2 | --- NEWS 2010-01-04 05:40:01 +0000 | |||
3 | +++ NEWS 2010-01-04 08:49:20 +0000 | |||
4 | @@ -79,7 +79,14 @@ | |||
5 | 79 | 79 | ||
6 | 80 | * There is a System Administrator's Guide in ``doc/en/admin-guide``, | 80 | * There is a System Administrator's Guide in ``doc/en/admin-guide``, |
7 | 81 | including discussions of installation, relevant plugins, security and | 81 | including discussions of installation, relevant plugins, security and |
9 | 82 | backup. | 82 | backup. (Neil Martinsen-Burrell) |
10 | 83 | |||
11 | 84 | * The ``conflicts`` help topic has been renamed to ``conflict-types``. | ||
12 | 85 | (Ian Clatworthy) | ||
13 | 86 | |||
14 | 87 | * The User Reference is now presented as a series of topics. | ||
15 | 88 | Many of the included topics have link and format tweaks applied. | ||
16 | 89 | (Ian Clatworthy) | ||
17 | 83 | 90 | ||
18 | 84 | API Changes | 91 | API Changes |
19 | 85 | *********** | 92 | *********** |
20 | 86 | 93 | ||
21 | === modified file 'bzrlib/bugtracker.py' | |||
22 | --- bzrlib/bugtracker.py 2009-06-10 03:31:01 +0000 | |||
23 | +++ bzrlib/bugtracker.py 2010-01-04 08:49:20 +0000 | |||
24 | @@ -39,12 +39,12 @@ | |||
25 | 39 | 39 | ||
26 | 40 | _bugs_help = \ | 40 | _bugs_help = \ |
27 | 41 | """When making a commit, metadata about bugs fixed by that change can be | 41 | """When making a commit, metadata about bugs fixed by that change can be |
29 | 42 | recorded by using the --fixes option. For each bug marked as fixed, an | 42 | recorded by using the ``--fixes`` option. For each bug marked as fixed, an |
30 | 43 | entry is included in the 'bugs' revision property stating '<url> <status>'. | 43 | entry is included in the 'bugs' revision property stating '<url> <status>'. |
31 | 44 | (The only ``status`` value currently supported is ``fixed.``) | 44 | (The only ``status`` value currently supported is ``fixed.``) |
32 | 45 | 45 | ||
35 | 46 | The --fixes option allows you to specify a bug tracker and a bug identifier | 46 | The ``--fixes`` option allows you to specify a bug tracker and a bug identifier |
36 | 47 | rather than a full URL. This looks like | 47 | rather than a full URL. This looks like:: |
37 | 48 | 48 | ||
38 | 49 | bzr commit --fixes <tracker>:<id> | 49 | bzr commit --fixes <tracker>:<id> |
39 | 50 | 50 | ||
40 | @@ -56,10 +56,13 @@ | |||
41 | 56 | use this feature, you just need to know the tracker identifier to use. | 56 | use this feature, you just need to know the tracker identifier to use. |
42 | 57 | These are the bugtrackers that are built in: | 57 | These are the bugtrackers that are built in: |
43 | 58 | 58 | ||
48 | 59 | URL | Abbreviation | Example | 59 | ============================ ============ ============ |
49 | 60 | https://bugs.launchpad.net/ | lp | lp:12345 | 60 | URL Abbreviation Example |
50 | 61 | http://bugs.debian.org/ | deb | deb:12345 | 61 | ============================ ============ ============ |
51 | 62 | http://bugzilla.gnome.org/ | gnome | gnome:12345 | 62 | https://bugs.launchpad.net/ lp lp:12345 |
52 | 63 | http://bugs.debian.org/ deb deb:12345 | ||
53 | 64 | http://bugzilla.gnome.org/ gnome gnome:12345 | ||
54 | 65 | ============================ ============ ============ | ||
55 | 63 | 66 | ||
56 | 64 | For the bug trackers not listed above configuration is required. | 67 | For the bug trackers not listed above configuration is required. |
57 | 65 | Support for generating the URLs for any project using Bugzilla or Trac | 68 | Support for generating the URLs for any project using Bugzilla or Trac |
58 | @@ -82,11 +85,11 @@ | |||
59 | 82 | 85 | ||
60 | 83 | Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2. | 86 | Use ``bzr commit --fixes lp:2`` to record that this commit fixes bug 2. |
61 | 84 | 87 | ||
64 | 85 | bugzilla_<tracker_abbreviation>_url | 88 | bugzilla_<tracker>_url |
65 | 86 | ----------------------------------- | 89 | ---------------------- |
66 | 87 | 90 | ||
67 | 88 | If present, the location of the Bugzilla bug tracker referred to by | 91 | If present, the location of the Bugzilla bug tracker referred to by |
69 | 89 | <tracker_abbreviation>. This option can then be used together with ``bzr commit | 92 | <tracker>. This option can then be used together with ``bzr commit |
70 | 90 | --fixes`` to mark bugs in that tracker as being fixed by that commit. For | 93 | --fixes`` to mark bugs in that tracker as being fixed by that commit. For |
71 | 91 | example:: | 94 | example:: |
72 | 92 | 95 | ||
73 | @@ -95,11 +98,11 @@ | |||
74 | 95 | would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as | 98 | would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as |
75 | 96 | fixed. | 99 | fixed. |
76 | 97 | 100 | ||
79 | 98 | trac_<tracker_abbrevation>_url | 101 | trac_<tracker>_url |
80 | 99 | ------------------------------ | 102 | ------------------ |
81 | 100 | 103 | ||
82 | 101 | If present, the location of the Trac instance referred to by | 104 | If present, the location of the Trac instance referred to by |
84 | 102 | <tracker_abbreviation>. This option can then be used together with ``bzr commit | 105 | <tracker>. This option can then be used together with ``bzr commit |
85 | 103 | --fixes`` to mark bugs in that tracker as being fixed by that commit. For | 106 | --fixes`` to mark bugs in that tracker as being fixed by that commit. For |
86 | 104 | example:: | 107 | example:: |
87 | 105 | 108 | ||
88 | @@ -108,11 +111,11 @@ | |||
89 | 108 | would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as | 111 | would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as |
90 | 109 | fixed. | 112 | fixed. |
91 | 110 | 113 | ||
94 | 111 | bugtracker_<tracker_abbrevation>_url | 114 | bugtracker_<tracker>_url |
95 | 112 | ------------------------------------ | 115 | ------------------------ |
96 | 113 | 116 | ||
97 | 114 | If present, the location of a generic bug tracker instance referred to by | 117 | If present, the location of a generic bug tracker instance referred to by |
99 | 115 | <tracker_abbreviation>. The location must contain an ``{id}`` placeholder, | 118 | <tracker>. The location must contain an ``{id}`` placeholder, |
100 | 116 | which will be replaced by a specific bug ID. This option can then be used | 119 | which will be replaced by a specific bug ID. This option can then be used |
101 | 117 | together with ``bzr commit --fixes`` to mark bugs in that tracker as being | 120 | together with ``bzr commit --fixes`` to mark bugs in that tracker as being |
102 | 118 | fixed by that commit. For example:: | 121 | fixed by that commit. For example:: |
103 | 119 | 122 | ||
104 | === modified file 'bzrlib/bzrdir.py' | |||
105 | --- bzrlib/bzrdir.py 2009-12-02 17:56:06 +0000 | |||
106 | +++ bzrlib/bzrdir.py 2010-01-04 08:49:20 +0000 | |||
107 | @@ -3513,7 +3513,7 @@ | |||
108 | 3513 | experimental_pairs.append((key, help)) | 3513 | experimental_pairs.append((key, help)) |
109 | 3514 | else: | 3514 | else: |
110 | 3515 | output += wrapped(key, help, info) | 3515 | output += wrapped(key, help, info) |
112 | 3516 | output += "\nSee ``bzr help formats`` for more about storage formats." | 3516 | output += "\nSee :doc:`formats-help` for more about storage formats." |
113 | 3517 | other_output = "" | 3517 | other_output = "" |
114 | 3518 | if len(experimental_pairs) > 0: | 3518 | if len(experimental_pairs) > 0: |
115 | 3519 | other_output += "Experimental formats are shown below.\n\n" | 3519 | other_output += "Experimental formats are shown below.\n\n" |
116 | @@ -3532,7 +3532,7 @@ | |||
117 | 3532 | other_output += \ | 3532 | other_output += \ |
118 | 3533 | "\nNo deprecated formats are available.\n\n" | 3533 | "\nNo deprecated formats are available.\n\n" |
119 | 3534 | other_output += \ | 3534 | other_output += \ |
121 | 3535 | "\nSee ``bzr help formats`` for more about storage formats." | 3535 | "\nSee :doc:`formats-help` for more about storage formats." |
122 | 3536 | 3536 | ||
123 | 3537 | if topic == 'other-formats': | 3537 | if topic == 'other-formats': |
124 | 3538 | return other_output | 3538 | return other_output |
125 | 3539 | 3539 | ||
126 | === modified file 'bzrlib/commands.py' | |||
127 | --- bzrlib/commands.py 2009-12-09 05:47:32 +0000 | |||
128 | +++ bzrlib/commands.py 2010-01-04 08:49:20 +0000 | |||
129 | @@ -511,8 +511,9 @@ | |||
130 | 511 | # so don't create a real link | 511 | # so don't create a real link |
131 | 512 | see_also_links.append(item) | 512 | see_also_links.append(item) |
132 | 513 | else: | 513 | else: |
135 | 514 | # Use a reST link for this entry | 514 | # Use a Sphinx link for this entry |
136 | 515 | see_also_links.append("`%s`_" % (item,)) | 515 | link_text = ":doc:`%s <%s-help>`" % (item, item) |
137 | 516 | see_also_links.append(link_text) | ||
138 | 516 | see_also = see_also_links | 517 | see_also = see_also_links |
139 | 517 | result += ':See also: ' | 518 | result += ':See also: ' |
140 | 518 | result += ', '.join(see_also) + '\n' | 519 | result += ', '.join(see_also) + '\n' |
141 | 519 | 520 | ||
142 | === modified file 'bzrlib/conflicts.py' | |||
143 | --- bzrlib/conflicts.py 2009-11-23 03:15:33 +0000 | |||
144 | +++ bzrlib/conflicts.py 2010-01-04 08:49:20 +0000 | |||
145 | @@ -58,7 +58,7 @@ | |||
146 | 58 | Option('text', | 58 | Option('text', |
147 | 59 | help='List paths of files with text conflicts.'), | 59 | help='List paths of files with text conflicts.'), |
148 | 60 | ] | 60 | ] |
150 | 61 | _see_also = ['resolve'] | 61 | _see_also = ['resolve', 'conflict-types'] |
151 | 62 | 62 | ||
152 | 63 | def run(self, text=False): | 63 | def run(self, text=False): |
153 | 64 | from bzrlib.workingtree import WorkingTree | 64 | from bzrlib.workingtree import WorkingTree |
154 | 65 | 65 | ||
155 | === modified file 'bzrlib/doc_generate/autodoc_rstx.py' | |||
156 | --- bzrlib/doc_generate/autodoc_rstx.py 2009-09-09 14:35:26 +0000 | |||
157 | +++ bzrlib/doc_generate/autodoc_rstx.py 2010-01-04 08:49:20 +0000 | |||
158 | @@ -14,7 +14,7 @@ | |||
159 | 14 | # along with this program; if not, write to the Free Software | 14 | # along with this program; if not, write to the Free Software |
160 | 15 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | 15 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
161 | 16 | 16 | ||
163 | 17 | """Generate ReStructuredText source for the User Reference Manual. | 17 | """Generate reStructuredText source for the User Reference Manual. |
164 | 18 | Loosely based on the manpage generator autodoc_man.py. | 18 | Loosely based on the manpage generator autodoc_man.py. |
165 | 19 | 19 | ||
166 | 20 | Written by the Bazaar community. | 20 | Written by the Bazaar community. |
167 | @@ -36,7 +36,7 @@ | |||
168 | 36 | # ought to be prefixed with their section name as well so | 36 | # ought to be prefixed with their section name as well so |
169 | 37 | # there's zero risk of clashing with a standard sphinx | 37 | # there's zero risk of clashing with a standard sphinx |
170 | 38 | # topic (like search.html). | 38 | # topic (like search.html). |
172 | 39 | FILE_PER_TOPIC = False | 39 | FILE_PER_TOPIC = True |
173 | 40 | 40 | ||
174 | 41 | 41 | ||
175 | 42 | def get_filename(options): | 42 | def get_filename(options): |
176 | @@ -74,8 +74,7 @@ | |||
177 | 74 | output_dir=topic_dir)) | 74 | output_dir=topic_dir)) |
178 | 75 | result.append(_get_section(registry, SECT_LIST, "Lists", | 75 | result.append(_get_section(registry, SECT_LIST, "Lists", |
179 | 76 | output_dir=topic_dir)) | 76 | output_dir=topic_dir)) |
182 | 77 | result.append(_get_commands_section(registry)) | 77 | result.append(_get_commands_section(registry, output_dir=topic_dir)) |
181 | 78 | #result.append(_get_section(registry, SECT_PLUGIN, "Standard Plug-ins")) | ||
183 | 79 | return "\n".join(result) | 78 | return "\n".join(result) |
184 | 80 | 79 | ||
185 | 81 | 80 | ||
186 | @@ -86,8 +85,9 @@ | |||
187 | 86 | If output_dir is not None, topics are dumped into text files there | 85 | If output_dir is not None, topics are dumped into text files there |
188 | 87 | during processing, as well as being included in the return result. | 86 | during processing, as well as being included in the return result. |
189 | 88 | """ | 87 | """ |
190 | 89 | topics = sorted(registry.get_topics_for_section(section)) | ||
191 | 90 | lines = [title, hdg_level1 * len(title), ""] | 88 | lines = [title, hdg_level1 * len(title), ""] |
192 | 89 | if FILE_PER_TOPIC: | ||
193 | 90 | lines.extend([".. toctree::", " :maxdepth: 1", ""]) | ||
194 | 91 | 91 | ||
195 | 92 | # docutils treats section heading as implicit link target. | 92 | # docutils treats section heading as implicit link target. |
196 | 93 | # But in some cases topic and heading are different, e.g.: | 93 | # But in some cases topic and heading are different, e.g.: |
197 | @@ -102,56 +102,68 @@ | |||
198 | 102 | # .. _topic: `heading`_ | 102 | # .. _topic: `heading`_ |
199 | 103 | links_glue = [] | 103 | links_glue = [] |
200 | 104 | 104 | ||
201 | 105 | topics = sorted(registry.get_topics_for_section(section)) | ||
202 | 105 | for topic in topics: | 106 | for topic in topics: |
203 | 106 | help = registry.get_detail(topic) | 107 | help = registry.get_detail(topic) |
206 | 107 | heading,text = help.split("\n", 1) | 108 | heading, text = help.split("\n", 1) |
205 | 108 | lines.append(heading) | ||
207 | 109 | if not text.startswith(hdg_level2): | 109 | if not text.startswith(hdg_level2): |
211 | 110 | lines.append(hdg_level2 * len(heading)) | 110 | underline = hdg_level2 * len(heading) |
212 | 111 | lines.append(text) | 111 | help = "%s\n%s\n\n%s\n\n" % (heading, underline, text) |
213 | 112 | lines.append('') | 112 | else: |
214 | 113 | help = "%s\n%s\n\n" % (heading, text) | ||
215 | 114 | if FILE_PER_TOPIC: | ||
216 | 115 | topic_id = _dump_text(output_dir, topic, help) | ||
217 | 116 | lines.append(" %s" % topic_id) | ||
218 | 117 | else: | ||
219 | 118 | lines.append(help) | ||
220 | 119 | |||
221 | 113 | # check that topic match heading | 120 | # check that topic match heading |
222 | 114 | if topic != heading.lower(): | 121 | if topic != heading.lower(): |
223 | 115 | links_glue.append((topic, heading)) | 122 | links_glue.append((topic, heading)) |
224 | 116 | # dump the text if requested | ||
225 | 117 | if output_dir is not None: | ||
226 | 118 | out_file = bzrlib.osutils.pathjoin(output_dir, topic + ".txt") | ||
227 | 119 | _dump_text(out_file, help) | ||
228 | 120 | 123 | ||
229 | 121 | # provide links glue for topics that don't match headings | 124 | # provide links glue for topics that don't match headings |
232 | 122 | lines.extend([".. _%s: `%s`_" % i for i in links_glue]) | 125 | #lines.append('') |
233 | 123 | lines.append('') | 126 | #lines.extend([".. _%s: `%s`_" % i for i in links_glue]) |
234 | 127 | #lines.append('') | ||
235 | 124 | 128 | ||
236 | 125 | return "\n" + "\n".join(lines) + "\n" | 129 | return "\n" + "\n".join(lines) + "\n" |
237 | 126 | 130 | ||
238 | 127 | 131 | ||
239 | 128 | def _dump_text(filename, text): | ||
240 | 129 | """Dump text to filename.""" | ||
241 | 130 | if not FILE_PER_TOPIC: | ||
242 | 131 | return | ||
243 | 132 | f = open(filename, "w") | ||
244 | 133 | f.writelines(text) | ||
245 | 134 | f.close() | ||
246 | 135 | |||
247 | 136 | |||
248 | 137 | def _get_commands_section(registry, title="Commands", hdg_level1="#", | 132 | def _get_commands_section(registry, title="Commands", hdg_level1="#", |
250 | 138 | hdg_level2="="): | 133 | hdg_level2="=", output_dir=None): |
251 | 139 | """Build the commands reference section of the manual.""" | 134 | """Build the commands reference section of the manual.""" |
252 | 140 | lines = [title, hdg_level1 * len(title), ""] | 135 | lines = [title, hdg_level1 * len(title), ""] |
253 | 136 | if FILE_PER_TOPIC: | ||
254 | 137 | lines.extend([".. toctree::", " :maxdepth: 1", ""]) | ||
255 | 138 | |||
256 | 141 | cmds = sorted(bzrlib.commands.builtin_command_names()) | 139 | cmds = sorted(bzrlib.commands.builtin_command_names()) |
257 | 142 | for cmd_name in cmds: | 140 | for cmd_name in cmds: |
258 | 143 | cmd_object = bzrlib.commands.get_cmd_object(cmd_name) | 141 | cmd_object = bzrlib.commands.get_cmd_object(cmd_name) |
259 | 144 | if cmd_object.hidden: | 142 | if cmd_object.hidden: |
260 | 145 | continue | 143 | continue |
261 | 146 | heading = cmd_name | 144 | heading = cmd_name |
262 | 145 | underline = hdg_level2 * len(heading) | ||
263 | 147 | text = cmd_object.get_help_text(plain=False, see_also_as_links=True) | 146 | text = cmd_object.get_help_text(plain=False, see_also_as_links=True) |
268 | 148 | lines.append(heading) | 147 | help = "%s\n%s\n\n%s\n\n" % (heading, underline, text) |
269 | 149 | lines.append(hdg_level2 * len(heading)) | 148 | if FILE_PER_TOPIC: |
270 | 150 | lines.append(text) | 149 | topic_id = _dump_text(output_dir, cmd_name, help) |
271 | 151 | lines.append('') | 150 | lines.append(" %s" % topic_id) |
272 | 151 | else: | ||
273 | 152 | lines.append(help) | ||
274 | 153 | |||
275 | 152 | return "\n" + "\n".join(lines) + "\n" | 154 | return "\n" + "\n".join(lines) + "\n" |
276 | 153 | 155 | ||
277 | 154 | 156 | ||
278 | 157 | def _dump_text(output_dir, topic, text): | ||
279 | 158 | """Dump text for a topic to a file.""" | ||
280 | 159 | topic_id = "%s-%s" % (topic, "help") | ||
281 | 160 | filename = bzrlib.osutils.pathjoin(output_dir, topic_id + ".txt") | ||
282 | 161 | f = open(filename, "w") | ||
283 | 162 | f.writelines(text) | ||
284 | 163 | f.close() | ||
285 | 164 | return topic_id | ||
286 | 165 | |||
287 | 166 | |||
288 | 155 | ## | 167 | ## |
289 | 156 | # TEMPLATES | 168 | # TEMPLATES |
290 | 157 | 169 | ||
291 | @@ -194,8 +206,8 @@ | |||
292 | 194 | 206 | ||
293 | 195 | The following web sites provide further information on Bazaar: | 207 | The following web sites provide further information on Bazaar: |
294 | 196 | 208 | ||
297 | 197 | :Home page: http://www.bazaar-vcs.org/ | 209 | :Home page: http://bazaar.canonical.com/ |
298 | 198 | :Official docs: http://doc.bazaar-vcs.org/ | 210 | :Official docs: http://doc.bazaar.canonical.com/ |
299 | 199 | :Launchpad: https://launchpad.net/bzr/ | 211 | :Launchpad: https://launchpad.net/bzr/ |
300 | 200 | """ | 212 | """ |
301 | 201 | 213 | ||
302 | 202 | 214 | ||
303 | === modified file 'bzrlib/help_topics/__init__.py' | |||
304 | --- bzrlib/help_topics/__init__.py 2009-12-07 18:50:45 +0000 | |||
305 | +++ bzrlib/help_topics/__init__.py 2010-01-04 08:49:20 +0000 | |||
306 | @@ -306,7 +306,7 @@ | |||
307 | 306 | """Global Options | 306 | """Global Options |
308 | 307 | 307 | ||
309 | 308 | These options may be used with any command, and may appear in front of any | 308 | These options may be used with any command, and may appear in front of any |
311 | 309 | command. (e.g. "bzr --profile help"). | 309 | command. (e.g. ``bzr --profile help``). |
312 | 310 | 310 | ||
313 | 311 | --version Print the version number. Must be supplied before the command. | 311 | --version Print the version number. Must be supplied before the command. |
314 | 312 | --no-aliases Do not process command aliases when running this command. | 312 | --no-aliases Do not process command aliases when running this command. |
315 | @@ -325,9 +325,11 @@ | |||
316 | 325 | will be a pickle. | 325 | will be a pickle. |
317 | 326 | --coverage Generate line coverage report in the specified directory. | 326 | --coverage Generate line coverage report in the specified directory. |
318 | 327 | 327 | ||
320 | 328 | See doc/developers/profiling.txt for more information on profiling. | 328 | See http://doc.bazaar.canonical.com/developers/profiling.html for more |
321 | 329 | information on profiling. | ||
322 | 330 | |||
323 | 329 | A number of debug flags are also available to assist troubleshooting and | 331 | A number of debug flags are also available to assist troubleshooting and |
325 | 330 | development. See `bzr help debug-flags`. | 332 | development. See :doc:`debug-flags-help`. |
326 | 331 | """ | 333 | """ |
327 | 332 | 334 | ||
328 | 333 | _standard_options = \ | 335 | _standard_options = \ |
329 | @@ -647,7 +649,7 @@ | |||
330 | 647 | differences. | 649 | differences. |
331 | 648 | """ | 650 | """ |
332 | 649 | 651 | ||
334 | 650 | _branches_out_of_sync = """Branches out of sync | 652 | _branches_out_of_sync = """Branches Out of Sync |
335 | 651 | 653 | ||
336 | 652 | When reconfiguring a checkout, tree or branch into a lightweight checkout, | 654 | When reconfiguring a checkout, tree or branch into a lightweight checkout, |
337 | 653 | a local branch must be destroyed. (For checkouts, this is the local branch | 655 | a local branch must be destroyed. (For checkouts, this is the local branch |
338 | @@ -682,18 +684,20 @@ | |||
339 | 682 | project owner to upgrade. | 684 | project owner to upgrade. |
340 | 683 | 685 | ||
341 | 684 | 686 | ||
354 | 685 | Note: Some of the older formats have two variants: | 687 | .. note:: |
355 | 686 | a plain one and a rich-root one. The latter include an additional | 688 | |
356 | 687 | field about the root of the tree. There is no performance cost | 689 | Some of the older formats have two variants: |
357 | 688 | for using a rich-root format but you cannot easily merge changes | 690 | a plain one and a rich-root one. The latter include an additional |
358 | 689 | from a rich-root format into a plain format. As a consequence, | 691 | field about the root of the tree. There is no performance cost |
359 | 690 | moving a project to a rich-root format takes some co-ordination | 692 | for using a rich-root format but you cannot easily merge changes |
360 | 691 | in that all contributors need to upgrade their repositories | 693 | from a rich-root format into a plain format. As a consequence, |
361 | 692 | around the same time. 2a and all future formats will be | 694 | moving a project to a rich-root format takes some co-ordination |
362 | 693 | implicitly rich-root. | 695 | in that all contributors need to upgrade their repositories |
363 | 694 | 696 | around the same time. 2a and all future formats will be | |
364 | 695 | See ``bzr help current-formats`` for the complete list of | 697 | implicitly rich-root. |
365 | 696 | currently supported formats. See ``bzr help other-formats`` for | 698 | |
366 | 699 | See :doc:`current-formats-help` for the complete list of | ||
367 | 700 | currently supported formats. See :doc:`other-formats-help` for | ||
368 | 697 | descriptions of any available experimental and deprecated formats. | 701 | descriptions of any available experimental and deprecated formats. |
369 | 698 | """ | 702 | """ |
370 | 699 | 703 | ||
371 | @@ -742,14 +746,12 @@ | |||
372 | 742 | 'Information on configuring authentication') | 746 | 'Information on configuring authentication') |
373 | 743 | topic_registry.register('configuration', _load_from_file, | 747 | topic_registry.register('configuration', _load_from_file, |
374 | 744 | 'Details on the configuration settings available') | 748 | 'Details on the configuration settings available') |
376 | 745 | topic_registry.register('conflicts', _load_from_file, | 749 | topic_registry.register('conflict-types', _load_from_file, |
377 | 746 | 'Types of conflicts and what to do about them') | 750 | 'Types of conflicts and what to do about them') |
378 | 747 | topic_registry.register('debug-flags', _load_from_file, | 751 | topic_registry.register('debug-flags', _load_from_file, |
379 | 748 | 'Options to show or record debug information') | 752 | 'Options to show or record debug information') |
380 | 749 | topic_registry.register('log-formats', _load_from_file, | 753 | topic_registry.register('log-formats', _load_from_file, |
381 | 750 | 'Details on the logging formats available') | 754 | 'Details on the logging formats available') |
382 | 751 | topic_registry.register('diverged-branches', _load_from_file, | ||
383 | 752 | 'How to fix diverged branches') | ||
384 | 753 | 755 | ||
385 | 754 | 756 | ||
386 | 755 | # Register concept topics. | 757 | # Register concept topics. |
387 | @@ -763,6 +765,9 @@ | |||
388 | 763 | topic_registry.register('content-filters', _load_from_file, | 765 | topic_registry.register('content-filters', _load_from_file, |
389 | 764 | 'Conversion of content into/from working trees', | 766 | 'Conversion of content into/from working trees', |
390 | 765 | SECT_CONCEPT) | 767 | SECT_CONCEPT) |
391 | 768 | topic_registry.register('diverged-branches', _load_from_file, | ||
392 | 769 | 'How to fix diverged branches', | ||
393 | 770 | SECT_CONCEPT) | ||
394 | 766 | topic_registry.register('eol', _load_from_file, | 771 | topic_registry.register('eol', _load_from_file, |
395 | 767 | 'Information on end-of-line handling', | 772 | 'Information on end-of-line handling', |
396 | 768 | SECT_CONCEPT) | 773 | SECT_CONCEPT) |
397 | 769 | 774 | ||
398 | === modified file 'bzrlib/help_topics/en/authentication.txt' | |||
399 | --- bzrlib/help_topics/en/authentication.txt 2008-05-09 16:40:21 +0000 | |||
400 | +++ bzrlib/help_topics/en/authentication.txt 2010-01-04 08:49:20 +0000 | |||
401 | @@ -110,10 +110,8 @@ | |||
402 | 110 | File format | 110 | File format |
403 | 111 | ----------- | 111 | ----------- |
404 | 112 | 112 | ||
409 | 113 | The general rules for `configuration files`_ apply except for the variable | 113 | The general rules for :doc:`configuration files <configuration-help>` |
410 | 114 | policies. | 114 | apply except for the variable policies. |
407 | 115 | |||
408 | 116 | .. _configuration files: #configuration-settings | ||
411 | 117 | 115 | ||
412 | 118 | Each section describes an authentication definition. | 116 | Each section describes an authentication definition. |
413 | 119 | 117 | ||
414 | 120 | 118 | ||
415 | === modified file 'bzrlib/help_topics/en/configuration.txt' | |||
416 | --- bzrlib/help_topics/en/configuration.txt 2009-12-15 20:32:34 +0000 | |||
417 | +++ bzrlib/help_topics/en/configuration.txt 2010-01-04 08:49:20 +0000 | |||
418 | @@ -272,7 +272,7 @@ | |||
419 | 272 | variable policies which don't apply. | 272 | variable policies which don't apply. |
420 | 273 | 273 | ||
421 | 274 | For more information on the possible uses of the authentication configuration | 274 | For more information on the possible uses of the authentication configuration |
423 | 275 | file see `Authentication Settings`_. | 275 | file see :doc:`authentication-help`. |
424 | 276 | 276 | ||
425 | 277 | 277 | ||
426 | 278 | Common variable options | 278 | Common variable options |
427 | 279 | 279 | ||
428 | === renamed file 'bzrlib/help_topics/en/conflicts.txt' => 'bzrlib/help_topics/en/conflict-types.txt' | |||
429 | --- bzrlib/help_topics/en/conflicts.txt 2009-11-25 16:42:55 +0000 | |||
430 | +++ bzrlib/help_topics/en/conflict-types.txt 2010-01-04 08:49:20 +0000 | |||
431 | @@ -1,5 +1,5 @@ | |||
434 | 1 | Conflicts Types | 1 | Conflict Types |
435 | 2 | =============== | 2 | ============== |
436 | 3 | 3 | ||
437 | 4 | Some operations, like merge, revert and pull, modify the contents of your | 4 | Some operations, like merge, revert and pull, modify the contents of your |
438 | 5 | working tree. These modifications are programmatically generated, and so they | 5 | working tree. These modifications are programmatically generated, and so they |
439 | 6 | 6 | ||
440 | === modified file 'bzrlib/help_topics/en/content-filters.txt' | |||
441 | --- bzrlib/help_topics/en/content-filters.txt 2009-02-25 06:41:51 +0000 | |||
442 | +++ bzrlib/help_topics/en/content-filters.txt 2010-01-04 08:49:20 +0000 | |||
443 | @@ -65,8 +65,8 @@ | |||
444 | 65 | Note: ``bzr commit`` does not implicitly apply write converters after | 65 | Note: ``bzr commit`` does not implicitly apply write converters after |
445 | 66 | comitting files. If this makes sense for a given plugin providing | 66 | comitting files. If this makes sense for a given plugin providing |
446 | 67 | a content filter, the plugin can usually achieve this effect by using a | 67 | a content filter, the plugin can usually achieve this effect by using a |
449 | 68 | ``start_commit`` or ``post_commit`` hook say. See ``bzr help hooks`` and | 68 | ``start_commit`` or ``post_commit`` hook say. See :doc:`hooks-help` |
450 | 69 | `Using hooks`_ in the Bazaar User Guide for more information on hooks. | 69 | for more information on hooks. |
451 | 70 | 70 | ||
452 | 71 | 71 | ||
453 | 72 | Refreshing your working tree | 72 | Refreshing your working tree |
454 | 73 | 73 | ||
455 | === modified file 'bzrlib/help_topics/en/log-formats.txt' | |||
456 | --- bzrlib/help_topics/en/log-formats.txt 2009-02-09 08:19:18 +0000 | |||
457 | +++ bzrlib/help_topics/en/log-formats.txt 2010-01-04 08:49:20 +0000 | |||
458 | @@ -1,4 +1,4 @@ | |||
460 | 1 | Log formats | 1 | Log Formats |
461 | 2 | =========== | 2 | =========== |
462 | 3 | 3 | ||
463 | 4 | A log format controls how information about each revision is displayed. | 4 | A log format controls how information about each revision is displayed. |
464 | 5 | 5 | ||
465 | === modified file 'bzrlib/help_topics/en/rules.txt' | |||
466 | --- bzrlib/help_topics/en/rules.txt 2009-04-26 03:04:30 +0000 | |||
467 | +++ bzrlib/help_topics/en/rules.txt 2010-01-04 08:49:20 +0000 | |||
468 | @@ -16,8 +16,9 @@ | |||
469 | 16 | 16 | ||
470 | 17 | Preferences like these are useful for commands and plugins wishing to | 17 | Preferences like these are useful for commands and plugins wishing to |
471 | 18 | provide custom behaviour for selected files. For more information on | 18 | provide custom behaviour for selected files. For more information on |
474 | 19 | end of line conversion see ``bzr help eol``. Keyword support is provided | 19 | end of line conversion see :doc:`eol-help`. |
475 | 20 | by the bzr-keywords plugin (http://launchpad.net/bzr-keywords). | 20 | Keyword support is provided by the `keywords plugin |
476 | 21 | <http://doc.bazaar.canonical.com/plugins/en/keywords-plugin.html>`_. | ||
477 | 21 | 22 | ||
478 | 22 | Files | 23 | Files |
479 | 23 | ----- | 24 | ----- |
480 | @@ -31,7 +32,9 @@ | |||
481 | 31 | Patterns are ordered and searching stops as soon as one matches. | 32 | Patterns are ordered and searching stops as soon as one matches. |
482 | 32 | As a consequence, more explicit patterns should be placed towards | 33 | As a consequence, more explicit patterns should be placed towards |
483 | 33 | the top of the file. Rule patterns use exactly the same conventions | 34 | the top of the file. Rule patterns use exactly the same conventions |
488 | 34 | as ignore patterns. See ``bzr help patterns`` for details. | 35 | as ignore patterns. See :doc:`patterns-help` for details. |
489 | 35 | 36 | ||
490 | 36 | Note: Patterns containing square brackets or spaces should be | 37 | .. note:: |
491 | 37 | surrounded in quotes to ensure they are correctly parsed. | 38 | |
492 | 39 | Patterns containing square brackets or spaces should be | ||
493 | 40 | surrounded in quotes to ensure they are correctly parsed. | ||
494 | 38 | 41 | ||
495 | === modified file 'bzrlib/hooks.py' | |||
496 | --- bzrlib/hooks.py 2009-09-01 12:29:54 +0000 | |||
497 | +++ bzrlib/hooks.py 2010-01-04 08:49:20 +0000 | |||
498 | @@ -277,7 +277,7 @@ | |||
499 | 277 | 277 | ||
500 | 278 | See `Using hooks`_ in the User Guide for examples. | 278 | See `Using hooks`_ in the User Guide for examples. |
501 | 279 | 279 | ||
503 | 280 | .. _Using hooks: ../user-guide/index.html#using-hooks | 280 | .. _Using hooks: ../user-guide/hooks.html |
504 | 281 | 281 | ||
505 | 282 | The class that contains each hook is given before the hooks it supplies. For | 282 | The class that contains each hook is given before the hooks it supplies. For |
506 | 283 | instance, BranchHooks as the class is the hooks class for | 283 | instance, BranchHooks as the class is the hooks class for |
507 | 284 | 284 | ||
508 | === modified file 'doc/en/user-guide/hooks.txt' | |||
509 | --- doc/en/user-guide/hooks.txt 2008-10-29 06:10:45 +0000 | |||
510 | +++ doc/en/user-guide/hooks.txt 2010-01-04 08:49:20 +0000 | |||
511 | @@ -8,18 +8,18 @@ | |||
512 | 8 | perform actions before or after certain Bazaar operations. The operations | 8 | perform actions before or after certain Bazaar operations. The operations |
513 | 9 | include ``commit``, ``push``, ``pull``, and ``uncommit``. | 9 | include ``commit``, ``push``, ``pull``, and ``uncommit``. |
514 | 10 | For a complete list of hooks and their parameters, see `Hooks | 10 | For a complete list of hooks and their parameters, see `Hooks |
516 | 11 | <../user-reference/bzr_man.html#hooks>`_ in the User Reference. | 11 | <../user-reference/hooks-help.html>`_ in the User Reference. |
517 | 12 | 12 | ||
518 | 13 | Most hooks are run on the client, but a few are run on the server. (Also | 13 | Most hooks are run on the client, but a few are run on the server. (Also |
520 | 14 | see the `bzr-push-and-update`_ plugin that handles one special case of | 14 | see the `push-and-update plugin`_ that handles one special case of |
521 | 15 | server-side operations.) | 15 | server-side operations.) |
522 | 16 | 16 | ||
524 | 17 | .. _bzr-push-and-update: https://launchpad.net/bzr-push-and-update/ | 17 | .. _push-and-update plugin: http://doc.bazaar.canonical.com/plugins/en/push-and-update-plugin.html |
525 | 18 | 18 | ||
526 | 19 | Using hooks | 19 | Using hooks |
527 | 20 | ----------- | 20 | ----------- |
528 | 21 | 21 | ||
530 | 22 | To use a hook, you should `write a plugin <#writing-a-plugin>`_. Instead of | 22 | To use a hook, you should `write a plugin`_. Instead of |
531 | 23 | creating a new command, this plugin will define and install the hook. Here's | 23 | creating a new command, this plugin will define and install the hook. Here's |
532 | 24 | an example:: | 24 | an example:: |
533 | 25 | 25 | ||
534 | @@ -33,6 +33,8 @@ | |||
535 | 33 | branch.Branch.hooks.install_named_hook('post_push', post_push_hook, | 33 | branch.Branch.hooks.install_named_hook('post_push', post_push_hook, |
536 | 34 | 'My post_push hook') | 34 | 'My post_push hook') |
537 | 35 | 35 | ||
538 | 36 | .. _write a plugin: http://doc.bazaar.canonical.com/plugins/en/plugin-development.html | ||
539 | 37 | |||
540 | 36 | To use this example, create a file named ``push_hook.py``, and stick it in | 38 | To use this example, create a file named ``push_hook.py``, and stick it in |
541 | 37 | ``plugins`` subdirectory of your configuration directory. (If you have never | 39 | ``plugins`` subdirectory of your configuration directory. (If you have never |
542 | 38 | installed any plugins, you may need to create the ``plugins`` directory). | 40 | installed any plugins, you may need to create the ``plugins`` directory). |
This branch formats the User Reference as a set of topics. Improving the formatting of the User Reference in this way was recently discussed and agreed to on the bzr-doc mailing list. The formatting and cross-linking of numerous topics has also been improved.
As a side effect of this change, each help topic is now available as http:// doc.bazaar. canonical. com/test/ en/user- reference/ xxx-help. html. The old "conflicts" help topic has been renamed to "conflict-types" so that the conflicts command and it don't map to exactly the same URL.