Merge lp:~ian-clatworthy/bzr/doc-site-per-language into lp:bzr/2.0
- doc-site-per-language
- Merge into 2.0
Status: | Superseded |
---|---|
Proposed branch: | lp:~ian-clatworthy/bzr/doc-site-per-language |
Merge into: | lp:bzr/2.0 |
Diff against target: | None lines |
To merge this branch: | bzr merge lp:~ian-clatworthy/bzr/doc-site-per-language |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Robert Collins (community) | Needs Fixing | ||
Review via email: mp+11287@code.launchpad.net |
This proposal has been superseded by a proposal from 2009-09-08.
Commit message
Description of the change
Ian Clatworthy (ian-clatworthy) wrote : | # |
Robert Collins (lifeless) wrote : | # |
I think this is a good start but it has some issues.
Is it rendered somewhere we can look at?
Nitty gritty:
Is there a source .svg or similar for the new png? Be good to have the
most editable form in bzr.
There is a /lot/ of duplication between the conf.py files. I don't think
that that is good, we should only have unique data in each configuration
file.
I'm a /big/ fan of nonrecursive Make; it would reduce duplication of
Makefile code here too. If you need to you could include Makefile
fragments into the top level make, but it is short enough that I suggest
just including the base rules inline[but parameterised] and then making
make doc depend on the things to build.
Lastly, why are we keeping the old doc rules at all? The docs seem to be
changing so much that those rules would produce garbage...
review needsfixing
Ian Clatworthy (ian-clatworthy) wrote : | # |
> Is it rendered somewhere we can look at?
I've uploaded the Developer docs to http://
> Is there a source .svg or similar for the new png? Be good to have the
> most editable form in bzr.
It came from http://
> There is a /lot/ of duplication between the conf.py files. I don't think
> that that is good, we should only have unique data in each configuration
> file.
I agree. This can come later though, probably post 2.0.
> Lastly, why are we keeping the old doc rules at all? The docs seem to be
> changing so much that those rules would produce garbage...
I've cleaned the Makefile up. It's *much* nicer now. I'll resubmit.
Preview Diff
1 | === modified file '.bzrignore' |
2 | --- .bzrignore 2009-07-31 19:56:19 +0000 |
3 | +++ .bzrignore 2009-09-07 03:58:08 +0000 |
4 | @@ -8,6 +8,7 @@ |
5 | bzr.1 |
6 | ./doc/*.html |
7 | ./doc/_build/ |
8 | +./doc/*/_build/ |
9 | ./tutorial.html |
10 | BRANCH-INFO |
11 | # setup.py working directory |
12 | @@ -53,6 +54,7 @@ |
13 | bzrlib/_rio_pyx.c |
14 | bzrlib/_walkdirs_win32.c |
15 | doc/en/release-notes/NEWS.txt |
16 | +doc/en/release-notes/bzr* |
17 | doc/en/developer-guide/HACKING.txt |
18 | doc/en/user-reference/bzr_man.txt |
19 | # built extension modules |
20 | |
21 | === modified file 'Makefile' |
22 | --- Makefile 2009-08-03 20:38:39 +0000 |
23 | +++ Makefile 2009-09-07 07:52:38 +0000 |
24 | @@ -183,8 +183,8 @@ |
25 | doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES) |
26 | $(PYTHON) tools/generate_docs.py -o $@ rstx |
27 | |
28 | -doc/en/release-notes/NEWS.txt: NEWS |
29 | - $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')" |
30 | +doc/en/release-notes/NEWS.txt: NEWS tools/generate_release_notes.py |
31 | + $(PYTHON) tools/generate_release_notes.py NEWS $@ |
32 | |
33 | MAN_PAGES = man1/bzr.1 |
34 | man1/bzr.1: $(MAN_DEPENDENCIES) |
35 | @@ -206,8 +206,8 @@ |
36 | WEB_DOCS = $(derived_web_docs) $(non_txt_files) |
37 | ALL_DOCS = $(derived_web_docs) $(MAN_PAGES) |
38 | |
39 | -# the main target to build all the docs |
40 | -docs: $(ALL_DOCS) |
41 | +# the target to build all the old-style docs |
42 | +old-docs: $(ALL_DOCS) |
43 | |
44 | # produce a tree containing just the final docs, ready for uploading to the web |
45 | HTMLDIR := html_docs |
46 | @@ -223,6 +223,16 @@ |
47 | $(HTMLDIR) $(derived_txt_files) |
48 | rm -f doc/*/user-guide/*.pdf |
49 | rm -rf doc/*/user-guide/latex_prepared |
50 | + cd doc && make clean |
51 | + |
52 | +# The main target to build all the new-style docs. Requires Sphinx. |
53 | +docs: doc/en/release-notes/NEWS.txt doc/en/user-reference/bzr_man.txt |
54 | + cd doc && make html |
55 | + cd doc && make latex |
56 | + cd doc/_build/latex && make all-pdf |
57 | + cd doc/developers && make html |
58 | + cd doc/es && make html |
59 | + cd doc/ru && make html |
60 | |
61 | |
62 | ### Windows Support ### |
63 | |
64 | === modified file 'NEWS' |
65 | --- NEWS 2009-09-04 02:58:22 +0000 |
66 | +++ NEWS 2009-09-07 07:52:38 +0000 |
67 | @@ -3,9 +3,6 @@ |
68 | #################### |
69 | |
70 | |
71 | -.. contents:: List of Releases |
72 | - :depth: 1 |
73 | - |
74 | bzr 2.0rc2 (not released yet) |
75 | ############################# |
76 | |
77 | @@ -53,13 +50,21 @@ |
78 | * Help on hooks no longer says 'Not deprecated' for hooks that are |
79 | currently supported. (Ian Clatworthy, #422415) |
80 | |
81 | +* PDF and CHM (Windows HtmlHelp) formats are now supported for the |
82 | + user documentation. The HTML documentation is better broken up into |
83 | + topics. (Ian Clatworthy) |
84 | + |
85 | +* The developer and foreign language documents are now separated |
86 | + out so that searching in the HTML and CHM files produces more |
87 | + useful results. (Ian Clatworthy) |
88 | + |
89 | * The main table of contents now provides links to the new Migration Docs |
90 | and Plugins Guide. (Ian Clatworthy) |
91 | |
92 | + |
93 | bzr 2.0rc1 |
94 | ########## |
95 | |
96 | - |
97 | :Codename: no worries |
98 | :2.0rc1: 2009-08-26 |
99 | |
100 | @@ -524,8 +529,8 @@ |
101 | ``countTestsCases``. (Robert Collins) |
102 | |
103 | |
104 | -bzr 1.17 "So late it's brunch" 2009-07-20 |
105 | -######################################### |
106 | +bzr 1.17 |
107 | +######## |
108 | :Codename: so-late-its-brunch |
109 | :1.17rc1: 2009-07-13 |
110 | :1.17: 2009-07-20 |
111 | @@ -774,8 +779,10 @@ |
112 | this class and the UI. (Martin Pool) |
113 | |
114 | |
115 | -bzr 1.16.1 2009-06-26 |
116 | -##################### |
117 | +bzr 1.16.1 |
118 | +########## |
119 | + |
120 | +:Released: 2009-06-26 |
121 | |
122 | End user testing of the 2a format revealed two serious bugs. The first, |
123 | #365615, caused bzr to raise AbsentContentFactory errors when autopacking. |
124 | @@ -830,8 +837,8 @@ |
125 | (Robert Collins, #376748) |
126 | |
127 | |
128 | -bzr 1.16 "It's yesterday in California" 2009-06-18 |
129 | -################################################## |
130 | +bzr 1.16 |
131 | +######## |
132 | :Codename: yesterday-in-california |
133 | :1.16rc1: 2009-06-11 |
134 | :1.16: 2009-06-18 |
135 | @@ -2305,8 +2312,11 @@ |
136 | (Vincent Ladeuil) |
137 | |
138 | |
139 | -bzr 1.11 "Eyes up!" 2009-01-19 |
140 | -############################## |
141 | +bzr 1.11 |
142 | +######## |
143 | + |
144 | +:Codename: "Eyes up!" |
145 | +:Released: 2009-01-19 |
146 | |
147 | This first monthly release of Bazaar for 2009 improves Bazaar's operation |
148 | in Windows, Mac OS X, and other situations where file names are matched |
149 | @@ -2332,8 +2342,11 @@ |
150 | |
151 | |
152 | |
153 | -bzr 1.11rc1 "Eyes up!" 2009-01-09 |
154 | -################################# |
155 | +bzr 1.11rc1 |
156 | +########### |
157 | + |
158 | +:Codename: "Eyes up!" |
159 | +:Released: 2009-01-09 |
160 | |
161 | Changes |
162 | ******* |
163 | @@ -2569,8 +2582,10 @@ |
164 | |
165 | |
166 | |
167 | -bzr 1.10 2008-12-05 |
168 | -################### |
169 | +bzr 1.10 |
170 | +######## |
171 | + |
172 | +:Released: 2008-12-05 |
173 | |
174 | Bazaar 1.10 has several performance improvements for copying revisions |
175 | (especially for small updates to large projects). There has also been a |
176 | @@ -2595,8 +2610,10 @@ |
177 | topologically. (John Arbash Meinel, #304841) |
178 | |
179 | |
180 | -bzr 1.10rc1 2008-11-28 |
181 | -###################### |
182 | +bzr 1.10rc1 |
183 | +########### |
184 | + |
185 | +:Released: 2008-11-28 |
186 | |
187 | This release of Bazaar focuses on performance improvements when pushing |
188 | and pulling revisions, both locally and to remote networks. The popular |
189 | @@ -2716,8 +2733,10 @@ |
190 | * Doctests now only report the first failure. (Martin Pool) |
191 | |
192 | |
193 | -bzr 1.9 2008-11-07 |
194 | -################## |
195 | +bzr 1.9 |
196 | +####### |
197 | + |
198 | +:Released: 2008-11-07 |
199 | |
200 | This release of Bazaar adds a new repository format, ``1.9``, with smaller |
201 | and more efficient index files. This format can be specified when |
202 | @@ -2739,8 +2758,10 @@ |
203 | (John Arbash Meinel, #293746) |
204 | |
205 | |
206 | -bzr 1.9rc1 2008-10-31 |
207 | -##################### |
208 | +bzr 1.9rc1 |
209 | +########## |
210 | + |
211 | +:Released: 2008-10-31 |
212 | |
213 | New Features |
214 | ************ |
215 | @@ -2857,8 +2878,10 @@ |
216 | configuration of authetication credentials. |
217 | |
218 | |
219 | -bzr 1.8 2008-10-16 |
220 | -################## |
221 | +bzr 1.8 |
222 | +####### |
223 | + |
224 | +:Released: 2008-10-16 |
225 | |
226 | Bazaar 1.8 includes several fixes that improve working tree performance, |
227 | display of revision logs, and merges. The bzr testsuite now passes on OS |
228 | @@ -2879,8 +2902,10 @@ |
229 | that platform. (Alexander Belchenko, Martin Pool, #277481) |
230 | |
231 | |
232 | -bzr 1.8rc1 2008-10-07 |
233 | -##################### |
234 | +bzr 1.8rc1 |
235 | +########## |
236 | + |
237 | +:Released: 2008-10-07 |
238 | |
239 | Changes |
240 | ******* |
241 | @@ -3078,14 +3103,18 @@ |
242 | (Vincent Ladeuil) |
243 | |
244 | |
245 | -bzr 1.7.1 2008-10-01 |
246 | -#################### |
247 | +bzr 1.7.1 |
248 | +######### |
249 | + |
250 | +:Released: 2008-10-01 |
251 | |
252 | No changes from 1.7.1rc1. |
253 | |
254 | |
255 | -bzr 1.7.1rc1 2008-09-24 |
256 | -####################### |
257 | +bzr 1.7.1rc1 |
258 | +############ |
259 | + |
260 | +:Released: 2008-09-24 |
261 | |
262 | This release just includes an update to how the merge algorithm handles |
263 | file paths when we encounter complex history. |
264 | @@ -3100,8 +3129,10 @@ |
265 | (John Arbash Meinel) |
266 | |
267 | |
268 | -bzr 1.7 2008-09-23 |
269 | -################## |
270 | +bzr 1.7 |
271 | +####### |
272 | + |
273 | +:Released: 2008-09-23 |
274 | |
275 | This release includes many bug fixes and a few performance and feature |
276 | improvements. ``bzr rm`` will now scan for missing files and remove them, |
277 | @@ -3118,8 +3149,10 @@ |
278 | packaging qbzr. (Mark Hammond) |
279 | |
280 | |
281 | -bzr 1.7rc2 2008-09-17 |
282 | -##################### |
283 | +bzr 1.7rc2 |
284 | +########## |
285 | + |
286 | +:Released: 2008-09-17 |
287 | |
288 | A few bug fixes from 1.7rc1. The biggest change is a new |
289 | ``RemoteBranch.get_stacked_on_url`` rpc. This allows clients that are |
290 | @@ -3143,8 +3176,10 @@ |
291 | (Andrew Bennetts) |
292 | |
293 | |
294 | -bzr 1.7rc1 2008-09-09 |
295 | -##################### |
296 | +bzr 1.7rc1 |
297 | +########## |
298 | + |
299 | +:Released: 2008-09-09 |
300 | |
301 | This release candidate for bzr 1.7 has several bug fixes and a few |
302 | performance and feature improvements. ``bzr rm`` will now scan for |
303 | @@ -3341,16 +3376,20 @@ |
304 | clients now use this mechanism. (Neil Martinsen-Burrell) |
305 | |
306 | |
307 | -bzr 1.6.1 2008-09-05 |
308 | -#################### |
309 | +bzr 1.6.1 |
310 | +######### |
311 | + |
312 | +:Released: 2008-09-05 |
313 | |
314 | A couple regressions were found in the 1.6 release. There was a |
315 | performance issue when using ``bzr+ssh`` to branch large repositories, |
316 | and some problems with stacking and ``rich-root`` capable repositories. |
317 | |
318 | |
319 | -bzr 1.6.1rc2 2008-09-03 |
320 | -####################### |
321 | +bzr 1.6.1rc2 |
322 | +############ |
323 | + |
324 | +:Released: 2008-09-03 |
325 | |
326 | Bug Fixes |
327 | ********* |
328 | @@ -3361,8 +3400,10 @@ |
329 | (John Arbash Meinel, #264321) |
330 | |
331 | |
332 | -bzr 1.6.1rc1 2008-08-29 |
333 | -####################### |
334 | +bzr 1.6.1rc1 |
335 | +############ |
336 | + |
337 | +:Released: 2008-08-29 |
338 | |
339 | This release fixes a few regressions found in the 1.6 client. Fetching |
340 | changes was using an O(N^2) buffering algorithm, so for large projects it |
341 | @@ -3402,8 +3443,10 @@ |
342 | (John Arbash Meinel, #262333) |
343 | |
344 | |
345 | -bzr 1.6 2008-08-25 |
346 | -################## |
347 | +bzr 1.6 |
348 | +####### |
349 | + |
350 | +:Released: 2008-08-25 |
351 | |
352 | Finally, the long awaited bzr 1.6 has been released. This release includes |
353 | new features like Stacked Branches, improved weave merge, and an updated |
354 | @@ -3416,8 +3459,10 @@ |
355 | TortoiseBzr in the standalone Windows installer. |
356 | |
357 | |
358 | -bzr 1.6rc5 2008-08-19 |
359 | -##################### |
360 | +bzr 1.6rc5 |
361 | +########## |
362 | + |
363 | +:Released: 2008-08-19 |
364 | |
365 | Bug Fixes |
366 | ********* |
367 | @@ -3429,8 +3474,10 @@ |
368 | (This change was reverted when merged to bzr.dev) |
369 | |
370 | |
371 | -bzr 1.6rc4 2008-08-18 |
372 | -##################### |
373 | +bzr 1.6rc4 |
374 | +########## |
375 | + |
376 | +:Released: 2008-08-18 |
377 | |
378 | Bug Fixes |
379 | ********* |
380 | @@ -3440,8 +3487,10 @@ |
381 | rather than preserving deltas. (John Arbash Meinel, #256757) |
382 | |
383 | |
384 | -bzr 1.6rc3 2008-08-14 |
385 | -##################### |
386 | +bzr 1.6rc3 |
387 | +########## |
388 | + |
389 | +:Released: 2008-08-14 |
390 | |
391 | Changes |
392 | ******* |
393 | @@ -3474,8 +3523,10 @@ |
394 | development which is substantially faster. (Robert Collins) |
395 | |
396 | |
397 | -bzr 1.6rc2 2008-08-13 |
398 | -##################### |
399 | +bzr 1.6rc2 |
400 | +########## |
401 | + |
402 | +:Released: 2008-08-13 |
403 | |
404 | This release candidate has a few minor bug fixes, and some regression |
405 | fixes for Windows. |
406 | @@ -3513,8 +3564,10 @@ |
407 | will get the same results. (John Arbash Meinel, #232188) |
408 | |
409 | |
410 | -bzr 1.6rc1 2008-08-06 |
411 | -##################### |
412 | +bzr 1.6rc1 |
413 | +########## |
414 | + |
415 | +:Released: 2008-08-06 |
416 | |
417 | This release candidate for bzr 1.6 solidifies the new branch stacking |
418 | feature. Bazaar now recommends that users upgrade all knit repositories, |
419 | @@ -3650,8 +3703,10 @@ |
420 | (Ian Clatworthy) |
421 | |
422 | |
423 | -bzr 1.6beta3 2008-07-17 |
424 | -####################### |
425 | +bzr 1.6beta3 |
426 | +############ |
427 | + |
428 | +:Released: 2008-07-17 |
429 | |
430 | This release adds a new 'stacked branches' feature allowing branches to |
431 | share storage without being in the same repository or on the same machine. |
432 | @@ -3823,8 +3878,10 @@ |
433 | (Robert Collins) |
434 | |
435 | |
436 | -bzr 1.6beta2 2008-06-10 |
437 | -####################### |
438 | +bzr 1.6beta2 |
439 | +############ |
440 | + |
441 | +:Released: 2008-06-10 |
442 | |
443 | This release contains further progress towards our 1.6 goals of shallow |
444 | repositories, and contains a fix for some user-affecting bugs in the |
445 | @@ -3907,9 +3964,10 @@ |
446 | * Knit record serialisation is now stricter on what it will accept, to |
447 | guard against potential internal bugs, or broken input. (Robert Collins) |
448 | |
449 | -bzr 1.6beta1 2008-06-02 |
450 | -####################### |
451 | +bzr 1.6beta1 |
452 | +############ |
453 | |
454 | +:Released: 2008-06-02 |
455 | |
456 | Commands that work on the revision history such as push, pull, missing, |
457 | uncommit and log are now substantially faster. This release adds a |
458 | @@ -4127,8 +4185,10 @@ |
459 | (Martin Pool) |
460 | |
461 | |
462 | -bzr 1.5 2008-05-16 |
463 | -################## |
464 | +bzr 1.5 |
465 | +####### |
466 | + |
467 | +:Released: 2008-05-16 |
468 | |
469 | This release of Bazaar includes several updates to the documentation, and fixes |
470 | to prepare for making rich root support the default format. Many bugs have been |
471 | @@ -4149,8 +4209,10 @@ |
472 | (Ian Clatworthy) |
473 | |
474 | |
475 | -bzr 1.5rc1 2008-05-09 |
476 | -##################### |
477 | +bzr 1.5rc1 |
478 | +########## |
479 | + |
480 | +:Released: 2008-05-09 |
481 | |
482 | Changes |
483 | ******* |
484 | @@ -4320,8 +4382,10 @@ |
485 | (Martin Pool) |
486 | |
487 | |
488 | -bzr 1.4 2008-04-28 |
489 | -################## |
490 | +bzr 1.4 |
491 | +####### |
492 | + |
493 | +:Released: 2008-04-28 |
494 | |
495 | This release of Bazaar includes handy improvements to the speed of log and |
496 | status, new options for several commands, improved documentation, and better |
497 | @@ -4340,8 +4404,10 @@ |
498 | (John Arbash Meinel, Andrew Bennetts, #214894) |
499 | |
500 | |
501 | -bzr 1.4rc2 2008-04-21 |
502 | -##################### |
503 | +bzr 1.4rc2 |
504 | +########## |
505 | + |
506 | +:Released: 2008-04-21 |
507 | |
508 | Bug Fixes |
509 | ********* |
510 | @@ -4364,8 +4430,10 @@ |
511 | (Robert Collins, John Arbash Meinel) |
512 | |
513 | |
514 | -bzr 1.4rc1 2008-04-11 |
515 | -##################### |
516 | +bzr 1.4rc1 |
517 | +########## |
518 | + |
519 | +:Released: 2008-04-11 |
520 | |
521 | Changes |
522 | ******* |
523 | @@ -4652,14 +4720,18 @@ |
524 | ``Graph.get_parent_map`` returns a dict of key:parents. (Robert Collins) |
525 | |
526 | |
527 | -bzr 1.3.1 2008-04-09 |
528 | -#################### |
529 | +bzr 1.3.1 |
530 | +######### |
531 | + |
532 | +:Released: 2008-04-09 |
533 | |
534 | No changes from 1.3.1rc1. |
535 | |
536 | |
537 | -bzr 1.3.1rc1 2008-04-04 |
538 | -####################### |
539 | +bzr 1.3.1rc1 |
540 | +############ |
541 | + |
542 | +:Released: 2008-04-04 |
543 | |
544 | Bug Fixes |
545 | ********* |
546 | @@ -4670,8 +4742,10 @@ |
547 | (#208418, Andrew Bennetts, Martin Pool, Robert Collins) |
548 | |
549 | |
550 | -bzr 1.3 2008-03-20 |
551 | -################## |
552 | +bzr 1.3 |
553 | +####### |
554 | + |
555 | +:Released: 2008-03-20 |
556 | |
557 | Bazaar has become part of the GNU project <http://www.gnu.org> |
558 | |
559 | @@ -4687,8 +4761,10 @@ |
560 | (#202778, Martin Pool) |
561 | |
562 | |
563 | -bzr 1.3rc1 2008-03-16 |
564 | -##################### |
565 | +bzr 1.3rc1 |
566 | +########## |
567 | + |
568 | +:Released: 2008-03-16 |
569 | |
570 | Notes When Upgrading |
571 | ******************** |
572 | @@ -4874,8 +4950,10 @@ |
573 | format. (Robert Collins) |
574 | |
575 | |
576 | -bzr 1.2 2008-02-15 |
577 | -################## |
578 | +bzr 1.2 |
579 | +####### |
580 | + |
581 | +:Released: 2008-02-15 |
582 | |
583 | Bug Fixes |
584 | ********* |
585 | @@ -4883,8 +4961,10 @@ |
586 | * Fix failing test in Launchpad plugin. (Martin Pool) |
587 | |
588 | |
589 | -bzr 1.2rc1 2008-02-13 |
590 | -##################### |
591 | +bzr 1.2rc1 |
592 | +########## |
593 | + |
594 | +:Released: 2008-02-13 |
595 | |
596 | Notes When Upgrading |
597 | ******************** |
598 | @@ -5085,13 +5165,17 @@ |
599 | revision names etc. (Robert Collins) |
600 | |
601 | |
602 | -bzr 1.1 2008-01-15 |
603 | -################## |
604 | +bzr 1.1 |
605 | +####### |
606 | + |
607 | +:Released: 2008-01-15 |
608 | |
609 | (no changes from 1.1rc1) |
610 | |
611 | -bzr 1.1rc1 2008-01-05 |
612 | -##################### |
613 | +bzr 1.1rc1 |
614 | +########## |
615 | + |
616 | +:Released: 2008-01-05 |
617 | |
618 | Changes |
619 | ******* |
620 | @@ -5301,8 +5385,10 @@ |
621 | replaced by the new helper methods added in this release. (Robert Collins) |
622 | |
623 | |
624 | -bzr 1.0 2007-12-14 |
625 | -################## |
626 | +bzr 1.0 |
627 | +####### |
628 | + |
629 | +:Released: 2007-12-14 |
630 | |
631 | Documentation |
632 | ************* |
633 | @@ -5319,8 +5405,10 @@ |
634 | (Ian Clatworthy) |
635 | |
636 | |
637 | -bzr 1.0rc3 2007-12-11 |
638 | -##################### |
639 | +bzr 1.0rc3 |
640 | +########## |
641 | + |
642 | +:Released: 2007-12-11 |
643 | |
644 | Changes |
645 | ******* |
646 | @@ -5361,8 +5449,10 @@ |
647 | (Vincent Ladeuil) |
648 | |
649 | |
650 | -bzr 1.0rc2 2007-12-07 |
651 | -##################### |
652 | +bzr 1.0rc2 |
653 | +########## |
654 | + |
655 | +:Released: 2007-12-07 |
656 | |
657 | Improvements |
658 | ************ |
659 | @@ -5436,8 +5526,10 @@ |
660 | ``started`` methods. (Matt Nordhoff) |
661 | |
662 | |
663 | -bzr 1.0rc1 2007-11-30 |
664 | -##################### |
665 | +bzr 1.0rc1 |
666 | +########## |
667 | + |
668 | +:Released: 2007-11-30 |
669 | |
670 | Notes When Upgrading |
671 | ******************** |
672 | @@ -5713,8 +5805,10 @@ |
673 | * InventoryEntry.diff is now deprecated. Please use diff.DiffTree instead. |
674 | |
675 | |
676 | -bzr 0.92 2007-11-05 |
677 | -################### |
678 | +bzr 0.92 |
679 | +######## |
680 | + |
681 | +:Released: 2007-11-05 |
682 | |
683 | Changes |
684 | ******* |
685 | @@ -5722,8 +5816,10 @@ |
686 | * New uninstaller on Win32. (Alexander Belchenko) |
687 | |
688 | |
689 | -bzr 0.92rc1 2007-10-29 |
690 | -###################### |
691 | +bzr 0.92rc1 |
692 | +########### |
693 | + |
694 | +:Released: 2007-10-29 |
695 | |
696 | Changes |
697 | ******* |
698 | @@ -6042,8 +6138,10 @@ |
699 | raises a Python warning. (Martin Pool) |
700 | |
701 | |
702 | -bzr 0.91 2007-09-26 |
703 | -################### |
704 | +bzr 0.91 |
705 | +######## |
706 | + |
707 | +:Released: 2007-09-26 |
708 | |
709 | Bug Fixes |
710 | ********* |
711 | @@ -6064,15 +6162,19 @@ |
712 | (Andrew Bennetts) |
713 | |
714 | |
715 | -bzr 0.91rc2 2007-09-11 |
716 | -###################### |
717 | +bzr 0.91rc2 |
718 | +########### |
719 | + |
720 | +:Released: 2007-09-11 |
721 | |
722 | * Replaced incorrect tarball for previous release; a debug statement was left |
723 | in bzrlib/remote.py. |
724 | |
725 | |
726 | -bzr 0.91rc1 2007-09-11 |
727 | -###################### |
728 | +bzr 0.91rc1 |
729 | +########### |
730 | + |
731 | +:Released: 2007-09-11 |
732 | |
733 | Changes |
734 | ******* |
735 | @@ -6399,8 +6501,10 @@ |
736 | [] to revert all files is deprecated. (Aaron Bentley) |
737 | |
738 | |
739 | -bzr 0.90 2007-08-28 |
740 | -################### |
741 | +bzr 0.90 |
742 | +######## |
743 | + |
744 | +:Released: 2007-08-28 |
745 | |
746 | Improvements |
747 | ************ |
748 | @@ -6423,8 +6527,10 @@ |
749 | and call ``create_repository`` on that. (Martin Pool) |
750 | |
751 | |
752 | -bzr 0.90rc1 2007-08-14 |
753 | -###################### |
754 | +bzr 0.90rc1 |
755 | +########### |
756 | + |
757 | +:Released: 2007-08-14 |
758 | |
759 | Bugfixes |
760 | ******** |
761 | @@ -6696,8 +6802,10 @@ |
762 | parameter. Varargs-style parameters are deprecated. (Aaron Bentley) |
763 | |
764 | |
765 | -bzr 0.18 2007-07-17 |
766 | -#################### |
767 | +bzr 0.18 |
768 | +######## |
769 | + |
770 | +:Released: 2007-07-17 |
771 | |
772 | Bugfixes |
773 | ******** |
774 | @@ -6705,8 +6813,10 @@ |
775 | * Fix 'bzr add' crash under Win32 (Kuno Meyer) |
776 | |
777 | |
778 | -bzr 0.18rc1 2007-07-10 |
779 | -####################### |
780 | +bzr 0.18rc1 |
781 | +########### |
782 | + |
783 | +:Released: 2007-07-10 |
784 | |
785 | Bugfixes |
786 | ******** |
787 | @@ -6957,8 +7067,10 @@ |
788 | (Vincent Ladeuil, #110448) |
789 | |
790 | |
791 | -bzr 0.17 2007-06-18 |
792 | -#################### |
793 | +bzr 0.17 |
794 | +######## |
795 | + |
796 | +:Released: 2007-06-18 |
797 | |
798 | Bugfixes |
799 | ******** |
800 | @@ -6970,8 +7082,10 @@ |
801 | (Aaron Bentley, Ian Clatworthy, #120930) |
802 | |
803 | |
804 | -bzr 0.17rc1 2007-06-12 |
805 | -####################### |
806 | +bzr 0.17rc1 |
807 | +########### |
808 | + |
809 | +:Released: 2007-06-12 |
810 | |
811 | Notes When Upgrading |
812 | ******************** |
813 | @@ -7072,8 +7186,10 @@ |
814 | your repository. (Previously Branch6 only supported revisions in your |
815 | mainline). (John Arbash Meinel, #115343) |
816 | |
817 | -bzr 0.16 2007-05-07 |
818 | -#################### |
819 | +bzr 0.16 |
820 | +######## |
821 | + |
822 | +:Released: 2007-05-07 |
823 | |
824 | Bugfixes |
825 | ******** |
826 | @@ -7103,8 +7219,10 @@ |
827 | diff`` and ``bzr status`` significantly improving the speed of |
828 | both. (John Arbash Meinel) |
829 | |
830 | -bzr 0.16rc2 2007-04-30 |
831 | -####################### |
832 | +bzr 0.16rc2 |
833 | +########### |
834 | + |
835 | +:Released: 2007-04-30 |
836 | |
837 | Bugfixes |
838 | ******** |
839 | @@ -7127,8 +7245,10 @@ |
840 | * ``WorkingTree4._iter_changes`` should not descend into unversioned |
841 | directories. (John Arbash Meinel, #110399) |
842 | |
843 | -bzr 0.16rc1 2007-04-26 |
844 | -####################### |
845 | +bzr 0.16rc1 |
846 | +########### |
847 | + |
848 | +:Released: 2007-04-26 |
849 | |
850 | Notes When Upgrading |
851 | ******************** |
852 | @@ -7435,8 +7555,10 @@ |
853 | implementation of new auth schemes for both http and proxy. |
854 | (Vincent Ladeuil) |
855 | |
856 | -bzr 0.15 2007-04-01 |
857 | -################### |
858 | +bzr 0.15 |
859 | +######## |
860 | + |
861 | +:Released: 2007-04-01 |
862 | |
863 | Bugfixes |
864 | ******** |
865 | @@ -7448,8 +7570,10 @@ |
866 | checking out a branch that contains an old-format working tree. |
867 | (Martin Pool) |
868 | |
869 | -bzr 0.15rc3 2007-03-26 |
870 | -####################### |
871 | +bzr 0.15rc3 |
872 | +########### |
873 | + |
874 | +:Released: 2007-03-26 |
875 | |
876 | Changes |
877 | ******* |
878 | @@ -7524,8 +7648,10 @@ |
879 | * Correctly handles mutiple permanent http redirections. |
880 | (vila, #88780) |
881 | |
882 | -bzr 0.15rc2 2007-03-14 |
883 | -####################### |
884 | +bzr 0.15rc2 |
885 | +########### |
886 | + |
887 | +:Released: 2007-03-14 |
888 | |
889 | Notes When Upgrading |
890 | ******************** |
891 | @@ -7578,8 +7704,10 @@ |
892 | (Wouter van Heyst, #53483) |
893 | |
894 | |
895 | -bzr 0.15rc1 2007-03-07 |
896 | -####################### |
897 | +bzr 0.15rc1 |
898 | +########### |
899 | + |
900 | +:Released: 2007-03-07 |
901 | |
902 | Surprises |
903 | ********* |
904 | @@ -7809,8 +7937,10 @@ |
905 | before the rest of the suite. (Martin Pool) |
906 | |
907 | |
908 | -bzr 0.14 2007-01-23 |
909 | -#################### |
910 | +bzr 0.14 |
911 | +######## |
912 | + |
913 | +:Released: 2007-01-23 |
914 | |
915 | Improvements |
916 | ************ |
917 | @@ -7829,8 +7959,10 @@ |
918 | it is in is below a repository. (James Westby, #77306) |
919 | |
920 | |
921 | -bzr 0.14rc1 2007-01-16 |
922 | -####################### |
923 | +bzr 0.14rc1 |
924 | +########### |
925 | + |
926 | +:Released: 2007-01-16 |
927 | |
928 | Improvements |
929 | ************ |
930 | @@ -7964,14 +8096,18 @@ |
931 | (Alexander Belchenko, #68124) |
932 | |
933 | |
934 | -bzr 0.13 2006-12-05 |
935 | -#################### |
936 | +bzr 0.13 |
937 | +######## |
938 | + |
939 | +:Released: 2006-12-05 |
940 | |
941 | No changes from 0.13rc |
942 | |
943 | |
944 | -bzr 0.13rc1 2006-11-27 |
945 | -####################### |
946 | +bzr 0.13rc1 |
947 | +########### |
948 | + |
949 | +:Released: 2006-11-27 |
950 | |
951 | Improvements |
952 | ************ |
953 | @@ -8096,8 +8232,10 @@ |
954 | * TestingHTTPRequestHandler really handles the Range header |
955 | (previously it was ignoring it and returning the whole file,). |
956 | |
957 | -bzr 0.12 2006-10-30 |
958 | -#################### |
959 | +bzr 0.12 |
960 | +######## |
961 | + |
962 | +:Released: 2006-10-30 |
963 | |
964 | Internals |
965 | ********* |
966 | @@ -8106,8 +8244,10 @@ |
967 | and remove benchmarks that take longer than 10min to run. |
968 | (John Arbash Meinel) |
969 | |
970 | -bzr 0.12rc1 2006-10-23 |
971 | -####################### |
972 | +bzr 0.12rc1 |
973 | +########### |
974 | + |
975 | +:Released: 2006-10-23 |
976 | |
977 | Improvements |
978 | ************ |
979 | @@ -8228,13 +8368,17 @@ |
980 | option to set the BzrDir, Repository and Branch formats of the |
981 | created objects. (Robert Collins, John Arbash Meinel) |
982 | |
983 | -bzr 0.11 2006-10-02 |
984 | -#################### |
985 | +bzr 0.11 |
986 | +######## |
987 | + |
988 | +:Released: 2006-10-02 |
989 | |
990 | * Smart server transport test failures on windows fixed. (Lukáš Lalinský). |
991 | |
992 | -bzr 0.11rc2 2006-09-27 |
993 | -####################### |
994 | +bzr 0.11rc2 |
995 | +########### |
996 | + |
997 | +:Released: 2006-09-27 |
998 | |
999 | Bug Fixes |
1000 | ********* |
1001 | @@ -8244,8 +8388,10 @@ |
1002 | * Commit performance regression fixed. (Aaron Bentley, Robert Collins, John |
1003 | Arbash Meinel). |
1004 | |
1005 | -bzr 0.11rc1 2006-09-25 |
1006 | -####################### |
1007 | +bzr 0.11rc1 |
1008 | +########### |
1009 | + |
1010 | +:Released: 2006-09-25 |
1011 | |
1012 | Improvements |
1013 | ************ |
1014 | @@ -8438,8 +8584,10 @@ |
1015 | allow upgrades to a richer interface than the VFS one provided by |
1016 | Transport. (Andrew Bennetts, Martin Pool) |
1017 | |
1018 | -bzr 0.10 2006-08-29 |
1019 | -#################### |
1020 | +bzr 0.10 |
1021 | +######## |
1022 | + |
1023 | +:Released: 2006-08-29 |
1024 | |
1025 | Improvements |
1026 | ************ |
1027 | @@ -8516,8 +8664,10 @@ |
1028 | need to be installed. This should help make the life of packagers |
1029 | easier. (John Arbash Meinel) |
1030 | |
1031 | -bzr 0.9.0 2006-08-11 |
1032 | -##################### |
1033 | +bzr 0.9.0 |
1034 | +######### |
1035 | + |
1036 | +:Released: 2006-08-11 |
1037 | |
1038 | Surprises |
1039 | ********* |
1040 | @@ -8784,16 +8934,20 @@ |
1041 | |
1042 | * "RevisionTree" is now in bzrlib/revisiontree.py. (Robert Collins) |
1043 | |
1044 | -bzr 0.8.2 2006-05-17 |
1045 | -##################### |
1046 | +bzr 0.8.2 |
1047 | +######### |
1048 | + |
1049 | +:Released: 2006-05-17 |
1050 | |
1051 | Bug Fixes |
1052 | ********* |
1053 | |
1054 | * setup.py failed to install launchpad plugin. (Martin Pool) |
1055 | |
1056 | -bzr 0.8.1 2006-05-16 |
1057 | -##################### |
1058 | +bzr 0.8.1 |
1059 | +######### |
1060 | + |
1061 | +:Released: 2006-05-16 |
1062 | |
1063 | Bug Fixes |
1064 | ********* |
1065 | @@ -8846,8 +9000,10 @@ |
1066 | * Fix test case for bzr info in upgrading a standalone branch to metadir, |
1067 | uses bzrlib api now. (Olaf Conradi) |
1068 | |
1069 | -bzr 0.8 2006-05-08 |
1070 | -################### |
1071 | +bzr 0.8 |
1072 | +####### |
1073 | + |
1074 | +:Released: 2006-05-08 |
1075 | |
1076 | Notes When Upgrading |
1077 | ******************** |
1078 | @@ -9108,8 +9264,10 @@ |
1079 | * ``run_bzr`` and ``run_bzr_captured`` now accept a 'stdin="foo"' |
1080 | parameter which will provide String("foo") to the command as its stdin. |
1081 | |
1082 | -bzr 0.7 2006-01-09 |
1083 | -################## |
1084 | +bzr 0.7 |
1085 | +####### |
1086 | + |
1087 | +:Released: 2006-01-09 |
1088 | |
1089 | Changes |
1090 | ******* |
1091 | @@ -9404,8 +9562,10 @@ |
1092 | * ``bzrlib.osutils.safe_unicode`` now exists to provide parameter coercion |
1093 | for functions that need unicode strings. (Robert Collins) |
1094 | |
1095 | -bzr 0.6 2005-10-28 |
1096 | -################## |
1097 | +bzr 0.6 |
1098 | +####### |
1099 | + |
1100 | +:Released: 2005-10-28 |
1101 | |
1102 | Improvements |
1103 | ************ |
1104 | @@ -9620,8 +9780,10 @@ |
1105 | [-1] in the revision-history. (Andres Salomon) |
1106 | |
1107 | |
1108 | -bzr 0.1.1 2005-10-12 |
1109 | -#################### |
1110 | +bzr 0.1.1 |
1111 | +######### |
1112 | + |
1113 | +:Released: 2005-10-12 |
1114 | |
1115 | Bug Fixes |
1116 | ********* |
1117 | @@ -9638,8 +9800,10 @@ |
1118 | * Avoid some unnecessary http operations in branch and pull. |
1119 | |
1120 | |
1121 | -bzr 0.1 2005-10-11 |
1122 | -################## |
1123 | +bzr 0.1 |
1124 | +####### |
1125 | + |
1126 | +:Released: 2005-10-11 |
1127 | |
1128 | Notes |
1129 | ***** |
1130 | @@ -9768,8 +9932,10 @@ |
1131 | of tests to run, e.g. ``bzr selftest test_weave`` |
1132 | |
1133 | |
1134 | -bzr 0.0.9 2005-09-23 |
1135 | -#################### |
1136 | +bzr 0.0.9 |
1137 | +######### |
1138 | + |
1139 | +:Released: 2005-09-23 |
1140 | |
1141 | Bug Fixes |
1142 | ********* |
1143 | @@ -9810,8 +9976,11 @@ |
1144 | another (used by pull, merged, etc.) |
1145 | |
1146 | |
1147 | -bzr 0.0.8 2005-09-20 |
1148 | -#################### |
1149 | +bzr 0.0.8 |
1150 | +######### |
1151 | + |
1152 | +:Released: 2005-09-20 |
1153 | + |
1154 | |
1155 | Improvements |
1156 | ************ |
1157 | @@ -9861,8 +10030,10 @@ |
1158 | * Quieten warnings about locking; patch from Matt Lavin. |
1159 | |
1160 | |
1161 | -bzr-0.0.7 2005-09-02 |
1162 | -#################### |
1163 | +bzr-0.0.7 |
1164 | +######### |
1165 | + |
1166 | +:Released: 2005-09-02 |
1167 | |
1168 | New Features |
1169 | ************ |
1170 | @@ -9916,8 +10087,10 @@ |
1171 | |
1172 | |
1173 | |
1174 | -bzr-0.0.6 2005-08-18 |
1175 | -#################### |
1176 | +bzr-0.0.6 |
1177 | +######### |
1178 | + |
1179 | +:Released: 2005-08-18 |
1180 | |
1181 | New Features |
1182 | ************ |
1183 | @@ -10002,8 +10175,10 @@ |
1184 | * Fix bugs in committing only selected files or within a subdirectory. |
1185 | |
1186 | |
1187 | -bzr-0.0.5 2005-06-15 |
1188 | -##################### |
1189 | +bzr-0.0.5 |
1190 | +######### |
1191 | + |
1192 | +:Released: 2005-06-15 |
1193 | |
1194 | Changes |
1195 | ******* |
1196 | @@ -10144,8 +10319,10 @@ |
1197 | 2.4 is now only recommended. |
1198 | |
1199 | |
1200 | -bzr-0.0.4 2005-04-22 |
1201 | -##################### |
1202 | +bzr-0.0.4 |
1203 | +######### |
1204 | + |
1205 | +:Released: 2005-04-22 |
1206 | |
1207 | Enhancements |
1208 | ************ |
1209 | @@ -10213,8 +10390,10 @@ |
1210 | from QuantumG. |
1211 | |
1212 | |
1213 | -bzr-0.0.3 2005-04-06 |
1214 | -##################### |
1215 | +bzr-0.0.3 |
1216 | +######### |
1217 | + |
1218 | +:Released: 2005-04-06 |
1219 | |
1220 | Enhancements |
1221 | ************ |
1222 | @@ -10268,8 +10447,11 @@ |
1223 | * Win32 fixes from Steve Brown. |
1224 | |
1225 | |
1226 | -bzr-0.0.2 "black cube" 2005-03-31 |
1227 | -################################### |
1228 | +bzr-0.0.2 |
1229 | +######### |
1230 | + |
1231 | +:Codename: "black cube" |
1232 | +:Released: 2005-03-31 |
1233 | |
1234 | Enhancements |
1235 | ************ |
1236 | @@ -10297,8 +10479,10 @@ |
1237 | the root directory only. |
1238 | |
1239 | |
1240 | -bzr-0.0.1 2005-03-26 |
1241 | -##################### |
1242 | +bzr-0.0.1 |
1243 | +######### |
1244 | + |
1245 | +:Released: 2005-03-26 |
1246 | |
1247 | Enhancements |
1248 | ************ |
1249 | @@ -10327,8 +10511,10 @@ |
1250 | supported). |
1251 | |
1252 | |
1253 | -bzr-0.0.0.69 2005-03-22 |
1254 | -######################## |
1255 | +bzr-0.0.0.69 |
1256 | +############ |
1257 | + |
1258 | +:Released: 2005-03-22 |
1259 | |
1260 | Enhancements |
1261 | ************ |
1262 | |
1263 | === added file 'doc/Bazaar-Logo-For-Manuals.png' |
1264 | Binary files doc/Bazaar-Logo-For-Manuals.png 1970-01-01 00:00:00 +0000 and doc/Bazaar-Logo-For-Manuals.png 2009-09-02 16:03:51 +0000 differ |
1265 | === modified file 'doc/_templates/index.html' |
1266 | --- doc/_templates/index.html 2009-08-18 00:10:19 +0000 |
1267 | +++ doc/_templates/index.html 2009-09-03 02:29:16 +0000 |
1268 | @@ -16,9 +16,6 @@ |
1269 | <p class="biglink"><a class="biglink" href="{{ pathto("en/quick-reference/index") }}">Quick Reference</a><br/> |
1270 | <span class="linkdescr">for your wall</span> |
1271 | </p> |
1272 | - <p class="biglink"><a class="biglink" href="{{ pathto("en/user-reference/bzr_man") }}">User Reference</a><br/> |
1273 | - <span class="linkdescr">all the gory details</span> |
1274 | - </p> |
1275 | </td><td width="50%"> |
1276 | <p class="biglink"><a class="biglink" href="{{ pathto("en/release-notes/NEWS") }}">Release Notes</a><br/> |
1277 | <span class="linkdescr">what's new</span> |
1278 | @@ -26,6 +23,23 @@ |
1279 | <p class="biglink"><a class="biglink" href="{{ pathto("en/upgrade-guide/index") }}">Upgrade Guide</a><br/> |
1280 | <span class="linkdescr">moving to Bazaar 2.x</span> |
1281 | </p> |
1282 | + <p class="biglink"><a class="biglink" href="{{ pathto("en/user-reference/bzr_man") }}">User Reference</a><br/> |
1283 | + <span class="linkdescr">all the gory details</span> |
1284 | + </p> |
1285 | + </td></tr> |
1286 | + </table> |
1287 | + |
1288 | + <h2>Related links</h2> |
1289 | + |
1290 | + <table class="contentstable" align="center" style="margin-left: 30px"><tr> |
1291 | + <td width="50%"> |
1292 | + <p class="biglink"><a class="biglink" href="https://answers.launchpad.net/bzr">FAQ</a><br/> |
1293 | + <span class="linkdescr">frequently asked questions</span> |
1294 | + </p> |
1295 | + <p class="biglink"><a class="biglink" href="http://bazaar-vcs.org/BzrGlossary/">Glossary</a><br/> |
1296 | + <span class="linkdescr">help with terminology</span> |
1297 | + </p> |
1298 | + </td><td width="50%"> |
1299 | <p class="biglink"><a class="biglink" href="http://doc.bazaar-vcs.org/migration/en/">Migration Docs</a><br/> |
1300 | <span class="linkdescr">for refugees of other tools</span> |
1301 | </p> |
1302 | @@ -35,31 +49,7 @@ |
1303 | </td></tr> |
1304 | </table> |
1305 | |
1306 | - <p>Keen to help? See the <a href="{{ pathto("developers/index") }}">Developer Docs</a> |
1307 | + <p>Keen to help? See the <a href="http://doc.bazaar-vcs.org/latest/developers/">Developer Docs</a> |
1308 | for policies and tools on contributing code, tests and documentation.</p> |
1309 | |
1310 | - |
1311 | - <h2>Related Links</h2> |
1312 | - |
1313 | - <table class="contentstable" align="center" style="margin-left: 30px"><tr> |
1314 | - <td width="25%"> |
1315 | - <p><a href="https://answers.launchpad.net/bzr">FAQ</a> |
1316 | - </p> |
1317 | - </td><td width="25%"> |
1318 | - <p><a href="http://bazaar-vcs.org/BzrGlossary/">Glossary</a> |
1319 | - </p> |
1320 | - </td><td width="25%"> |
1321 | - <p><a href="{{ pathto("genindex") }}">Index</a> |
1322 | - </p> |
1323 | - </td><td width="25%"> |
1324 | - <p><a href="{{ pathto("search") }}">Search</a> |
1325 | - </p> |
1326 | - </td></tr> |
1327 | - </table> |
1328 | - |
1329 | - <hr> |
1330 | - <p>Other languages: |
1331 | - <a href="{{ pathto("index.es") }}">Spanish</a>, |
1332 | - <a href="{{ pathto("index.ru") }}">Russian</a> |
1333 | - </p> |
1334 | {% endblock %} |
1335 | |
1336 | === modified file 'doc/_templates/layout.html' |
1337 | --- doc/_templates/layout.html 2009-07-22 13:41:01 +0000 |
1338 | +++ doc/_templates/layout.html 2009-09-03 00:21:59 +0000 |
1339 | @@ -3,5 +3,6 @@ |
1340 | {% block rootrellink %} |
1341 | <li><a href="http://bazaar-vcs.org/"> |
1342 | <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Home</a> | </li> |
1343 | +<a href="http://doc.bazaar-vcs.org/en/">Documentation</a> | </li> |
1344 | {{ super() }} |
1345 | {% endblock %} |
1346 | |
1347 | === modified file 'doc/conf.py' |
1348 | --- doc/conf.py 2009-07-22 13:41:01 +0000 |
1349 | +++ doc/conf.py 2009-09-07 07:44:36 +0000 |
1350 | @@ -18,6 +18,15 @@ |
1351 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
1352 | #sys.path.append(os.path.abspath('.')) |
1353 | |
1354 | +# -- Bazaar-specific configuration --------------------------------------------- |
1355 | + |
1356 | +# NOTE: Editing this section is generally all that is required ... |
1357 | + |
1358 | +# We *could* get this from bzrlib but there's no certainly that the bzr on |
1359 | +# the Python path is indeed the one we're building the documentation for ... |
1360 | +bzr_version = (2, 0, 0, 'rc', 2) |
1361 | + |
1362 | + |
1363 | # -- General configuration ----------------------------------------------------- |
1364 | |
1365 | # Add any Sphinx extension module names here, as strings. They can be extensions |
1366 | @@ -34,7 +43,7 @@ |
1367 | #source_encoding = 'utf-8' |
1368 | |
1369 | # The master toctree document. |
1370 | -master_doc = 'contents' |
1371 | +master_doc = 'index' |
1372 | |
1373 | # General information about the project. |
1374 | project = u'Bazaar' |
1375 | @@ -45,9 +54,9 @@ |
1376 | # built documents. |
1377 | # |
1378 | # The short X.Y version. |
1379 | -version = '1.18' |
1380 | +version = '.'.join(str(p) for p in bzr_version[:3]) |
1381 | # The full version, including alpha/beta/rc tags. |
1382 | -release = '1.18dev' |
1383 | +release = version + ''.join(str(p) for p in bzr_version[3:]) |
1384 | |
1385 | # The language for content autogenerated by Sphinx. Refer to documentation |
1386 | # for a list of supported languages. |
1387 | @@ -64,7 +73,7 @@ |
1388 | |
1389 | # List of directories, relative to source directory, that shouldn't be searched |
1390 | # for source files. |
1391 | -exclude_trees = ['_build'] |
1392 | +exclude_trees = ['_build', 'ru', 'es', 'developers'] |
1393 | |
1394 | # The reST default role (used for this markup: `text`) to use for all documents. |
1395 | #default_role = None |
1396 | @@ -123,7 +132,7 @@ |
1397 | #html_title = None |
1398 | |
1399 | # A shorter title for the navigation bar. Default is the same as html_title. |
1400 | -#html_short_title = None |
1401 | +html_short_title = "Table of Contents (%s)" % (release,) |
1402 | |
1403 | # The name of an image file (relative to this directory) to place at the top |
1404 | # of the sidebar. |
1405 | @@ -152,13 +161,13 @@ |
1406 | |
1407 | # Additional templates that should be rendered to pages, maps page names to |
1408 | # template names. |
1409 | -html_additional_pages = {'contents': 'index.html'} |
1410 | +html_additional_pages = {'index': 'index.html'} |
1411 | |
1412 | # If false, no module index is generated. |
1413 | -#html_use_modindex = True |
1414 | +html_use_modindex = False |
1415 | |
1416 | # If false, no index is generated. |
1417 | -#html_use_index = True |
1418 | +html_use_index = False |
1419 | |
1420 | # If true, the index is split into individual pages for each letter. |
1421 | #html_split_index = False |
1422 | @@ -175,7 +184,7 @@ |
1423 | #html_file_suffix = '' |
1424 | |
1425 | # Output file base name for HTML help builder. |
1426 | -htmlhelp_basename = 'Bazaardoc' |
1427 | +htmlhelp_basename = 'bzr-en-user-docs' |
1428 | |
1429 | |
1430 | # -- Options for LaTeX output -------------------------------------------------- |
1431 | @@ -189,13 +198,29 @@ |
1432 | # Grouping the document tree into LaTeX files. List of tuples |
1433 | # (source start file, target name, title, author, documentclass [howto/manual]). |
1434 | latex_documents = [ |
1435 | - ('contents', 'Bazaar.tex', u'Bazaar Documentation', |
1436 | - u'Bazaar Developers', 'manual'), |
1437 | + # Manuals |
1438 | + ('en/user-guide/index', 'bzr-en-user-guide.tex', u'Bazaar User Guide', |
1439 | + u'Bazaar Developers', 'manual'), |
1440 | + ('en/user-reference/bzr_man', 'bzr-en-user-reference.tex', u'Bazaar User Reference', |
1441 | + u'Bazaar Developers', 'manual'), |
1442 | + ('en/release-notes/NEWS', 'bzr-en-release-notes.tex', u'Bazaar Release Notes', |
1443 | + u'Bazaar Developers', 'manual'), |
1444 | + ('en/upgrade-guide/index', 'bzr-en-upgrade-guide.tex', u'Bazaar Upgrade Guide', |
1445 | + u'Bazaar Developers', 'manual'), |
1446 | + # Tutorials |
1447 | + ('en/mini-tutorial/index', 'bzr-en-tutorial-mini.tex', u'Bazaar in five minutes', |
1448 | + u'Bazaar Developers', 'howto'), |
1449 | + ('en/tutorials/tutorial', 'bzr-en-tutorial.tex', u'Bazaar Tutorial', |
1450 | + u'Bazaar Developers', 'howto'), |
1451 | + ('en/tutorials/using_bazaar_with_launchpad', 'bzr-en-tutorial-with-launchpad.tex', |
1452 | + u'Using Bazaar With Launchpad', u'Bazaar Developers', 'howto'), |
1453 | + ('en/tutorials/centralized_workflow', 'bzr-en-tutorial-centralized.tex', |
1454 | + u'Centralized Workflow Tutorial', u'Bazaar Developers', 'howto'), |
1455 | ] |
1456 | |
1457 | # The name of an image file (relative to this directory) to place at the top of |
1458 | # the title page. |
1459 | -#latex_logo = None |
1460 | +latex_logo = 'Bazaar-Logo-For-Manuals.png' |
1461 | |
1462 | # For "manual" documents, if this is true, then toplevel headings are parts, |
1463 | # not chapters. |
1464 | |
1465 | === renamed file 'doc/en/developer-guide/HACKING.txt' => 'doc/developers/HACKING.txt' |
1466 | === added file 'doc/developers/Makefile' |
1467 | --- doc/developers/Makefile 1970-01-01 00:00:00 +0000 |
1468 | +++ doc/developers/Makefile 2009-09-07 07:44:36 +0000 |
1469 | @@ -0,0 +1,88 @@ |
1470 | +# Makefile for Sphinx documentation |
1471 | +# |
1472 | + |
1473 | +# You can set these variables from the command line. |
1474 | +SPHINXOPTS = |
1475 | +SPHINXBUILD = sphinx-build |
1476 | +PAPER = |
1477 | + |
1478 | +# Internal variables. |
1479 | +PAPEROPT_a4 = -D latex_paper_size=a4 |
1480 | +PAPEROPT_letter = -D latex_paper_size=letter |
1481 | +ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
1482 | + |
1483 | +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest |
1484 | + |
1485 | +help: |
1486 | + @echo "Please use \`make <target>' where <target> is one of" |
1487 | + @echo " html to make standalone HTML files" |
1488 | + @echo " dirhtml to make HTML files named index.html in directories" |
1489 | + @echo " pickle to make pickle files" |
1490 | + @echo " json to make JSON files" |
1491 | + @echo " htmlhelp to make HTML files and a HTML help project" |
1492 | + @echo " qthelp to make HTML files and a qthelp project" |
1493 | + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
1494 | + @echo " changes to make an overview of all changed/added/deprecated items" |
1495 | + @echo " linkcheck to check all external links for integrity" |
1496 | + @echo " doctest to run all doctests embedded in the documentation (if enabled)" |
1497 | + |
1498 | +clean: |
1499 | + -rm -rf _build/* |
1500 | + |
1501 | +html: |
1502 | + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html |
1503 | + @echo |
1504 | + @echo "Build finished. The HTML pages are in _build/html." |
1505 | + |
1506 | +dirhtml: |
1507 | + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml |
1508 | + @echo |
1509 | + @echo "Build finished. The HTML pages are in _build/dirhtml." |
1510 | + |
1511 | +pickle: |
1512 | + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle |
1513 | + @echo |
1514 | + @echo "Build finished; now you can process the pickle files." |
1515 | + |
1516 | +json: |
1517 | + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json |
1518 | + @echo |
1519 | + @echo "Build finished; now you can process the JSON files." |
1520 | + |
1521 | +htmlhelp: |
1522 | + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp |
1523 | + @echo |
1524 | + @echo "Build finished; now you can run HTML Help Workshop with the" \ |
1525 | + ".hhp project file in _build/htmlhelp." |
1526 | + |
1527 | +qthelp: |
1528 | + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp |
1529 | + @echo |
1530 | + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
1531 | + ".qhcp project file in _build/qthelp, like this:" |
1532 | + @echo "# qcollectiongenerator _build/qthelp/Bazaar.qhcp" |
1533 | + @echo "To view the help file:" |
1534 | + @echo "# assistant -collectionFile _build/qthelp/Bazaar.qhc" |
1535 | + |
1536 | +latex: |
1537 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex |
1538 | + @echo |
1539 | + @echo "Build finished; the LaTeX files are in _build/latex." |
1540 | + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
1541 | + "run these through (pdf)latex." |
1542 | + |
1543 | +changes: |
1544 | + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes |
1545 | + @echo |
1546 | + @echo "The overview file is in _build/changes." |
1547 | + |
1548 | +linkcheck: |
1549 | + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck |
1550 | + @echo |
1551 | + @echo "Link check complete; look for any errors in the above output " \ |
1552 | + "or in _build/linkcheck/output.txt." |
1553 | + |
1554 | +doctest: |
1555 | + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest |
1556 | + @echo "Testing of doctests in the sources finished, look at the " \ |
1557 | + "results in _build/doctest/output.txt." |
1558 | |
1559 | === added directory 'doc/developers/_static' |
1560 | === added file 'doc/developers/_static/bzr icon 16.png' |
1561 | Binary files doc/developers/_static/bzr icon 16.png 1970-01-01 00:00:00 +0000 and doc/developers/_static/bzr icon 16.png 2009-09-07 07:44:36 +0000 differ |
1562 | === added file 'doc/developers/_static/bzr.ico' |
1563 | Binary files doc/developers/_static/bzr.ico 1970-01-01 00:00:00 +0000 and doc/developers/_static/bzr.ico 2009-09-07 07:44:36 +0000 differ |
1564 | === added directory 'doc/developers/_templates' |
1565 | === added file 'doc/developers/_templates/layout.html' |
1566 | --- doc/developers/_templates/layout.html 1970-01-01 00:00:00 +0000 |
1567 | +++ doc/developers/_templates/layout.html 2009-09-07 07:44:36 +0000 |
1568 | @@ -0,0 +1,8 @@ |
1569 | +{% extends "!layout.html" %} |
1570 | + |
1571 | +{% block rootrellink %} |
1572 | +<li><a href="http://bazaar-vcs.org/"> |
1573 | + <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Home</a> | </li> |
1574 | +<a href="http://doc.bazaar-vcs.org/en/">Documentation</a> | </li> |
1575 | +{{ super() }} |
1576 | +{% endblock %} |
1577 | |
1578 | === added file 'doc/developers/conf.py' |
1579 | --- doc/developers/conf.py 1970-01-01 00:00:00 +0000 |
1580 | +++ doc/developers/conf.py 2009-09-07 07:44:36 +0000 |
1581 | @@ -0,0 +1,218 @@ |
1582 | +# -*- coding: utf-8 -*- |
1583 | +# |
1584 | +# Bazaar documentation build configuration file, created by |
1585 | +# sphinx-quickstart on Tue Jul 21 17:04:52 2009. |
1586 | +# |
1587 | +# This file is execfile()d with the current directory set to its containing dir. |
1588 | +# |
1589 | +# Note that not all possible configuration values are present in this |
1590 | +# autogenerated file. |
1591 | +# |
1592 | +# All configuration values have a default; values that are commented out |
1593 | +# serve to show the default. |
1594 | + |
1595 | +import sys, os |
1596 | + |
1597 | +# If extensions (or modules to document with autodoc) are in another directory, |
1598 | +# add these directories to sys.path here. If the directory is relative to the |
1599 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
1600 | +#sys.path.append(os.path.abspath('.')) |
1601 | + |
1602 | +# -- Bazaar-specific configuration --------------------------------------------- |
1603 | + |
1604 | +# NOTE: Editing this section is generally all that is required ... |
1605 | + |
1606 | +# We *could* get this from bzrlib but there's no certainly that the bzr on |
1607 | +# the Python path is indeed the one we're building the documentation for ... |
1608 | +bzr_version = (2, 0, 0, 'rc', 2) |
1609 | + |
1610 | + |
1611 | +# -- General configuration ----------------------------------------------------- |
1612 | + |
1613 | +# Add any Sphinx extension module names here, as strings. They can be extensions |
1614 | +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
1615 | +extensions = ['sphinx.ext.ifconfig'] |
1616 | + |
1617 | +# Add any paths that contain templates here, relative to this directory. |
1618 | +templates_path = ['_templates'] |
1619 | + |
1620 | +# The suffix of source filenames. |
1621 | +source_suffix = '.txt' |
1622 | + |
1623 | +# The encoding of source files. |
1624 | +#source_encoding = 'utf-8' |
1625 | + |
1626 | +# The master toctree document. |
1627 | +master_doc = 'index' |
1628 | + |
1629 | +# General information about the project. |
1630 | +project = u'Bazaar' |
1631 | +copyright = u'2009, Canonical Ltd' |
1632 | + |
1633 | +# The version info for the project you're documenting, acts as replacement for |
1634 | +# |version| and |release|, also used in various other places throughout the |
1635 | +# built documents. |
1636 | +# |
1637 | +# The short X.Y version. |
1638 | +version = '.'.join(str(p) for p in bzr_version[:3]) |
1639 | +# The full version, including alpha/beta/rc tags. |
1640 | +release = version + ''.join(str(p) for p in bzr_version[3:]) |
1641 | + |
1642 | +# The language for content autogenerated by Sphinx. Refer to documentation |
1643 | +# for a list of supported languages. |
1644 | +#language = None |
1645 | + |
1646 | +# There are two options for replacing |today|: either, you set today to some |
1647 | +# non-false value, then it is used: |
1648 | +#today = '' |
1649 | +# Else, today_fmt is used as the format for a strftime call. |
1650 | +#today_fmt = '%B %d, %Y' |
1651 | + |
1652 | +# List of documents that shouldn't be included in the build. |
1653 | +#unused_docs = [] |
1654 | + |
1655 | +# List of directories, relative to source directory, that shouldn't be searched |
1656 | +# for source files. |
1657 | +exclude_trees = ['_build'] |
1658 | + |
1659 | +# The reST default role (used for this markup: `text`) to use for all documents. |
1660 | +#default_role = None |
1661 | + |
1662 | +# If true, '()' will be appended to :func: etc. cross-reference text. |
1663 | +#add_function_parentheses = True |
1664 | + |
1665 | +# If true, the current module name will be prepended to all description |
1666 | +# unit titles (such as .. function::). |
1667 | +#add_module_names = True |
1668 | + |
1669 | +# If true, sectionauthor and moduleauthor directives will be shown in the |
1670 | +# output. They are ignored by default. |
1671 | +#show_authors = False |
1672 | + |
1673 | +# The name of the Pygments (syntax highlighting) style to use. |
1674 | +pygments_style = 'sphinx' |
1675 | + |
1676 | +# A list of ignored prefixes for module index sorting. |
1677 | +#modindex_common_prefix = [] |
1678 | + |
1679 | + |
1680 | +# -- Options for HTML output --------------------------------------------------- |
1681 | + |
1682 | +# The theme to use for HTML and HTML Help pages. Major themes that come with |
1683 | +# Sphinx are currently 'default' and 'sphinxdoc'. |
1684 | +html_theme = 'default' |
1685 | + |
1686 | +# Theme options are theme-specific and customize the look and feel of a theme |
1687 | +# further. For a list of options available for each theme, see the |
1688 | +# documentation. |
1689 | +html_theme_options = { |
1690 | + 'rightsidebar': True, |
1691 | + |
1692 | + # Non-document areas: header (relbar), footer, sidebar, etc. |
1693 | + # Some useful colours here: |
1694 | + # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue, |
1695 | + # midnightblue |
1696 | + # * gray: dimgray, slategray, lightslategray |
1697 | + 'sidebarbgcolor': "cornflowerblue", |
1698 | + 'sidebarlinkcolor': "midnightblue", |
1699 | + 'relbarbgcolor': "darkblue", |
1700 | + 'footerbgcolor': "lightslategray", |
1701 | + |
1702 | + # Text, heading and code colouring |
1703 | + 'codebgcolor': "lightyellow", |
1704 | + 'codetextcolor': "firebrick", |
1705 | + 'linkcolor': "mediumblue", |
1706 | + } |
1707 | + |
1708 | +# Add any paths that contain custom themes here, relative to this directory. |
1709 | +#html_theme_path = [] |
1710 | + |
1711 | +# The name for this set of Sphinx documents. If None, it defaults to |
1712 | +# "<project> v<release> documentation". |
1713 | +#html_title = None |
1714 | + |
1715 | +# A shorter title for the navigation bar. Default is the same as html_title. |
1716 | +html_short_title = "Table of Contents (%s)" % (release,) |
1717 | + |
1718 | +# The name of an image file (relative to this directory) to place at the top |
1719 | +# of the sidebar. |
1720 | +#html_logo = None |
1721 | + |
1722 | +# The name of an image file (within the static path) to use as favicon of the |
1723 | +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
1724 | +# pixels large. |
1725 | +html_favicon = "bzr.ico" |
1726 | + |
1727 | +# Add any paths that contain custom static files (such as style sheets) here, |
1728 | +# relative to this directory. They are copied after the builtin static files, |
1729 | +# so a file named "default.css" will overwrite the builtin "default.css". |
1730 | +html_static_path = ['_static'] |
1731 | + |
1732 | +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
1733 | +# using the given strftime format. |
1734 | +#html_last_updated_fmt = '%b %d, %Y' |
1735 | + |
1736 | +# If true, SmartyPants will be used to convert quotes and dashes to |
1737 | +# typographically correct entities. |
1738 | +#html_use_smartypants = True |
1739 | + |
1740 | +# Custom sidebar templates, maps document names to template names. |
1741 | +#html_sidebars = {} |
1742 | + |
1743 | +# Additional templates that should be rendered to pages, maps page names to |
1744 | +# template names. |
1745 | +#html_additional_pages = {'index': 'index.html'} |
1746 | + |
1747 | +# If false, no module index is generated. |
1748 | +html_use_modindex = False |
1749 | + |
1750 | +# If false, no index is generated. |
1751 | +html_use_index = False |
1752 | + |
1753 | +# If true, the index is split into individual pages for each letter. |
1754 | +#html_split_index = False |
1755 | + |
1756 | +# If true, links to the reST sources are added to the pages. |
1757 | +html_show_sourcelink = True |
1758 | + |
1759 | +# If true, an OpenSearch description file will be output, and all pages will |
1760 | +# contain a <link> tag referring to it. The value of this option must be the |
1761 | +# base URL from which the finished HTML is served. |
1762 | +#html_use_opensearch = '' |
1763 | + |
1764 | +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
1765 | +#html_file_suffix = '' |
1766 | + |
1767 | +# Output file base name for HTML help builder. |
1768 | +htmlhelp_basename = 'bzr-en-devel-docs' |
1769 | + |
1770 | + |
1771 | +# -- Options for LaTeX output -------------------------------------------------- |
1772 | + |
1773 | +# The paper size ('letter' or 'a4'). |
1774 | +#latex_paper_size = 'letter' |
1775 | + |
1776 | +# The font size ('10pt', '11pt' or '12pt'). |
1777 | +#latex_font_size = '10pt' |
1778 | + |
1779 | +# Grouping the document tree into LaTeX files. List of tuples |
1780 | +# (source start file, target name, title, author, documentclass [howto/manual]). |
1781 | +latex_documents = [ |
1782 | +] |
1783 | + |
1784 | +# The name of an image file (relative to this directory) to place at the top of |
1785 | +# the title page. |
1786 | +latex_logo = '../Bazaar-Logo-For-Manuals.png' |
1787 | + |
1788 | +# For "manual" documents, if this is true, then toplevel headings are parts, |
1789 | +# not chapters. |
1790 | +#latex_use_parts = False |
1791 | + |
1792 | +# Additional stuff for the LaTeX preamble. |
1793 | +#latex_preamble = '' |
1794 | + |
1795 | +# Documents to append as an appendix to all manuals. |
1796 | +#latex_appendices = [] |
1797 | + |
1798 | +# If false, no module index is generated. |
1799 | +#latex_use_modindex = True |
1800 | |
1801 | === added file 'doc/developers/implementation-notes.txt' |
1802 | --- doc/developers/implementation-notes.txt 1970-01-01 00:00:00 +0000 |
1803 | +++ doc/developers/implementation-notes.txt 2009-09-07 07:44:36 +0000 |
1804 | @@ -0,0 +1,28 @@ |
1805 | +Implementation notes |
1806 | +==================== |
1807 | + |
1808 | +.. toctree:: |
1809 | + :hidden: |
1810 | + |
1811 | + btree_index_prefetch |
1812 | + last-modified |
1813 | + content-filtering |
1814 | + lca_tree_merging |
1815 | + |
1816 | + |
1817 | +* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides |
1818 | + to pre-read extra nodes in the btree index. |
1819 | + |
1820 | +* `Computing last_modified values <last-modified.html>`_ for inventory |
1821 | + entries |
1822 | + |
1823 | +* `Content filtering <content-filtering.html>`_ |
1824 | + |
1825 | +* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when |
1826 | + there is not a single unique ancestor (criss-cross merge). |
1827 | + |
1828 | + |
1829 | +.. |--| unicode:: U+2014 |
1830 | + |
1831 | +.. |
1832 | + vim: ft=rst tw=74 ai |
1833 | |
1834 | === modified file 'doc/developers/index.txt' |
1835 | --- doc/developers/index.txt 2009-08-26 03:20:32 +0000 |
1836 | +++ doc/developers/index.txt 2009-09-07 07:44:36 +0000 |
1837 | @@ -2,142 +2,56 @@ |
1838 | Bazaar Developer Document Catalog |
1839 | ================================= |
1840 | |
1841 | - |
1842 | -Overall developer documentation |
1843 | -=============================== |
1844 | - |
1845 | -* `Developer Guide <../en/developer-guide/HACKING.html>`_ |
1846 | - |
1847 | -* `Architectural Overview <overview.html>`_ |--| describes some of the |
1848 | - most important classes and concepts. |
1849 | +.. toctree:: |
1850 | + :hidden: |
1851 | + |
1852 | + process |
1853 | + HACKING |
1854 | + testing |
1855 | + overview |
1856 | + integration |
1857 | + plans |
1858 | + specifications |
1859 | + implementation-notes |
1860 | + miscellaneous-notes |
1861 | + |
1862 | + |
1863 | +Core developer documentation |
1864 | +============================ |
1865 | + |
1866 | +* `Process Docs <process.html>`_ |--| How Bazaar is developed |
1867 | + |
1868 | +* `Developer Guide <HACKING.html>`_ |--| Guide to writing code for Bazaar |
1869 | + |
1870 | +* `Testing Guide <testing.html>`_ |--| Guide to writing tests for Bazaar |
1871 | + |
1872 | +* `Writer Guide <http://bazaar-vcs.org/ContributingToTheDocs>`_ (web link) |
1873 | + |--| Guide to writing documentation for Bazaar |
1874 | + |
1875 | +* `Architectural Overview <overview.html>`_ |--| Describes some of the |
1876 | + most important classes and concepts |
1877 | + |
1878 | +* `Integration Guide <integration.html>`_ |--| A guide to integrating Bazaar |
1879 | + into other applications |
1880 | + |
1881 | +* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (web link) |
1882 | + |--| Advice on writing Bazaar plugins |
1883 | |
1884 | * `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_ |
1885 | - (external link) |
1886 | - |--| automatically generated API reference information |
1887 | - |
1888 | -* `Integrating with Bazaar <http://bazaar-vcs.org/Integrating_with_Bazaar>`_ |
1889 | - (wiki) |--| a guide for writing Python programs that work with Bazaar. |
1890 | - |
1891 | -* `Revision Properties <revision-properties.html>`_ |--| An application |
1892 | - can set arbitrary per-revision key/value pairs to store app-specific |
1893 | - data. |
1894 | - |
1895 | -* `Testing <testing.html>`_ |--| Guide to writing tests for Bazaar. |
1896 | - |
1897 | -* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki) |
1898 | - |--| specific advice on writing Bazaar plugins. |
1899 | - |
1900 | -Process |
1901 | -======= |
1902 | - |
1903 | -* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly |
1904 | - development cycle and how to run it. |
1905 | - |
1906 | -* `Releasing Bazaar <releasing.html>`_ |--| |
1907 | - Checklist to make a release of Bazaar. |
1908 | - |
1909 | -* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu. |
1910 | - |
1911 | -* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get |
1912 | - your changes to Bazaar integrated into a release. |
1913 | - |
1914 | -* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile |
1915 | - bzr code and visualize the results. |
1916 | - |
1917 | -* `EC2 resources <ec2.html>`_ |--| A team resource for |
1918 | - Windows packaging and testing, and Ubuntu testing. |
1919 | - |
1920 | -* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug |
1921 | - tracker. |
1922 | - |
1923 | -Plans |
1924 | -===== |
1925 | - |
1926 | -* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap |
1927 | - for fixing performance in bzr over the next few releases. |
1928 | - |
1929 | -* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support |
1930 | - for storing multiple branches in one file-system directory. |
1931 | - |
1932 | -* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--| |
1933 | - Implmentation strategy for Bazaar Windows Shell Extensions, aka |
1934 | - TortoiseBzr. |
1935 | - |
1936 | -* `CHK Optimized index <improved_chk_index.html>`_ |
1937 | - |
1938 | -Specifications |
1939 | -============== |
1940 | - |
1941 | -* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning. |
1942 | - |
1943 | -* `Apport error reporting <apport.html>`_ |--| Capture data to report |
1944 | - bugs. |
1945 | - |
1946 | -* `Authentication ring <authentication-ring.html>`_ |--| Configuring |
1947 | - authentication. |
1948 | - |
1949 | -* `Bundles <bundles.html>`_ |--| All about bzr bundles. |
1950 | - |
1951 | -* `Container format <container-format.html>`_ |--| Notes on a container format |
1952 | - for streaming and storing Bazaar data. |
1953 | - |
1954 | -* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression |
1955 | - technology used in CHK repositories. |
1956 | - |
1957 | -* `Indices <indices.html>`_ |--| The index facilities available within bzrlib. |
1958 | - |
1959 | -* `Inventories <inventory.html>`_ |--| Tree shape abstraction. |
1960 | - |
1961 | -* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm. |
1962 | - |
1963 | -* `Network protocol <network-protocol.html>`_ |--| Custom network protocol. |
1964 | - |
1965 | -* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use. |
1966 | - |
1967 | -* `Repositories <repository.html>`_ |--| What repositories do and are used for. |
1968 | - |
1969 | -* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data |
1970 | - for repositories (a layer above the container format). |
1971 | - |
1972 | -* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into |
1973 | - any python application. |
1974 | - |
1975 | -* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_ |
1976 | - |--| How Bazaar operates on case-insensitive file systems such as commonly |
1977 | - found on Windows, USB sticks, etc. |
1978 | - |
1979 | -* `Development repository formats <development-repo.html>`_ |--| How to |
1980 | - work with repository formats that are still under development. |
1981 | - Contains instructions for those implementing new formats, of course, |
1982 | - but also for (bleeding-edge) end users of those formats. |
1983 | - |
1984 | -Data formats |
1985 | -============ |
1986 | - |
1987 | -* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories |
1988 | - (new in Bazaar 0.92). |
1989 | - |
1990 | -Implementation notes |
1991 | -==================== |
1992 | - |
1993 | -* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides |
1994 | - to pre-read extra nodes in the btree index. |
1995 | - |
1996 | -* `Computing last_modified values <last-modified.html>`_ for inventory |
1997 | - entries |
1998 | - |
1999 | -* `Content filtering <content-filtering.html>`_ |
2000 | - |
2001 | -* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when |
2002 | - there is not a single unique ancestor (criss-cross merge). |
2003 | - |
2004 | -Miscellaneous |
2005 | -============= |
2006 | - |
2007 | -* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file |
2008 | - |
2009 | -* `"bzr update" performance analysis <update.html>`_ |--| "bzr update" |
2010 | - performance analysis |
2011 | + (web link) |
2012 | + |--| Automatically generated API reference information |
2013 | + |
2014 | + |
2015 | +Other developer documentation |
2016 | +============================= |
2017 | + |
2018 | +* `Plans <plans.html>`_ |
2019 | + |
2020 | +* `Specifications <specifications.html>`_ |
2021 | + |
2022 | +* `Implementation notes <implementation-notes.html>`_ |
2023 | + |
2024 | +* `Miscellaneous notes <miscellaneous-notes.html>`_ |
2025 | |
2026 | |
2027 | .. |--| unicode:: U+2014 |
2028 | |
2029 | === added file 'doc/developers/make.bat' |
2030 | --- doc/developers/make.bat 1970-01-01 00:00:00 +0000 |
2031 | +++ doc/developers/make.bat 2009-09-07 07:44:36 +0000 |
2032 | @@ -0,0 +1,112 @@ |
2033 | +@ECHO OFF |
2034 | + |
2035 | +REM Command file for Sphinx documentation |
2036 | + |
2037 | +set SPHINXBUILD=sphinx-build |
2038 | +set ALLSPHINXOPTS=-d _build/doctrees %SPHINXOPTS% . |
2039 | +if NOT "%PAPER%" == "" ( |
2040 | + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% |
2041 | +) |
2042 | + |
2043 | +if "%1" == "" goto help |
2044 | + |
2045 | +if "%1" == "help" ( |
2046 | + :help |
2047 | + echo.Please use `make ^<target^>` where ^<target^> is one of |
2048 | + echo. html to make standalone HTML files |
2049 | + echo. dirhtml to make HTML files named index.html in directories |
2050 | + echo. pickle to make pickle files |
2051 | + echo. json to make JSON files |
2052 | + echo. htmlhelp to make HTML files and a HTML help project |
2053 | + echo. qthelp to make HTML files and a qthelp project |
2054 | + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
2055 | + echo. changes to make an overview over all changed/added/deprecated items |
2056 | + echo. linkcheck to check all external links for integrity |
2057 | + echo. doctest to run all doctests embedded in the documentation if enabled |
2058 | + goto end |
2059 | +) |
2060 | + |
2061 | +if "%1" == "clean" ( |
2062 | + for /d %%i in (_build\*) do rmdir /q /s %%i |
2063 | + del /q /s _build\* |
2064 | + goto end |
2065 | +) |
2066 | + |
2067 | +if "%1" == "html" ( |
2068 | + %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html |
2069 | + echo. |
2070 | + echo.Build finished. The HTML pages are in _build/html. |
2071 | + goto end |
2072 | +) |
2073 | + |
2074 | +if "%1" == "dirhtml" ( |
2075 | + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% _build/dirhtml |
2076 | + echo. |
2077 | + echo.Build finished. The HTML pages are in _build/dirhtml. |
2078 | + goto end |
2079 | +) |
2080 | + |
2081 | +if "%1" == "pickle" ( |
2082 | + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle |
2083 | + echo. |
2084 | + echo.Build finished; now you can process the pickle files. |
2085 | + goto end |
2086 | +) |
2087 | + |
2088 | +if "%1" == "json" ( |
2089 | + %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json |
2090 | + echo. |
2091 | + echo.Build finished; now you can process the JSON files. |
2092 | + goto end |
2093 | +) |
2094 | + |
2095 | +if "%1" == "htmlhelp" ( |
2096 | + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp |
2097 | + echo. |
2098 | + echo.Build finished; now you can run HTML Help Workshop with the ^ |
2099 | +.hhp project file in _build/htmlhelp. |
2100 | + goto end |
2101 | +) |
2102 | + |
2103 | +if "%1" == "qthelp" ( |
2104 | + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp |
2105 | + echo. |
2106 | + echo.Build finished; now you can run "qcollectiongenerator" with the ^ |
2107 | +.qhcp project file in _build/qthelp, like this: |
2108 | + echo.^> qcollectiongenerator _build\qthelp\Bazaar.qhcp |
2109 | + echo.To view the help file: |
2110 | + echo.^> assistant -collectionFile _build\qthelp\Bazaar.ghc |
2111 | + goto end |
2112 | +) |
2113 | + |
2114 | +if "%1" == "latex" ( |
2115 | + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% _build/latex |
2116 | + echo. |
2117 | + echo.Build finished; the LaTeX files are in _build/latex. |
2118 | + goto end |
2119 | +) |
2120 | + |
2121 | +if "%1" == "changes" ( |
2122 | + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes |
2123 | + echo. |
2124 | + echo.The overview file is in _build/changes. |
2125 | + goto end |
2126 | +) |
2127 | + |
2128 | +if "%1" == "linkcheck" ( |
2129 | + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck |
2130 | + echo. |
2131 | + echo.Link check complete; look for any errors in the above output ^ |
2132 | +or in _build/linkcheck/output.txt. |
2133 | + goto end |
2134 | +) |
2135 | + |
2136 | +if "%1" == "doctest" ( |
2137 | + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest |
2138 | + echo. |
2139 | + echo.Testing of doctests in the sources finished, look at the ^ |
2140 | +results in _build/doctest/output.txt. |
2141 | + goto end |
2142 | +) |
2143 | + |
2144 | +:end |
2145 | |
2146 | === added file 'doc/developers/miscellaneous-notes.txt' |
2147 | --- doc/developers/miscellaneous-notes.txt 1970-01-01 00:00:00 +0000 |
2148 | +++ doc/developers/miscellaneous-notes.txt 2009-09-07 07:44:36 +0000 |
2149 | @@ -0,0 +1,20 @@ |
2150 | +Miscellaneous notes |
2151 | +=================== |
2152 | + |
2153 | +.. toctree:: |
2154 | + :hidden: |
2155 | + |
2156 | + dirstate |
2157 | + update |
2158 | + |
2159 | + |
2160 | +* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file |
2161 | + |
2162 | +* `"bzr update" performance analysis <update.html>`_ |--| "bzr update" |
2163 | + performance analysis |
2164 | + |
2165 | + |
2166 | +.. |--| unicode:: U+2014 |
2167 | + |
2168 | +.. |
2169 | + vim: ft=rst tw=74 ai |
2170 | |
2171 | === added file 'doc/developers/plans.txt' |
2172 | --- doc/developers/plans.txt 1970-01-01 00:00:00 +0000 |
2173 | +++ doc/developers/plans.txt 2009-09-07 07:44:36 +0000 |
2174 | @@ -0,0 +1,29 @@ |
2175 | +Plans |
2176 | +===== |
2177 | + |
2178 | +.. toctree:: |
2179 | + :hidden: |
2180 | + |
2181 | + performance-roadmap |
2182 | + colocated-branches |
2183 | + tortoise-strategy |
2184 | + improved_chk_index |
2185 | + |
2186 | + |
2187 | +* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap |
2188 | + for fixing performance in bzr over the next few releases. |
2189 | + |
2190 | +* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support |
2191 | + for storing multiple branches in one file-system directory. |
2192 | + |
2193 | +* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--| |
2194 | + Implmentation strategy for Bazaar Windows Shell Extensions, aka |
2195 | + TortoiseBzr. |
2196 | + |
2197 | +* `CHK Optimized index <improved_chk_index.html>`_ |
2198 | + |
2199 | + |
2200 | +.. |--| unicode:: U+2014 |
2201 | + |
2202 | +.. |
2203 | + vim: ft=rst tw=74 ai |
2204 | |
2205 | === added file 'doc/developers/process.txt' |
2206 | --- doc/developers/process.txt 1970-01-01 00:00:00 +0000 |
2207 | +++ doc/developers/process.txt 2009-09-07 07:44:36 +0000 |
2208 | @@ -0,0 +1,39 @@ |
2209 | +Process Docs |
2210 | +============ |
2211 | + |
2212 | +.. toctree:: |
2213 | + :hidden: |
2214 | + |
2215 | + cycle |
2216 | + releasing |
2217 | + ppa |
2218 | + profiling |
2219 | + ec2 |
2220 | + bug-handling |
2221 | + |
2222 | + |
2223 | +* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly |
2224 | + development cycle and how to run it. |
2225 | + |
2226 | +* `Releasing Bazaar <releasing.html>`_ |--| |
2227 | + Checklist to make a release of Bazaar. |
2228 | + |
2229 | +* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu. |
2230 | + |
2231 | +* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get |
2232 | + your changes to Bazaar integrated into a release. |
2233 | + |
2234 | +* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile |
2235 | + bzr code and visualize the results. |
2236 | + |
2237 | +* `EC2 resources <ec2.html>`_ |--| A team resource for |
2238 | + Windows packaging and testing, and Ubuntu testing. |
2239 | + |
2240 | +* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug |
2241 | + tracker. |
2242 | + |
2243 | + |
2244 | +.. |--| unicode:: U+2014 |
2245 | + |
2246 | +.. |
2247 | + vim: ft=rst tw=74 ai |
2248 | |
2249 | === added file 'doc/developers/specifications.txt' |
2250 | --- doc/developers/specifications.txt 1970-01-01 00:00:00 +0000 |
2251 | +++ doc/developers/specifications.txt 2009-09-07 07:44:36 +0000 |
2252 | @@ -0,0 +1,77 @@ |
2253 | +Specifications |
2254 | +============== |
2255 | + |
2256 | +.. toctree:: |
2257 | + :hidden: |
2258 | + |
2259 | + revision-properties |
2260 | + api-versioning |
2261 | + apport |
2262 | + authentication-ring |
2263 | + bundles |
2264 | + container-format |
2265 | + groupcompress-design |
2266 | + indices |
2267 | + inventory |
2268 | + lca-merge |
2269 | + network-protocol |
2270 | + plugin-api |
2271 | + repository |
2272 | + repository-stream |
2273 | + case-insensitive-file-systems |
2274 | + development-repo |
2275 | + packrepo |
2276 | + |
2277 | + |
2278 | +* `Revision Properties <revision-properties.html>`_ |--| An application |
2279 | + can set arbitrary per-revision key/value pairs to store app-specific |
2280 | + data. |
2281 | + |
2282 | +* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning. |
2283 | + |
2284 | +* `Apport error reporting <apport.html>`_ |--| Capture data to report |
2285 | + bugs. |
2286 | + |
2287 | +* `Authentication ring <authentication-ring.html>`_ |--| Configuring |
2288 | + authentication. |
2289 | + |
2290 | +* `Bundles <bundles.html>`_ |--| All about bzr bundles. |
2291 | + |
2292 | +* `Container format <container-format.html>`_ |--| Notes on a container format |
2293 | + for streaming and storing Bazaar data. |
2294 | + |
2295 | +* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression |
2296 | + technology used in CHK repositories. |
2297 | + |
2298 | +* `Indices <indices.html>`_ |--| The index facilities available within bzrlib. |
2299 | + |
2300 | +* `Inventories <inventory.html>`_ |--| Tree shape abstraction. |
2301 | + |
2302 | +* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm. |
2303 | + |
2304 | +* `Network protocol <network-protocol.html>`_ |--| Custom network protocol. |
2305 | + |
2306 | +* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use. |
2307 | + |
2308 | +* `Repositories <repository.html>`_ |--| What repositories do and are used for. |
2309 | + |
2310 | +* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data |
2311 | + for repositories (a layer above the container format). |
2312 | + |
2313 | +* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_ |
2314 | + |--| How Bazaar operates on case-insensitive file systems such as commonly |
2315 | + found on Windows, USB sticks, etc. |
2316 | + |
2317 | +* `Development repository formats <development-repo.html>`_ |--| How to |
2318 | + work with repository formats that are still under development. |
2319 | + Contains instructions for those implementing new formats, of course, |
2320 | + but also for (bleeding-edge) end users of those formats. |
2321 | + |
2322 | +* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories |
2323 | + (new in Bazaar 0.92). |
2324 | + |
2325 | + |
2326 | +.. |--| unicode:: U+2014 |
2327 | + |
2328 | +.. |
2329 | + vim: ft=rst tw=74 ai |
2330 | |
2331 | === removed directory 'doc/en/developer-guide' |
2332 | === modified file 'doc/en/mini-tutorial/index.txt' |
2333 | --- doc/en/mini-tutorial/index.txt 2009-04-04 02:50:01 +0000 |
2334 | +++ doc/en/mini-tutorial/index.txt 2009-09-02 16:03:51 +0000 |
2335 | @@ -2,8 +2,6 @@ |
2336 | Bazaar in five minutes |
2337 | ====================== |
2338 | |
2339 | -.. contents:: |
2340 | - |
2341 | Introduction |
2342 | ============ |
2343 | |
2344 | |
2345 | === modified file 'doc/en/tutorials/centralized_workflow.txt' |
2346 | --- doc/en/tutorials/centralized_workflow.txt 2009-07-22 13:41:01 +0000 |
2347 | +++ doc/en/tutorials/centralized_workflow.txt 2009-09-02 16:03:51 +0000 |
2348 | @@ -1,6 +1,6 @@ |
2349 | -==================== |
2350 | -Centralized Workflow |
2351 | -==================== |
2352 | +============================= |
2353 | +Centralized Workflow Tutorial |
2354 | +============================= |
2355 | |
2356 | |
2357 | Overview |
2358 | @@ -23,8 +23,6 @@ |
2359 | |
2360 | .. _Bazaar: http://bazaar-vcs.org |
2361 | |
2362 | -.. contents:: |
2363 | - |
2364 | |
2365 | Initial Setup |
2366 | ============= |
2367 | |
2368 | === modified file 'doc/en/tutorials/tutorial.txt' |
2369 | --- doc/en/tutorials/tutorial.txt 2009-06-27 08:10:13 +0000 |
2370 | +++ doc/en/tutorials/tutorial.txt 2009-09-02 16:03:51 +0000 |
2371 | @@ -11,8 +11,6 @@ |
2372 | Bazaar Tutorial |
2373 | =============== |
2374 | |
2375 | -Current for bzr-0.91, 2007-08 |
2376 | - |
2377 | |
2378 | Introduction |
2379 | ============ |
2380 | @@ -24,8 +22,8 @@ |
2381 | different." Otherwise, get some coffee or tea, get comfortable and get |
2382 | ready to catch up. |
2383 | |
2384 | -The Purposes of Revision Control |
2385 | -================================ |
2386 | +The purpose of revision control |
2387 | +=============================== |
2388 | |
2389 | Odds are that you have worked on some sort of textual data -- the sources |
2390 | to a program, web sites or the config files that Unix system |
2391 | @@ -57,8 +55,8 @@ |
2392 | We keep these logs so that if later there is some sort of problem with |
2393 | sftp, we can figure out when the problem probably happened. |
2394 | |
2395 | -How DRCS is Different |
2396 | ---------------------- |
2397 | +How DRCS is different |
2398 | +===================== |
2399 | |
2400 | Many Revision Control Systems (RCS) are stored on servers. If one wants to |
2401 | work on the code stored within an RCS, then one needs to connect to the |
2402 | @@ -282,6 +280,7 @@ |
2403 | As a shortcut, ``bzr diff -p1`` produces a form that works with the |
2404 | command ``patch -p1``. |
2405 | |
2406 | + |
2407 | Committing changes |
2408 | ================== |
2409 | |
2410 | @@ -308,7 +307,7 @@ |
2411 | can also be useful when you pick up your work after a break.) |
2412 | |
2413 | Message from an editor |
2414 | -====================== |
2415 | +---------------------- |
2416 | |
2417 | If you use neither the ``-m`` nor the ``-F`` option then bzr will open an |
2418 | editor for you to enter a message. The editor to run is controlled by |
2419 | @@ -355,9 +354,13 @@ |
2420 | given then only those ones will be affected. ``bzr revert`` also clears the |
2421 | list of pending merges revisions. |
2422 | |
2423 | + |
2424 | Ignoring files |
2425 | ============== |
2426 | |
2427 | +The .bzrignore file |
2428 | +------------------- |
2429 | + |
2430 | Many source trees contain some files that do not need to be versioned, |
2431 | such as editor backups, object or bytecode files, and built programs. You |
2432 | can simply not add them, but then they'll always crop up as unknown files. |
2433 | @@ -400,7 +403,7 @@ |
2434 | % bzr commit -m "Add ignore patterns" |
2435 | |
2436 | |
2437 | -Global Ignores |
2438 | +Global ignores |
2439 | -------------- |
2440 | |
2441 | There are some ignored files which are not project specific, but more user |
2442 | @@ -574,6 +577,7 @@ |
2443 | rsync, or other related file transfer methods. This is usually less safe |
2444 | than using ``push``, but may be faster or easier in some situations. |
2445 | |
2446 | + |
2447 | Moving changes between trees |
2448 | ============================ |
2449 | |
2450 | |
2451 | === modified file 'doc/en/tutorials/using_bazaar_with_launchpad.txt' |
2452 | --- doc/en/tutorials/using_bazaar_with_launchpad.txt 2009-07-22 13:41:01 +0000 |
2453 | +++ doc/en/tutorials/using_bazaar_with_launchpad.txt 2009-09-02 16:03:51 +0000 |
2454 | @@ -2,8 +2,6 @@ |
2455 | Using Bazaar with Launchpad |
2456 | =========================== |
2457 | |
2458 | -.. contents:: |
2459 | - |
2460 | |
2461 | Motivation |
2462 | ========== |
2463 | |
2464 | === modified file 'doc/en/upgrade-guide/index.txt' |
2465 | --- doc/en/upgrade-guide/index.txt 2009-07-22 13:41:01 +0000 |
2466 | +++ doc/en/upgrade-guide/index.txt 2009-09-02 16:03:51 +0000 |
2467 | @@ -8,8 +8,6 @@ |
2468 | .. level 3 ~~~~~~~~ |
2469 | .. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels) |
2470 | |
2471 | -.. contents:: |
2472 | - |
2473 | .. include:: overview.txt |
2474 | .. include:: data_migration.txt |
2475 | .. include:: tips_and_tricks.txt |
2476 | |
2477 | === removed file 'doc/en/user-guide/index.txt' |
2478 | --- doc/en/user-guide/index.txt 2009-07-26 15:58:33 +0000 |
2479 | +++ doc/en/user-guide/index.txt 1970-01-01 00:00:00 +0000 |
2480 | @@ -1,118 +0,0 @@ |
2481 | -################# |
2482 | -Bazaar User Guide |
2483 | -################# |
2484 | - |
2485 | -.. Please mark sections in included files as following: |
2486 | -.. level 1 ======== |
2487 | -.. level 2 -------- |
2488 | -.. level 3 ~~~~~~~~ |
2489 | -.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels) |
2490 | - |
2491 | -.. contents:: :depth: 3 |
2492 | - |
2493 | - |
2494 | -Introduction |
2495 | -############ |
2496 | - |
2497 | -.. include:: introducing_bazaar.txt |
2498 | -.. include:: core_concepts.txt |
2499 | -.. include:: bazaar_workflows.txt |
2500 | - |
2501 | - |
2502 | -Getting started |
2503 | -############### |
2504 | - |
2505 | -.. include:: installing_bazaar.txt |
2506 | -.. include:: entering_commands.txt |
2507 | -.. include:: getting_help.txt |
2508 | -.. include:: configuring_bazaar.txt |
2509 | -.. include:: using_aliases.txt |
2510 | -.. include:: plugins.txt |
2511 | -.. include:: zen.txt |
2512 | - |
2513 | - |
2514 | -Personal version control |
2515 | -######################## |
2516 | - |
2517 | -.. include:: solo_intro.txt |
2518 | -.. include:: starting_a_project.txt |
2519 | -.. include:: controlling_registration.txt |
2520 | -.. include:: reviewing_changes.txt |
2521 | -.. include:: recording_changes.txt |
2522 | -.. include:: browsing_history.txt |
2523 | -.. include:: releasing_a_project.txt |
2524 | -.. include:: undoing_mistakes.txt |
2525 | - |
2526 | - |
2527 | -Sharing with peers |
2528 | -################## |
2529 | - |
2530 | -.. include:: partner_intro.txt |
2531 | -.. include:: branching_a_project.txt |
2532 | -.. include:: merging_changes.txt |
2533 | -.. include:: resolving_conflicts.txt |
2534 | -.. include:: annotating_changes.txt |
2535 | - |
2536 | - |
2537 | -Team collaboration, central style |
2538 | -################################# |
2539 | - |
2540 | -.. include:: central_intro.txt |
2541 | -.. include:: publishing_a_branch.txt |
2542 | -.. include:: using_checkouts.txt |
2543 | -.. include:: working_offline_central.txt |
2544 | -.. include:: reusing_a_checkout.txt |
2545 | - |
2546 | - |
2547 | -Team collaboration, distributed style |
2548 | -##################################### |
2549 | - |
2550 | -.. include:: distributed_intro.txt |
2551 | -.. include:: organizing_branches.txt |
2552 | -.. include:: using_gatekeepers.txt |
2553 | -.. include:: sending_changes.txt |
2554 | - |
2555 | - |
2556 | -Miscellaneous topics |
2557 | -#################### |
2558 | - |
2559 | -.. include:: part2_intro.txt |
2560 | -.. include:: adv_merging.txt |
2561 | -.. include:: shelving_changes.txt |
2562 | -.. include:: filtered_views.txt |
2563 | -.. include:: stacked.txt |
2564 | -.. include:: server.txt |
2565 | -.. include:: hooks.txt |
2566 | -.. include:: version_info.txt |
2567 | - |
2568 | - |
2569 | -A brief tour of some popular plugins |
2570 | -#################################### |
2571 | - |
2572 | -.. include:: bzrtools_plugin.txt |
2573 | -.. include:: svn_plugin.txt |
2574 | -.. include later looms_plugin.txt |
2575 | - |
2576 | - |
2577 | -Integrating Bazaar into your environment |
2578 | -######################################## |
2579 | - |
2580 | -.. include:: web_browsing.txt |
2581 | -.. include later - file_explorers.txt |
2582 | -.. include later - desktop_integration.txt |
2583 | -.. include later - editors_and_ides.txt |
2584 | -.. include later - email.txt |
2585 | -.. include:: bug_trackers.txt |
2586 | - |
2587 | - |
2588 | -Appendices |
2589 | -########## |
2590 | - |
2591 | -.. include:: specifying_revisions.txt |
2592 | -.. include:: organizing_your_workspace.txt |
2593 | -.. include:: shared_repository_layouts.txt |
2594 | -.. include:: setting_up_email.txt |
2595 | -.. include:: http_smart_server.txt |
2596 | -.. include:: writing_a_plugin.txt |
2597 | - |
2598 | -.. |--| unicode:: U+2014 |
2599 | |
2600 | === renamed file 'doc/en/user-guide/index-for-2x.txt' => 'doc/en/user-guide/index.txt' |
2601 | === added file 'doc/es/Makefile' |
2602 | --- doc/es/Makefile 1970-01-01 00:00:00 +0000 |
2603 | +++ doc/es/Makefile 2009-09-07 03:58:08 +0000 |
2604 | @@ -0,0 +1,88 @@ |
2605 | +# Makefile for Sphinx documentation |
2606 | +# |
2607 | + |
2608 | +# You can set these variables from the command line. |
2609 | +SPHINXOPTS = |
2610 | +SPHINXBUILD = sphinx-build |
2611 | +PAPER = |
2612 | + |
2613 | +# Internal variables. |
2614 | +PAPEROPT_a4 = -D latex_paper_size=a4 |
2615 | +PAPEROPT_letter = -D latex_paper_size=letter |
2616 | +ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
2617 | + |
2618 | +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest |
2619 | + |
2620 | +help: |
2621 | + @echo "Please use \`make <target>' where <target> is one of" |
2622 | + @echo " html to make standalone HTML files" |
2623 | + @echo " dirhtml to make HTML files named index.html in directories" |
2624 | + @echo " pickle to make pickle files" |
2625 | + @echo " json to make JSON files" |
2626 | + @echo " htmlhelp to make HTML files and a HTML help project" |
2627 | + @echo " qthelp to make HTML files and a qthelp project" |
2628 | + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
2629 | + @echo " changes to make an overview of all changed/added/deprecated items" |
2630 | + @echo " linkcheck to check all external links for integrity" |
2631 | + @echo " doctest to run all doctests embedded in the documentation (if enabled)" |
2632 | + |
2633 | +clean: |
2634 | + -rm -rf _build/* |
2635 | + |
2636 | +html: |
2637 | + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html |
2638 | + @echo |
2639 | + @echo "Build finished. The HTML pages are in _build/html." |
2640 | + |
2641 | +dirhtml: |
2642 | + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml |
2643 | + @echo |
2644 | + @echo "Build finished. The HTML pages are in _build/dirhtml." |
2645 | + |
2646 | +pickle: |
2647 | + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle |
2648 | + @echo |
2649 | + @echo "Build finished; now you can process the pickle files." |
2650 | + |
2651 | +json: |
2652 | + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json |
2653 | + @echo |
2654 | + @echo "Build finished; now you can process the JSON files." |
2655 | + |
2656 | +htmlhelp: |
2657 | + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp |
2658 | + @echo |
2659 | + @echo "Build finished; now you can run HTML Help Workshop with the" \ |
2660 | + ".hhp project file in _build/htmlhelp." |
2661 | + |
2662 | +qthelp: |
2663 | + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp |
2664 | + @echo |
2665 | + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
2666 | + ".qhcp project file in _build/qthelp, like this:" |
2667 | + @echo "# qcollectiongenerator _build/qthelp/Bazaar.qhcp" |
2668 | + @echo "To view the help file:" |
2669 | + @echo "# assistant -collectionFile _build/qthelp/Bazaar.qhc" |
2670 | + |
2671 | +latex: |
2672 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex |
2673 | + @echo |
2674 | + @echo "Build finished; the LaTeX files are in _build/latex." |
2675 | + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
2676 | + "run these through (pdf)latex." |
2677 | + |
2678 | +changes: |
2679 | + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes |
2680 | + @echo |
2681 | + @echo "The overview file is in _build/changes." |
2682 | + |
2683 | +linkcheck: |
2684 | + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck |
2685 | + @echo |
2686 | + @echo "Link check complete; look for any errors in the above output " \ |
2687 | + "or in _build/linkcheck/output.txt." |
2688 | + |
2689 | +doctest: |
2690 | + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest |
2691 | + @echo "Testing of doctests in the sources finished, look at the " \ |
2692 | + "results in _build/doctest/output.txt." |
2693 | |
2694 | === added directory 'doc/es/_static' |
2695 | === added file 'doc/es/_static/bzr icon 16.png' |
2696 | Binary files doc/es/_static/bzr icon 16.png 1970-01-01 00:00:00 +0000 and doc/es/_static/bzr icon 16.png 2009-09-07 03:58:08 +0000 differ |
2697 | === added file 'doc/es/_static/bzr.ico' |
2698 | Binary files doc/es/_static/bzr.ico 1970-01-01 00:00:00 +0000 and doc/es/_static/bzr.ico 2009-09-07 03:58:08 +0000 differ |
2699 | === added directory 'doc/es/_static/es' |
2700 | === added directory 'doc/es/_static/es/quick-reference' |
2701 | === renamed file 'doc/es/quick-reference/Makefile' => 'doc/es/_static/es/quick-reference/Makefile' |
2702 | --- doc/es/quick-reference/Makefile 2009-06-29 11:02:31 +0000 |
2703 | +++ doc/es/_static/es/quick-reference/Makefile 2009-09-07 03:58:08 +0000 |
2704 | @@ -1,5 +1,5 @@ |
2705 | -TARGETS=quick-start-summary.png quick-start-summary.pdf |
2706 | -OBJECTS=quick-start-summary.svg Makefile |
2707 | +TARGETS=bzr-quick-reference.png bzr-quick-reference.pdf |
2708 | +OBJECTS=bzr-quick-reference.svg Makefile |
2709 | |
2710 | all: $(TARGETS) |
2711 | |
2712 | @@ -11,9 +11,9 @@ |
2713 | .svg.png: |
2714 | rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $< |
2715 | |
2716 | -bzr-quickref.png: $(OBJECTS) |
2717 | +bzr-quick-reference.png: $(OBJECTS) |
2718 | |
2719 | -bzr-quickref.pdf: $(OBJECTS) |
2720 | +bzr-quick-reference.pdf: $(OBJECTS) |
2721 | |
2722 | clean: |
2723 | rm -f $(TARGETS) |
2724 | |
2725 | === renamed file 'doc/es/quick-reference/quick-start-summary.pdf' => 'doc/es/_static/es/quick-reference/bzr-quick-reference.pdf' |
2726 | === renamed file 'doc/es/quick-reference/quick-start-summary.png' => 'doc/es/_static/es/quick-reference/bzr-quick-reference.png' |
2727 | === renamed file 'doc/es/quick-reference/quick-start-summary.svg' => 'doc/es/_static/es/quick-reference/bzr-quick-reference.svg' |
2728 | === added directory 'doc/es/_templates' |
2729 | === added file 'doc/es/_templates/layout.html' |
2730 | --- doc/es/_templates/layout.html 1970-01-01 00:00:00 +0000 |
2731 | +++ doc/es/_templates/layout.html 2009-09-07 06:12:15 +0000 |
2732 | @@ -0,0 +1,8 @@ |
2733 | +{% extends "!layout.html" %} |
2734 | + |
2735 | +{% block rootrellink %} |
2736 | +<li><a href="http://bazaar-vcs.org/"> |
2737 | + <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Inicio</a> | </li> |
2738 | +<a href="http://doc.bazaar-vcs.org/en/">Documentación</a> | </li> |
2739 | +{{ super() }} |
2740 | +{% endblock %} |
2741 | |
2742 | === added file 'doc/es/conf.py' |
2743 | --- doc/es/conf.py 1970-01-01 00:00:00 +0000 |
2744 | +++ doc/es/conf.py 2009-09-07 06:12:15 +0000 |
2745 | @@ -0,0 +1,262 @@ |
2746 | +# -*- coding: utf-8 -*- |
2747 | +# |
2748 | +# Bazaar documentation build configuration file, created by |
2749 | +# sphinx-quickstart on Tue Jul 21 17:04:52 2009. |
2750 | +# |
2751 | +# This file is execfile()d with the current directory set to its containing dir. |
2752 | +# |
2753 | +# Note that not all possible configuration values are present in this |
2754 | +# autogenerated file. |
2755 | +# |
2756 | +# All configuration values have a default; values that are commented out |
2757 | +# serve to show the default. |
2758 | + |
2759 | +import sys, os |
2760 | + |
2761 | +# If extensions (or modules to document with autodoc) are in another directory, |
2762 | +# add these directories to sys.path here. If the directory is relative to the |
2763 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
2764 | +#sys.path.append(os.path.abspath('.')) |
2765 | + |
2766 | + |
2767 | +# -- Bazaar-specific configuration --------------------------------------------- |
2768 | + |
2769 | +# NOTE: Editing this section is generally all that is required ... |
2770 | + |
2771 | +# We *could* get this from bzrlib but there's no certainly that the bzr on |
2772 | +# the Python path is indeed the one we're building the documentation for ... |
2773 | +bzr_version = (2, 0, 0, 'rc', 2) |
2774 | + |
2775 | +# The locale code for this documentation set |
2776 | +bzr_locale = 'es' |
2777 | + |
2778 | +# Authors of the documents |
2779 | +bzr_team = u'Bazaar Developers' |
2780 | + |
2781 | +# Translations |
2782 | +bzr_titles = { |
2783 | + u'Table of Contents (%s)': u'Contenidos (%s)', |
2784 | + u'Bazaar User Guide': u'Guia de Usuario', |
2785 | + u'Bazaar User Reference': None, |
2786 | + u'Bazaar Release Notes': None, |
2787 | + u'Bazaar Upgrade Guide': None, |
2788 | + u'Bazaar in five minutes': u'Bazaar en cinco minutos', |
2789 | + u'Bazaar Tutorial': None, |
2790 | + u'Using Bazaar With Launchpad': None, |
2791 | + u'Centralized Workflow Tutorial': None, |
2792 | + } |
2793 | + |
2794 | +# Helper function for looking up translations |
2795 | +def bzr_title(s): |
2796 | + return bzr_titles.get(s) or s |
2797 | + |
2798 | + |
2799 | +# -- General configuration ----------------------------------------------------- |
2800 | + |
2801 | +# Add any Sphinx extension module names here, as strings. They can be extensions |
2802 | +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
2803 | +extensions = ['sphinx.ext.ifconfig'] |
2804 | + |
2805 | +# Add any paths that contain templates here, relative to this directory. |
2806 | +templates_path = ['_templates'] |
2807 | + |
2808 | +# The suffix of source filenames. |
2809 | +source_suffix = '.txt' |
2810 | + |
2811 | +# The encoding of source files. |
2812 | +#source_encoding = 'utf-8' |
2813 | + |
2814 | +# The master toctree document. |
2815 | +master_doc = 'index' |
2816 | + |
2817 | +# General information about the project. |
2818 | +project = u'Bazaar' |
2819 | +copyright = u'2009, Canonical Ltd' |
2820 | + |
2821 | +# The version info for the project you're documenting, acts as replacement for |
2822 | +# |version| and |release|, also used in various other places throughout the |
2823 | +# built documents. |
2824 | +# |
2825 | +# The short X.Y version. |
2826 | +version = '.'.join(str(p) for p in bzr_version[:3]) |
2827 | +# The full version, including alpha/beta/rc tags. |
2828 | +release = version + ''.join(str(p) for p in bzr_version[3:]) |
2829 | + |
2830 | +# The language for content autogenerated by Sphinx. Refer to documentation |
2831 | +# for a list of supported languages. |
2832 | +language = bzr_locale |
2833 | + |
2834 | +# There are two options for replacing |today|: either, you set today to some |
2835 | +# non-false value, then it is used: |
2836 | +#today = '' |
2837 | +# Else, today_fmt is used as the format for a strftime call. |
2838 | +#today_fmt = '%B %d, %Y' |
2839 | + |
2840 | +# List of documents that shouldn't be included in the build. |
2841 | +#unused_docs = [] |
2842 | + |
2843 | +# List of directories, relative to source directory, that shouldn't be searched |
2844 | +# for source files. |
2845 | +exclude_trees = ['_build'] |
2846 | + |
2847 | +# The reST default role (used for this markup: `text`) to use for all documents. |
2848 | +#default_role = None |
2849 | + |
2850 | +# If true, '()' will be appended to :func: etc. cross-reference text. |
2851 | +#add_function_parentheses = True |
2852 | + |
2853 | +# If true, the current module name will be prepended to all description |
2854 | +# unit titles (such as .. function::). |
2855 | +#add_module_names = True |
2856 | + |
2857 | +# If true, sectionauthor and moduleauthor directives will be shown in the |
2858 | +# output. They are ignored by default. |
2859 | +#show_authors = False |
2860 | + |
2861 | +# The name of the Pygments (syntax highlighting) style to use. |
2862 | +pygments_style = 'sphinx' |
2863 | + |
2864 | +# A list of ignored prefixes for module index sorting. |
2865 | +#modindex_common_prefix = [] |
2866 | + |
2867 | + |
2868 | +# -- Options for HTML output --------------------------------------------------- |
2869 | + |
2870 | +# The theme to use for HTML and HTML Help pages. Major themes that come with |
2871 | +# Sphinx are currently 'default' and 'sphinxdoc'. |
2872 | +html_theme = 'default' |
2873 | + |
2874 | +# Theme options are theme-specific and customize the look and feel of a theme |
2875 | +# further. For a list of options available for each theme, see the |
2876 | +# documentation. |
2877 | +html_theme_options = { |
2878 | + 'rightsidebar': True, |
2879 | + |
2880 | + # Non-document areas: header (relbar), footer, sidebar, etc. |
2881 | + # Some useful colours here: |
2882 | + # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue, |
2883 | + # midnightblue |
2884 | + # * gray: dimgray, slategray, lightslategray |
2885 | + 'sidebarbgcolor': "cornflowerblue", |
2886 | + 'sidebarlinkcolor': "midnightblue", |
2887 | + 'relbarbgcolor': "darkblue", |
2888 | + 'footerbgcolor': "lightslategray", |
2889 | + |
2890 | + # Text, heading and code colouring |
2891 | + 'codebgcolor': "lightyellow", |
2892 | + 'codetextcolor': "firebrick", |
2893 | + 'linkcolor': "mediumblue", |
2894 | + } |
2895 | + |
2896 | +# Add any paths that contain custom themes here, relative to this directory. |
2897 | +#html_theme_path = [] |
2898 | + |
2899 | +# The name for this set of Sphinx documents. If None, it defaults to |
2900 | +# "<project> v<release> documentation". |
2901 | +#html_title = None |
2902 | + |
2903 | +# A shorter title for the navigation bar. Default is the same as html_title. |
2904 | +html_short_title = bzr_title(u"Table of Contents (%s)") % (release,) |
2905 | + |
2906 | +# The name of an image file (relative to this directory) to place at the top |
2907 | +# of the sidebar. |
2908 | +#html_logo = None |
2909 | + |
2910 | +# The name of an image file (within the static path) to use as favicon of the |
2911 | +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
2912 | +# pixels large. |
2913 | +html_favicon = "bzr.ico" |
2914 | + |
2915 | +# Add any paths that contain custom static files (such as style sheets) here, |
2916 | +# relative to this directory. They are copied after the builtin static files, |
2917 | +# so a file named "default.css" will overwrite the builtin "default.css". |
2918 | +html_static_path = ['_static'] |
2919 | + |
2920 | +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
2921 | +# using the given strftime format. |
2922 | +#html_last_updated_fmt = '%b %d, %Y' |
2923 | + |
2924 | +# If true, SmartyPants will be used to convert quotes and dashes to |
2925 | +# typographically correct entities. |
2926 | +#html_use_smartypants = True |
2927 | + |
2928 | +# Custom sidebar templates, maps document names to template names. |
2929 | +#html_sidebars = {} |
2930 | + |
2931 | +# Additional templates that should be rendered to pages, maps page names to |
2932 | +# template names. |
2933 | +#html_additional_pages = {'index': 'index.html'} |
2934 | + |
2935 | +# If false, no module index is generated. |
2936 | +html_use_modindex = False |
2937 | + |
2938 | +# If false, no index is generated. |
2939 | +html_use_index = False |
2940 | + |
2941 | +# If true, the index is split into individual pages for each letter. |
2942 | +#html_split_index = False |
2943 | + |
2944 | +# If true, links to the reST sources are added to the pages. |
2945 | +html_show_sourcelink = True |
2946 | + |
2947 | +# If true, an OpenSearch description file will be output, and all pages will |
2948 | +# contain a <link> tag referring to it. The value of this option must be the |
2949 | +# base URL from which the finished HTML is served. |
2950 | +#html_use_opensearch = '' |
2951 | + |
2952 | +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
2953 | +#html_file_suffix = '' |
2954 | + |
2955 | +# Output file base name for HTML help builder. |
2956 | +htmlhelp_basename = 'bzr-%s-user-docs' % (bzr_locale,) |
2957 | + |
2958 | + |
2959 | +# -- Options for LaTeX output -------------------------------------------------- |
2960 | + |
2961 | +# The paper size ('letter' or 'a4'). |
2962 | +#latex_paper_size = 'letter' |
2963 | + |
2964 | +# The font size ('10pt', '11pt' or '12pt'). |
2965 | +#latex_font_size = '10pt' |
2966 | + |
2967 | +# Grouping the document tree into LaTeX files. List of tuples |
2968 | +# (source start file, target name, title, author, documentclass [howto/manual]). |
2969 | +latex_documents = [ |
2970 | + # Manuals |
2971 | + #('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,), |
2972 | + # bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'), |
2973 | + #('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,), |
2974 | + # bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'), |
2975 | + #('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,), |
2976 | + # bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'), |
2977 | + #('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,), |
2978 | + # bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'), |
2979 | + # Tutorials |
2980 | + ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,), |
2981 | + bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'), |
2982 | + #('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,), |
2983 | + # bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'), |
2984 | + #('tutorials/using_bazaar_with_launchpad', |
2985 | + # 'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,), |
2986 | + # bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'), |
2987 | + #('tutorials/centralized_workflow', |
2988 | + # 'bzr-%s-tutorial-centralized.tex' % (bzr_locale,), |
2989 | + # bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'), |
2990 | +] |
2991 | + |
2992 | +# The name of an image file (relative to this directory) to place at the top of |
2993 | +# the title page. |
2994 | +latex_logo = 'Bazaar-Logo-For-Manuals.png' |
2995 | + |
2996 | +# For "manual" documents, if this is true, then toplevel headings are parts, |
2997 | +# not chapters. |
2998 | +#latex_use_parts = False |
2999 | + |
3000 | +# Additional stuff for the LaTeX preamble. |
3001 | +#latex_preamble = '' |
3002 | + |
3003 | +# Documents to append as an appendix to all manuals. |
3004 | +#latex_appendices = [] |
3005 | + |
3006 | +# If false, no module index is generated. |
3007 | +#latex_use_modindex = True |
3008 | |
3009 | === removed directory 'doc/es/developer-guide' |
3010 | === renamed file 'doc/index.es.txt' => 'doc/es/index.txt' |
3011 | --- doc/index.es.txt 2009-06-29 11:02:31 +0000 |
3012 | +++ doc/es/index.txt 2009-09-07 06:12:15 +0000 |
3013 | @@ -1,46 +1,47 @@ |
3014 | -================================== |
3015 | +================================= |
3016 | Indice de Documentacion de Bazaar |
3017 | -================================== |
3018 | +================================= |
3019 | |
3020 | Las ultimas versiones de estos documentos se encuentran disponibles |
3021 | -en la pagina de Bazaar, http://doc.bazaar-vcs.org. |
3022 | +en la pagina de Bazaar, http://doc.bazaar-vcs.org/en/. |
3023 | + |
3024 | +.. toctree:: |
3025 | + :hidden: |
3026 | + |
3027 | + mini-tutorials/index |
3028 | + quick-reference/index |
3029 | + user-guide/index |
3030 | + |
3031 | |
3032 | Documentacion Principal |
3033 | ======================= |
3034 | |
3035 | -* `Mini Tutorial <es/mini-tutorial/index.html>`_ |
3036 | - |
3037 | -* `Referencia Rapida <es/quick-reference/quick-start-summary.svg>`_ |
3038 | - |
3039 | -* `Guia de Usuario <es/user-guide/index.html>`_ |
3040 | - |
3041 | -* `Referencia <es/user-reference/bzr_man.html>`_ |
3042 | - |
3043 | -* `Notas sobre la Version <es/release-notes/NEWS.html>`_ |
3044 | - |
3045 | -* `Guia del Desarrollador <es/developer-guide/HACKING.html>`_ |
3046 | +* `Bazaar en cinco minutos <mini-tutorial/index.html>`_ |
3047 | + |
3048 | +* `Referencia Rapida <quick-reference/index.html>`_ |
3049 | + |
3050 | +* `Guia de Usuario <user-guide/index.html>`_ |
3051 | |
3052 | |
3053 | Otra Documentacion |
3054 | -=================== |
3055 | +================== |
3056 | |
3057 | Mudandose a Bazaar (enlances web): |
3058 | |
3059 | -* `Guias de Mudanzas <http://bazaar-vcs.org/BzrSwitching>`_ |
3060 | - - para los usuarios que se mudan de otros SCV |
3061 | - |
3062 | -* `Guias de Migracion <http://bazaar-vcs.org/BzrMigration>`_ |
3063 | +* `Guias de Migracion <http://doc.bazaar-vcs.org/migration/en/>`_ |
3064 | - para equipos que mudan el historial de otros SCV |
3065 | |
3066 | +* `Guias de Plugins <http://doc.bazaar-vcs.org/plugins/en/>`_ |
3067 | + |
3068 | Otros Documentos (enlances web): |
3069 | |
3070 | * `Glosario <http://bazaar-vcs.org/BzrGlossary>`_ |
3071 | |
3072 | -* `Preguntas Frecuentes <http://bazaar-vcs.org/FAQ>`_ |
3073 | +* `Preguntas Frecuentes <https://answers.launchpad.net/bzr>`_ |
3074 | |
3075 | * `Referencia del API bzrlib <http://bazaar-vcs.org/BzrLib>`_ |
3076 | |
3077 | Especificaciones tecnicas, planes a futuro y varias |
3078 | notas tecnicas varias en Ingles: |
3079 | |
3080 | -* `Catalogo de Documentos para Desarrolladores <developers/index.html>`_ |
3081 | +* `Catalogo de Documentos para Desarrolladores <http://doc.bazaar-vcs.org/latest/developers/>`_ |
3082 | |
3083 | === added file 'doc/es/make.bat' |
3084 | --- doc/es/make.bat 1970-01-01 00:00:00 +0000 |
3085 | +++ doc/es/make.bat 2009-09-07 03:58:08 +0000 |
3086 | @@ -0,0 +1,112 @@ |
3087 | +@ECHO OFF |
3088 | + |
3089 | +REM Command file for Sphinx documentation |
3090 | + |
3091 | +set SPHINXBUILD=sphinx-build |
3092 | +set ALLSPHINXOPTS=-d _build/doctrees %SPHINXOPTS% . |
3093 | +if NOT "%PAPER%" == "" ( |
3094 | + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% |
3095 | +) |
3096 | + |
3097 | +if "%1" == "" goto help |
3098 | + |
3099 | +if "%1" == "help" ( |
3100 | + :help |
3101 | + echo.Please use `make ^<target^>` where ^<target^> is one of |
3102 | + echo. html to make standalone HTML files |
3103 | + echo. dirhtml to make HTML files named index.html in directories |
3104 | + echo. pickle to make pickle files |
3105 | + echo. json to make JSON files |
3106 | + echo. htmlhelp to make HTML files and a HTML help project |
3107 | + echo. qthelp to make HTML files and a qthelp project |
3108 | + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
3109 | + echo. changes to make an overview over all changed/added/deprecated items |
3110 | + echo. linkcheck to check all external links for integrity |
3111 | + echo. doctest to run all doctests embedded in the documentation if enabled |
3112 | + goto end |
3113 | +) |
3114 | + |
3115 | +if "%1" == "clean" ( |
3116 | + for /d %%i in (_build\*) do rmdir /q /s %%i |
3117 | + del /q /s _build\* |
3118 | + goto end |
3119 | +) |
3120 | + |
3121 | +if "%1" == "html" ( |
3122 | + %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html |
3123 | + echo. |
3124 | + echo.Build finished. The HTML pages are in _build/html. |
3125 | + goto end |
3126 | +) |
3127 | + |
3128 | +if "%1" == "dirhtml" ( |
3129 | + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% _build/dirhtml |
3130 | + echo. |
3131 | + echo.Build finished. The HTML pages are in _build/dirhtml. |
3132 | + goto end |
3133 | +) |
3134 | + |
3135 | +if "%1" == "pickle" ( |
3136 | + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle |
3137 | + echo. |
3138 | + echo.Build finished; now you can process the pickle files. |
3139 | + goto end |
3140 | +) |
3141 | + |
3142 | +if "%1" == "json" ( |
3143 | + %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json |
3144 | + echo. |
3145 | + echo.Build finished; now you can process the JSON files. |
3146 | + goto end |
3147 | +) |
3148 | + |
3149 | +if "%1" == "htmlhelp" ( |
3150 | + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp |
3151 | + echo. |
3152 | + echo.Build finished; now you can run HTML Help Workshop with the ^ |
3153 | +.hhp project file in _build/htmlhelp. |
3154 | + goto end |
3155 | +) |
3156 | + |
3157 | +if "%1" == "qthelp" ( |
3158 | + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp |
3159 | + echo. |
3160 | + echo.Build finished; now you can run "qcollectiongenerator" with the ^ |
3161 | +.qhcp project file in _build/qthelp, like this: |
3162 | + echo.^> qcollectiongenerator _build\qthelp\Bazaar.qhcp |
3163 | + echo.To view the help file: |
3164 | + echo.^> assistant -collectionFile _build\qthelp\Bazaar.ghc |
3165 | + goto end |
3166 | +) |
3167 | + |
3168 | +if "%1" == "latex" ( |
3169 | + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% _build/latex |
3170 | + echo. |
3171 | + echo.Build finished; the LaTeX files are in _build/latex. |
3172 | + goto end |
3173 | +) |
3174 | + |
3175 | +if "%1" == "changes" ( |
3176 | + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes |
3177 | + echo. |
3178 | + echo.The overview file is in _build/changes. |
3179 | + goto end |
3180 | +) |
3181 | + |
3182 | +if "%1" == "linkcheck" ( |
3183 | + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck |
3184 | + echo. |
3185 | + echo.Link check complete; look for any errors in the above output ^ |
3186 | +or in _build/linkcheck/output.txt. |
3187 | + goto end |
3188 | +) |
3189 | + |
3190 | +if "%1" == "doctest" ( |
3191 | + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest |
3192 | + echo. |
3193 | + echo.Testing of doctests in the sources finished, look at the ^ |
3194 | +results in _build/doctest/output.txt. |
3195 | + goto end |
3196 | +) |
3197 | + |
3198 | +:end |
3199 | |
3200 | === added file 'doc/es/quick-reference/index.txt' |
3201 | --- doc/es/quick-reference/index.txt 1970-01-01 00:00:00 +0000 |
3202 | +++ doc/es/quick-reference/index.txt 2009-09-07 03:58:08 +0000 |
3203 | @@ -0,0 +1,6 @@ |
3204 | +Referencia Rapida |
3205 | +================= |
3206 | + |
3207 | +* `SVG format <../_static/es/quick-reference/bzr-quick-reference.svg>`_ |
3208 | +* `PDF format <../_static/es/quick-reference/bzr-quick-reference.pdf>`_ |
3209 | +* `PNG format <../_static/es/quick-reference/bzr-quick-reference.png>`_ |
3210 | |
3211 | === removed directory 'doc/es/release-notes' |
3212 | === removed directory 'doc/es/user-reference' |
3213 | === renamed file 'doc/contents.txt' => 'doc/index.txt' |
3214 | --- doc/contents.txt 2009-08-18 00:10:19 +0000 |
3215 | +++ doc/index.txt 2009-09-03 02:29:16 +0000 |
3216 | @@ -4,8 +4,8 @@ |
3217 | contain the root `toctree` directive. |
3218 | |
3219 | |
3220 | -Core documentation |
3221 | -================== |
3222 | +Table of Contents |
3223 | +================= |
3224 | |
3225 | .. toctree:: |
3226 | :maxdepth: 1 |
3227 | @@ -13,30 +13,6 @@ |
3228 | en/user-guide/index |
3229 | en/tutorials/index |
3230 | en/quick-reference/index |
3231 | - en/user-reference/index |
3232 | - |
3233 | -.. toctree:: |
3234 | - :maxdepth: 1 |
3235 | - |
3236 | - en/release-notes/index |
3237 | + en/release-notes/NEWS |
3238 | en/upgrade-guide/index |
3239 | - developers/index |
3240 | - |
3241 | - |
3242 | -Other languages: |
3243 | - |
3244 | -.. toctree:: |
3245 | - :maxdepth: 1 |
3246 | - |
3247 | - index.es |
3248 | - index.ru |
3249 | - |
3250 | - |
3251 | -Related links |
3252 | -============= |
3253 | - |
3254 | -* `Frequently Asked Questions <http://bazaar-vcs.org/FAQ>`_ |
3255 | -* `Glossary <http://bazaar-vcs.org/BzrGlossary>`_ |
3256 | -* :ref:`genindex` |
3257 | -* :ref:`search` |
3258 | - |
3259 | + en/user-reference/bzr_man |
3260 | |
3261 | === removed file 'doc/index.txt' |
3262 | --- doc/index.txt 2009-08-10 06:53:44 +0000 |
3263 | +++ doc/index.txt 1970-01-01 00:00:00 +0000 |
3264 | @@ -1,66 +0,0 @@ |
3265 | -============================ |
3266 | -Bazaar Main Document Catalog |
3267 | -============================ |
3268 | - |
3269 | -The latest version of these documents are available from Bazaar's |
3270 | -documentation site, <http://doc.bazaar-vcs.org/>, and more documentation |
3271 | -may be linked from <http://bazaar-vcs.org/Documentation>. |
3272 | - |
3273 | -Core Documentation |
3274 | -================== |
3275 | - |
3276 | -* `User Guide <en/user-guide/index.html>`_ |
3277 | - |
3278 | -* `User Reference <en/user-reference/bzr_man.html>`_ |
3279 | - |
3280 | -* `Quick Start Card <_static/en/quick-reference/bzr-quick-reference.svg>`_ |
3281 | - (`PDF <_static/en/quick-reference/bzr-quick-reference.pdf>`_, |
3282 | - `PNG <_static/en/quick-reference/bzr-quick-reference.png>`_) |
3283 | - |
3284 | -* `Release Notes <en/release-notes/NEWS.html>`_ |
3285 | - |
3286 | -* `2.0 Upgrade Guide <en/upgrade-guide/index.html>`_ |
3287 | - |
3288 | - |
3289 | -Tutorials |
3290 | -========= |
3291 | - |
3292 | -* `Bazaar in five minutes <en/mini-tutorial/index.html>`_ |
3293 | - |
3294 | -* `A longer tutorial <en/tutorials/tutorial.html>`_ |
3295 | - |
3296 | -* `Using Bazaar with Launchpad <en/tutorials/using_bazaar_with_launchpad.html>`_ |
3297 | - |
3298 | -* `Centralized workflow <en/tutorials/centralized_workflow.html>`_ |
3299 | - |
3300 | - |
3301 | -Developer Documentation |
3302 | -======================= |
3303 | - |
3304 | -* `Developer Document Catalog <developers/index.html>`_ |--| for developers |
3305 | - of Bazaar and plugins |
3306 | - |
3307 | -Web links |
3308 | -========= |
3309 | - |
3310 | -* `Switching Guides <http://bazaar-vcs.org/BzrSwitching>`_ |
3311 | - |--| for users moving from another VCS tool |
3312 | - |
3313 | -* `Migration Guide <http://bazaar-vcs.org/BzrMigration>`_ |
3314 | - |--| for teams migrating history from another VCS tool |
3315 | - |
3316 | -* `Glossary <http://bazaar-vcs.org/BzrGlossary>`_ |
3317 | - |
3318 | -* `Frequently Asked Questions <http://bazaar-vcs.org/FAQ>`_ |
3319 | - |
3320 | - |
3321 | -Other Languages |
3322 | -=============== |
3323 | - |
3324 | -* `Spanish Documentation <index.es.html>`_ |
3325 | -* `Russian Documentation <index.ru.html>`_ |--| документация на русском |
3326 | - |
3327 | -.. |--| unicode:: U+2014 |
3328 | - |
3329 | -.. |
3330 | - vim: ft=rst tw=74 ai |
3331 | |
3332 | === added file 'doc/ru/Makefile' |
3333 | --- doc/ru/Makefile 1970-01-01 00:00:00 +0000 |
3334 | +++ doc/ru/Makefile 2009-09-07 05:26:43 +0000 |
3335 | @@ -0,0 +1,88 @@ |
3336 | +# Makefile for Sphinx documentation |
3337 | +# |
3338 | + |
3339 | +# You can set these variables from the command line. |
3340 | +SPHINXOPTS = |
3341 | +SPHINXBUILD = sphinx-build |
3342 | +PAPER = |
3343 | + |
3344 | +# Internal variables. |
3345 | +PAPEROPT_a4 = -D latex_paper_size=a4 |
3346 | +PAPEROPT_letter = -D latex_paper_size=letter |
3347 | +ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
3348 | + |
3349 | +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest |
3350 | + |
3351 | +help: |
3352 | + @echo "Please use \`make <target>' where <target> is one of" |
3353 | + @echo " html to make standalone HTML files" |
3354 | + @echo " dirhtml to make HTML files named index.html in directories" |
3355 | + @echo " pickle to make pickle files" |
3356 | + @echo " json to make JSON files" |
3357 | + @echo " htmlhelp to make HTML files and a HTML help project" |
3358 | + @echo " qthelp to make HTML files and a qthelp project" |
3359 | + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
3360 | + @echo " changes to make an overview of all changed/added/deprecated items" |
3361 | + @echo " linkcheck to check all external links for integrity" |
3362 | + @echo " doctest to run all doctests embedded in the documentation (if enabled)" |
3363 | + |
3364 | +clean: |
3365 | + -rm -rf _build/* |
3366 | + |
3367 | +html: |
3368 | + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html |
3369 | + @echo |
3370 | + @echo "Build finished. The HTML pages are in _build/html." |
3371 | + |
3372 | +dirhtml: |
3373 | + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml |
3374 | + @echo |
3375 | + @echo "Build finished. The HTML pages are in _build/dirhtml." |
3376 | + |
3377 | +pickle: |
3378 | + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle |
3379 | + @echo |
3380 | + @echo "Build finished; now you can process the pickle files." |
3381 | + |
3382 | +json: |
3383 | + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json |
3384 | + @echo |
3385 | + @echo "Build finished; now you can process the JSON files." |
3386 | + |
3387 | +htmlhelp: |
3388 | + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp |
3389 | + @echo |
3390 | + @echo "Build finished; now you can run HTML Help Workshop with the" \ |
3391 | + ".hhp project file in _build/htmlhelp." |
3392 | + |
3393 | +qthelp: |
3394 | + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp |
3395 | + @echo |
3396 | + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
3397 | + ".qhcp project file in _build/qthelp, like this:" |
3398 | + @echo "# qcollectiongenerator _build/qthelp/Bazaar.qhcp" |
3399 | + @echo "To view the help file:" |
3400 | + @echo "# assistant -collectionFile _build/qthelp/Bazaar.qhc" |
3401 | + |
3402 | +latex: |
3403 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex |
3404 | + @echo |
3405 | + @echo "Build finished; the LaTeX files are in _build/latex." |
3406 | + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
3407 | + "run these through (pdf)latex." |
3408 | + |
3409 | +changes: |
3410 | + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes |
3411 | + @echo |
3412 | + @echo "The overview file is in _build/changes." |
3413 | + |
3414 | +linkcheck: |
3415 | + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck |
3416 | + @echo |
3417 | + @echo "Link check complete; look for any errors in the above output " \ |
3418 | + "or in _build/linkcheck/output.txt." |
3419 | + |
3420 | +doctest: |
3421 | + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest |
3422 | + @echo "Testing of doctests in the sources finished, look at the " \ |
3423 | + "results in _build/doctest/output.txt." |
3424 | |
3425 | === added directory 'doc/ru/_static' |
3426 | === added file 'doc/ru/_static/bzr icon 16.png' |
3427 | Binary files doc/ru/_static/bzr icon 16.png 1970-01-01 00:00:00 +0000 and doc/ru/_static/bzr icon 16.png 2009-09-07 05:26:43 +0000 differ |
3428 | === added file 'doc/ru/_static/bzr.ico' |
3429 | Binary files doc/ru/_static/bzr.ico 1970-01-01 00:00:00 +0000 and doc/ru/_static/bzr.ico 2009-09-07 05:26:43 +0000 differ |
3430 | === added directory 'doc/ru/_static/ru' |
3431 | === renamed file 'doc/ru/quick-reference/Makefile' => 'doc/ru/_static/ru/Makefile' |
3432 | --- doc/ru/quick-reference/Makefile 2008-08-19 06:29:48 +0000 |
3433 | +++ doc/ru/_static/ru/Makefile 2009-09-07 05:26:43 +0000 |
3434 | @@ -1,5 +1,5 @@ |
3435 | -TARGETS=quick-start-summary.png quick-start-summary.pdf |
3436 | -OBJECTS=quick-start-summary.svg Makefile |
3437 | +TARGETS=bzr-quick-reference.png bzr-quick-reference.pdf |
3438 | +OBJECTS=bzr-quick-reference.svg Makefile |
3439 | |
3440 | all: $(TARGETS) |
3441 | |
3442 | @@ -11,9 +11,9 @@ |
3443 | .svg.png: |
3444 | rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $< |
3445 | |
3446 | -bzr-quickref.png: $(OBJECTS) |
3447 | +bzr-quick-reference.png: $(OBJECTS) |
3448 | |
3449 | -bzr-quickref.pdf: $(OBJECTS) |
3450 | +bzr-quick-reference.pdf: $(OBJECTS) |
3451 | |
3452 | clean: |
3453 | rm -f $(TARGETS) |
3454 | |
3455 | === renamed file 'doc/ru/quick-reference/quick-start-summary.pdf' => 'doc/ru/_static/ru/bzr-quick-reference.pdf' |
3456 | === renamed file 'doc/ru/quick-reference/quick-start-summary.png' => 'doc/ru/_static/ru/bzr-quick-reference.png' |
3457 | === renamed file 'doc/ru/quick-reference/quick-start-summary.svg' => 'doc/ru/_static/ru/bzr-quick-reference.svg' |
3458 | === added directory 'doc/ru/_templates' |
3459 | === added file 'doc/ru/conf.py' |
3460 | --- doc/ru/conf.py 1970-01-01 00:00:00 +0000 |
3461 | +++ doc/ru/conf.py 2009-09-07 05:26:43 +0000 |
3462 | @@ -0,0 +1,263 @@ |
3463 | +# -*- coding: utf-8 -*- |
3464 | +# |
3465 | +# Bazaar documentation build configuration file, created by |
3466 | +# sphinx-quickstart on Tue Jul 21 17:04:52 2009. |
3467 | +# |
3468 | +# This file is execfile()d with the current directory set to its containing dir. |
3469 | +# |
3470 | +# Note that not all possible configuration values are present in this |
3471 | +# autogenerated file. |
3472 | +# |
3473 | +# All configuration values have a default; values that are commented out |
3474 | +# serve to show the default. |
3475 | + |
3476 | +import sys, os |
3477 | + |
3478 | +# If extensions (or modules to document with autodoc) are in another directory, |
3479 | +# add these directories to sys.path here. If the directory is relative to the |
3480 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
3481 | +#sys.path.append(os.path.abspath('.')) |
3482 | + |
3483 | + |
3484 | +# -- Bazaar-specific configuration --------------------------------------------- |
3485 | + |
3486 | +# NOTE: Editing this section is generally all that is required ... |
3487 | + |
3488 | +# We *could* get this from bzrlib but there's no certainly that the bzr on |
3489 | +# the Python path is indeed the one we're building the documentation for ... |
3490 | +bzr_version = (2, 0, 0, 'rc', 2) |
3491 | + |
3492 | +# The locale code for this documentation set |
3493 | +bzr_locale = 'ru' |
3494 | + |
3495 | +# Authors of the documents |
3496 | +bzr_team = u'Bazaar Developers' |
3497 | + |
3498 | +# Translations |
3499 | +bzr_titles = { |
3500 | + u'Table of Contents (%s)': u'Содержание (%s)', |
3501 | + u'Bazaar User Guide': None, |
3502 | + u'Bazaar User Reference': None, |
3503 | + u'Bazaar Release Notes': None, |
3504 | + u'Bazaar Upgrade Guide': None, |
3505 | + u'Bazaar in five minutes': u'Базар за пять минут', |
3506 | + u'Bazaar Tutorial': u'Большой учебник', |
3507 | + u'Using Bazaar With Launchpad': u'Использование Bazaar с Launchpad', |
3508 | + u'Centralized Workflow Tutorial': u'Работа в централизованном стиле', |
3509 | + } |
3510 | + |
3511 | + |
3512 | +# Helper function for looking up translations |
3513 | +def bzr_title(s): |
3514 | + return bzr_titles.get(s) or s |
3515 | + |
3516 | + |
3517 | +# -- General configuration ----------------------------------------------------- |
3518 | + |
3519 | +# Add any Sphinx extension module names here, as strings. They can be extensions |
3520 | +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
3521 | +extensions = ['sphinx.ext.ifconfig'] |
3522 | + |
3523 | +# Add any paths that contain templates here, relative to this directory. |
3524 | +templates_path = ['_templates'] |
3525 | + |
3526 | +# The suffix of source filenames. |
3527 | +source_suffix = '.txt' |
3528 | + |
3529 | +# The encoding of source files. |
3530 | +#source_encoding = 'utf-8' |
3531 | + |
3532 | +# The master toctree document. |
3533 | +master_doc = 'index' |
3534 | + |
3535 | +# General information about the project. |
3536 | +project = u'Bazaar' |
3537 | +copyright = u'2009, Canonical Ltd' |
3538 | + |
3539 | +# The version info for the project you're documenting, acts as replacement for |
3540 | +# |version| and |release|, also used in various other places throughout the |
3541 | +# built documents. |
3542 | +# |
3543 | +# The short X.Y version. |
3544 | +version = '.'.join(str(p) for p in bzr_version[:3]) |
3545 | +# The full version, including alpha/beta/rc tags. |
3546 | +release = version + ''.join(str(p) for p in bzr_version[3:]) |
3547 | + |
3548 | +# The language for content autogenerated by Sphinx. Refer to documentation |
3549 | +# for a list of supported languages. |
3550 | +language = bzr_locale |
3551 | + |
3552 | +# There are two options for replacing |today|: either, you set today to some |
3553 | +# non-false value, then it is used: |
3554 | +#today = '' |
3555 | +# Else, today_fmt is used as the format for a strftime call. |
3556 | +#today_fmt = '%B %d, %Y' |
3557 | + |
3558 | +# List of documents that shouldn't be included in the build. |
3559 | +#unused_docs = [] |
3560 | + |
3561 | +# List of directories, relative to source directory, that shouldn't be searched |
3562 | +# for source files. |
3563 | +exclude_trees = ['_build'] |
3564 | + |
3565 | +# The reST default role (used for this markup: `text`) to use for all documents. |
3566 | +#default_role = None |
3567 | + |
3568 | +# If true, '()' will be appended to :func: etc. cross-reference text. |
3569 | +#add_function_parentheses = True |
3570 | + |
3571 | +# If true, the current module name will be prepended to all description |
3572 | +# unit titles (such as .. function::). |
3573 | +#add_module_names = True |
3574 | + |
3575 | +# If true, sectionauthor and moduleauthor directives will be shown in the |
3576 | +# output. They are ignored by default. |
3577 | +#show_authors = False |
3578 | + |
3579 | +# The name of the Pygments (syntax highlighting) style to use. |
3580 | +pygments_style = 'sphinx' |
3581 | + |
3582 | +# A list of ignored prefixes for module index sorting. |
3583 | +#modindex_common_prefix = [] |
3584 | + |
3585 | + |
3586 | +# -- Options for HTML output --------------------------------------------------- |
3587 | + |
3588 | +# The theme to use for HTML and HTML Help pages. Major themes that come with |
3589 | +# Sphinx are currently 'default' and 'sphinxdoc'. |
3590 | +html_theme = 'default' |
3591 | + |
3592 | +# Theme options are theme-specific and customize the look and feel of a theme |
3593 | +# further. For a list of options available for each theme, see the |
3594 | +# documentation. |
3595 | +html_theme_options = { |
3596 | + 'rightsidebar': True, |
3597 | + |
3598 | + # Non-document areas: header (relbar), footer, sidebar, etc. |
3599 | + # Some useful colours here: |
3600 | + # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue, |
3601 | + # midnightblue |
3602 | + # * gray: dimgray, slategray, lightslategray |
3603 | + 'sidebarbgcolor': "cornflowerblue", |
3604 | + 'sidebarlinkcolor': "midnightblue", |
3605 | + 'relbarbgcolor': "darkblue", |
3606 | + 'footerbgcolor': "lightslategray", |
3607 | + |
3608 | + # Text, heading and code colouring |
3609 | + 'codebgcolor': "lightyellow", |
3610 | + 'codetextcolor': "firebrick", |
3611 | + 'linkcolor': "mediumblue", |
3612 | + } |
3613 | + |
3614 | +# Add any paths that contain custom themes here, relative to this directory. |
3615 | +#html_theme_path = [] |
3616 | + |
3617 | +# The name for this set of Sphinx documents. If None, it defaults to |
3618 | +# "<project> v<release> documentation". |
3619 | +#html_title = None |
3620 | + |
3621 | +# A shorter title for the navigation bar. Default is the same as html_title. |
3622 | +html_short_title = bzr_title(u"Table of Contents (%s)") % (release,) |
3623 | + |
3624 | +# The name of an image file (relative to this directory) to place at the top |
3625 | +# of the sidebar. |
3626 | +#html_logo = None |
3627 | + |
3628 | +# The name of an image file (within the static path) to use as favicon of the |
3629 | +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
3630 | +# pixels large. |
3631 | +html_favicon = "bzr.ico" |
3632 | + |
3633 | +# Add any paths that contain custom static files (such as style sheets) here, |
3634 | +# relative to this directory. They are copied after the builtin static files, |
3635 | +# so a file named "default.css" will overwrite the builtin "default.css". |
3636 | +html_static_path = ['_static'] |
3637 | + |
3638 | +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
3639 | +# using the given strftime format. |
3640 | +#html_last_updated_fmt = '%b %d, %Y' |
3641 | + |
3642 | +# If true, SmartyPants will be used to convert quotes and dashes to |
3643 | +# typographically correct entities. |
3644 | +#html_use_smartypants = True |
3645 | + |
3646 | +# Custom sidebar templates, maps document names to template names. |
3647 | +#html_sidebars = {} |
3648 | + |
3649 | +# Additional templates that should be rendered to pages, maps page names to |
3650 | +# template names. |
3651 | +#html_additional_pages = {'index': 'index.html'} |
3652 | + |
3653 | +# If false, no module index is generated. |
3654 | +html_use_modindex = False |
3655 | + |
3656 | +# If false, no index is generated. |
3657 | +html_use_index = False |
3658 | + |
3659 | +# If true, the index is split into individual pages for each letter. |
3660 | +#html_split_index = False |
3661 | + |
3662 | +# If true, links to the reST sources are added to the pages. |
3663 | +html_show_sourcelink = True |
3664 | + |
3665 | +# If true, an OpenSearch description file will be output, and all pages will |
3666 | +# contain a <link> tag referring to it. The value of this option must be the |
3667 | +# base URL from which the finished HTML is served. |
3668 | +#html_use_opensearch = '' |
3669 | + |
3670 | +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
3671 | +#html_file_suffix = '' |
3672 | + |
3673 | +# Output file base name for HTML help builder. |
3674 | +htmlhelp_basename = 'bzr-%s-user-docs' % (bzr_locale,) |
3675 | + |
3676 | + |
3677 | +# -- Options for LaTeX output -------------------------------------------------- |
3678 | + |
3679 | +# The paper size ('letter' or 'a4'). |
3680 | +#latex_paper_size = 'letter' |
3681 | + |
3682 | +# The font size ('10pt', '11pt' or '12pt'). |
3683 | +#latex_font_size = '10pt' |
3684 | + |
3685 | +# Grouping the document tree into LaTeX files. List of tuples |
3686 | +# (source start file, target name, title, author, documentclass [howto/manual]). |
3687 | +latex_documents = [ |
3688 | + # Manuals |
3689 | + #('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,), |
3690 | + # bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'), |
3691 | + #('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,), |
3692 | + # bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'), |
3693 | + #('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,), |
3694 | + # bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'), |
3695 | + #('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,), |
3696 | + # bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'), |
3697 | + # Tutorials |
3698 | + ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,), |
3699 | + bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'), |
3700 | + ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,), |
3701 | + bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'), |
3702 | + ('tutorials/using_bazaar_with_launchpad', |
3703 | + 'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,), |
3704 | + bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'), |
3705 | + ('tutorials/centralized_workflow', |
3706 | + 'bzr-%s-tutorial-centralized.tex' % (bzr_locale,), |
3707 | + bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'), |
3708 | +] |
3709 | + |
3710 | +# The name of an image file (relative to this directory) to place at the top of |
3711 | +# the title page. |
3712 | +latex_logo = 'Bazaar-Logo-For-Manuals.png' |
3713 | + |
3714 | +# For "manual" documents, if this is true, then toplevel headings are parts, |
3715 | +# not chapters. |
3716 | +#latex_use_parts = False |
3717 | + |
3718 | +# Additional stuff for the LaTeX preamble. |
3719 | +#latex_preamble = '' |
3720 | + |
3721 | +# Documents to append as an appendix to all manuals. |
3722 | +#latex_appendices = [] |
3723 | + |
3724 | +# If false, no module index is generated. |
3725 | +#latex_use_modindex = True |
3726 | |
3727 | === renamed file 'doc/index.ru.txt' => 'doc/ru/index.txt' |
3728 | --- doc/index.ru.txt 2009-06-02 18:07:12 +0000 |
3729 | +++ doc/ru/index.txt 2009-09-07 05:26:43 +0000 |
3730 | @@ -3,45 +3,43 @@ |
3731 | ================================= |
3732 | |
3733 | Последняя версия этих документов доступа со страницы документации |
3734 | -на сайте Bazaar, <http://doc.bazaar-vcs.org/>. Еще больше информации |
3735 | -можно получить по адресу <http://bazaar-vcs.org/Documentation>. |
3736 | +на сайте Bazaar, <http://doc.bazaar-vcs.org/ru/>. |
3737 | + |
3738 | +.. toctree:: |
3739 | + :hidden: |
3740 | + |
3741 | + user-guide/index |
3742 | + quick-reference/index |
3743 | + mini-tutorials/index |
3744 | + tutorials/tutorial |
3745 | + tutorials/using_bazaar_with_launchpad |
3746 | + tutorials/centralized_workflow |
3747 | + |
3748 | |
3749 | Основная документация |
3750 | ===================== |
3751 | |
3752 | -* `Руководство пользователя <ru/user-guide/index.html>`_ |
3753 | - |
3754 | -* `Справочник пользователя <en/user-reference/bzr_man.html>`_ (англ.) |
3755 | - |
3756 | -* `Карточка быстрого старта <ru/quick-reference/quick-start-summary.svg>`_ |
3757 | - (`PDF <ru/quick-reference/quick-start-summary.pdf>`_, |
3758 | - `PNG <ru/quick-reference/quick-start-summary.png>`_) |
3759 | - |
3760 | -* `Список изменений <en/release-notes/NEWS.html>`_ (англ.) |
3761 | - |
3762 | -* `Каталог информации для разработчиков <developers/index.html>`_ (англ.) |--| |
3763 | - для разработчиков Bazaar и плагинов |
3764 | +* `Руководство пользователя <user-guide/index.html>`_ |
3765 | + |
3766 | +* `Карточка быстрого старта <quick-reference/index.html>`_ |
3767 | |
3768 | Учебники |
3769 | ======== |
3770 | |
3771 | -* `Базар за пять минут <ru/mini-tutorial/index.html>`_ |
3772 | +* `Базар за пять минут <mini-tutorial/index.html>`_ |
3773 | |
3774 | -* `Большой учебник <ru/tutorials/tutorial.html>`_ |
3775 | +* `Большой учебник <tutorials/tutorial.html>`_ |
3776 | |
3777 | * `Использование Bazaar с Launchpad |
3778 | - <ru/tutorials/using_bazaar_with_launchpad.html>`_ |
3779 | + <tutorials/using_bazaar_with_launchpad.html>`_ |
3780 | |
3781 | * `Работа в централизованном стиле |
3782 | - <ru/tutorials/centralized_workflow.html>`_ |
3783 | + <tutorials/centralized_workflow.html>`_ |
3784 | |
3785 | Ссылки в сети |
3786 | ============= |
3787 | |
3788 | -* `Руководства по переходу <http://bazaar-vcs.org/BzrSwitching>`_ |
3789 | - |--| для пользователей переходящих с других систем контроля версий |
3790 | - |
3791 | -* `Руководство по миграции <http://bazaar-vcs.org/BzrMigration>`_ |
3792 | +* `Руководство по миграции <http://doc.bazaar-vcs.org/migration/en/>`_ |
3793 | |--| для команд переносящих историю с других систем контроля версий |
3794 | |
3795 | * `Словарь терминов <http://bazaar-vcs.org/BzrGlossary>`_ (англ.), |
3796 | @@ -49,13 +47,8 @@ |
3797 | |
3798 | __ http://groups.google.com/group/ru_bzr/web/%D0%B3%D0%BB%D0%BE%D1%81%D1%81%D0%B0%D1%80%D0%B8%D0%B9 |
3799 | |
3800 | -* `Часто задаваемые вопросы <http://bazaar-vcs.org/FAQ>`_ (англ.) |
3801 | - |
3802 | -Другие языки |
3803 | -============ |
3804 | - |
3805 | -* `Документация на английском <index.html>`_ |--| English Documentation |
3806 | -* `Документация на испанском <index.es.html>`_ |
3807 | +* `Часто задаваемые вопросы <https://answers.launchpad.net/bzr>`_ (англ.) |
3808 | + |
3809 | |
3810 | .. |--| unicode:: U+2014 |
3811 | |
3812 | |
3813 | === added file 'doc/ru/make.bat' |
3814 | --- doc/ru/make.bat 1970-01-01 00:00:00 +0000 |
3815 | +++ doc/ru/make.bat 2009-09-07 05:26:43 +0000 |
3816 | @@ -0,0 +1,112 @@ |
3817 | +@ECHO OFF |
3818 | + |
3819 | +REM Command file for Sphinx documentation |
3820 | + |
3821 | +set SPHINXBUILD=sphinx-build |
3822 | +set ALLSPHINXOPTS=-d _build/doctrees %SPHINXOPTS% . |
3823 | +if NOT "%PAPER%" == "" ( |
3824 | + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% |
3825 | +) |
3826 | + |
3827 | +if "%1" == "" goto help |
3828 | + |
3829 | +if "%1" == "help" ( |
3830 | + :help |
3831 | + echo.Please use `make ^<target^>` where ^<target^> is one of |
3832 | + echo. html to make standalone HTML files |
3833 | + echo. dirhtml to make HTML files named index.html in directories |
3834 | + echo. pickle to make pickle files |
3835 | + echo. json to make JSON files |
3836 | + echo. htmlhelp to make HTML files and a HTML help project |
3837 | + echo. qthelp to make HTML files and a qthelp project |
3838 | + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
3839 | + echo. changes to make an overview over all changed/added/deprecated items |
3840 | + echo. linkcheck to check all external links for integrity |
3841 | + echo. doctest to run all doctests embedded in the documentation if enabled |
3842 | + goto end |
3843 | +) |
3844 | + |
3845 | +if "%1" == "clean" ( |
3846 | + for /d %%i in (_build\*) do rmdir /q /s %%i |
3847 | + del /q /s _build\* |
3848 | + goto end |
3849 | +) |
3850 | + |
3851 | +if "%1" == "html" ( |
3852 | + %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html |
3853 | + echo. |
3854 | + echo.Build finished. The HTML pages are in _build/html. |
3855 | + goto end |
3856 | +) |
3857 | + |
3858 | +if "%1" == "dirhtml" ( |
3859 | + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% _build/dirhtml |
3860 | + echo. |
3861 | + echo.Build finished. The HTML pages are in _build/dirhtml. |
3862 | + goto end |
3863 | +) |
3864 | + |
3865 | +if "%1" == "pickle" ( |
3866 | + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle |
3867 | + echo. |
3868 | + echo.Build finished; now you can process the pickle files. |
3869 | + goto end |
3870 | +) |
3871 | + |
3872 | +if "%1" == "json" ( |
3873 | + %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json |
3874 | + echo. |
3875 | + echo.Build finished; now you can process the JSON files. |
3876 | + goto end |
3877 | +) |
3878 | + |
3879 | +if "%1" == "htmlhelp" ( |
3880 | + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp |
3881 | + echo. |
3882 | + echo.Build finished; now you can run HTML Help Workshop with the ^ |
3883 | +.hhp project file in _build/htmlhelp. |
3884 | + goto end |
3885 | +) |
3886 | + |
3887 | +if "%1" == "qthelp" ( |
3888 | + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp |
3889 | + echo. |
3890 | + echo.Build finished; now you can run "qcollectiongenerator" with the ^ |
3891 | +.qhcp project file in _build/qthelp, like this: |
3892 | + echo.^> qcollectiongenerator _build\qthelp\Bazaar.qhcp |
3893 | + echo.To view the help file: |
3894 | + echo.^> assistant -collectionFile _build\qthelp\Bazaar.ghc |
3895 | + goto end |
3896 | +) |
3897 | + |
3898 | +if "%1" == "latex" ( |
3899 | + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% _build/latex |
3900 | + echo. |
3901 | + echo.Build finished; the LaTeX files are in _build/latex. |
3902 | + goto end |
3903 | +) |
3904 | + |
3905 | +if "%1" == "changes" ( |
3906 | + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes |
3907 | + echo. |
3908 | + echo.The overview file is in _build/changes. |
3909 | + goto end |
3910 | +) |
3911 | + |
3912 | +if "%1" == "linkcheck" ( |
3913 | + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck |
3914 | + echo. |
3915 | + echo.Link check complete; look for any errors in the above output ^ |
3916 | +or in _build/linkcheck/output.txt. |
3917 | + goto end |
3918 | +) |
3919 | + |
3920 | +if "%1" == "doctest" ( |
3921 | + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest |
3922 | + echo. |
3923 | + echo.Testing of doctests in the sources finished, look at the ^ |
3924 | +results in _build/doctest/output.txt. |
3925 | + goto end |
3926 | +) |
3927 | + |
3928 | +:end |
3929 | |
3930 | === added file 'doc/ru/quick-reference/index.txt' |
3931 | --- doc/ru/quick-reference/index.txt 1970-01-01 00:00:00 +0000 |
3932 | +++ doc/ru/quick-reference/index.txt 2009-09-07 05:26:43 +0000 |
3933 | @@ -0,0 +1,6 @@ |
3934 | +Карточка быстрого старта |
3935 | +======================== |
3936 | + |
3937 | +* `SVG <../_static/ru/bzr-quick-reference.svg>`_ |
3938 | +* `PDF <../_static/ru/bzr-quick-reference.pdf>`_ |
3939 | +* `PNG <../_static/ru/bzr-quick-reference.png>`_ |
3940 | |
3941 | === added file 'tools/generate_release_notes.py' |
3942 | --- tools/generate_release_notes.py 1970-01-01 00:00:00 +0000 |
3943 | +++ tools/generate_release_notes.py 2009-09-03 05:09:22 +0000 |
3944 | @@ -0,0 +1,86 @@ |
3945 | +#!/usr/bin/python |
3946 | + |
3947 | +# Copyright 2009 Canonical Ltd. |
3948 | +# |
3949 | +# This program is free software; you can redistribute it and/or modify |
3950 | +# it under the terms of the GNU General Public License as published by |
3951 | +# the Free Software Foundation; either version 2 of the License, or |
3952 | +# (at your option) any later version. |
3953 | +# |
3954 | +# This program is distributed in the hope that it will be useful, |
3955 | +# but WITHOUT ANY WARRANTY; without even the implied warranty of |
3956 | +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3957 | +# GNU General Public License for more details. |
3958 | +# |
3959 | +# You should have received a copy of the GNU General Public License |
3960 | +# along with this program; if not, write to the Free Software |
3961 | +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
3962 | + |
3963 | +import os |
3964 | +import sys |
3965 | +from optparse import OptionParser |
3966 | + |
3967 | +sys.path.insert(0, os.path.dirname(os.path.dirname(__file__))) |
3968 | + |
3969 | + |
3970 | +def split_into_topics(lines, out_file, out_dir): |
3971 | + """Split a large NEWS file into topics, one per release. |
3972 | + |
3973 | + Releases are detected by matching headings that look like |
3974 | + release names. Topics are created with matching names |
3975 | + replacing spaces with dashes. |
3976 | + """ |
3977 | + topic_file = None |
3978 | + for index, line in enumerate(lines): |
3979 | + maybe_new_topic = line[:4] in ['bzr ', 'bzr-0',] |
3980 | + if maybe_new_topic and lines[index + 1].startswith('####'): |
3981 | + release = line.strip() |
3982 | + if topic_file is None: |
3983 | + # First topic found |
3984 | + out_file.write(".. toctree::\n :maxdepth: 1\n\n") |
3985 | + else: |
3986 | + # close the current topic |
3987 | + topic_file.close() |
3988 | + topic_file = open_topic_file(out_file, out_dir, release) |
3989 | + elif topic_file: |
3990 | + topic_file.write(line) |
3991 | + else: |
3992 | + # Still in the header - dump content straight to output |
3993 | + out_file.write(line) |
3994 | + |
3995 | + |
3996 | +def open_topic_file(out_file, out_dir, release): |
3997 | + topic_name = release.replace(' ', '-') |
3998 | + out_file.write(" %s\n" % (topic_name,)) |
3999 | + topic_path = os.path.join(out_dir, "%s.txt" % (topic_name,)) |
4000 | + result = open(topic_path, 'w') |
4001 | + result.write("%s\n" % (release,)) |
4002 | + return result |
4003 | + |
4004 | + |
4005 | +def main(argv): |
4006 | + # Check usage |
4007 | + parser = OptionParser(usage="%prog SOURCE DESTINATION") |
4008 | + (options, args) = parser.parse_args(argv) |
4009 | + if len(args) != 2: |
4010 | + parser.print_help() |
4011 | + sys.exit(1) |
4012 | + |
4013 | + # Open the files and do the work |
4014 | + infile_name = args[0] |
4015 | + outfile_name = args[1] |
4016 | + outdir = os.path.dirname(outfile_name) |
4017 | + infile = open(infile_name, 'r') |
4018 | + try: |
4019 | + lines = infile.readlines() |
4020 | + finally: |
4021 | + infile.close() |
4022 | + outfile = open(outfile_name, 'w') |
4023 | + try: |
4024 | + split_into_topics(lines, outfile, outdir) |
4025 | + finally: |
4026 | + outfile.close() |
4027 | + |
4028 | + |
4029 | +if __name__ == '__main__': |
4030 | + main(sys.argv[1:]) |
This patch extends/supersedes the PDF/CHM doc patch by pulling out the developer and foreign language docs into their own websites/chm files. This fixes numerous CHM-related bugs, e.g. searching now gives sensible and useful results.
Some other related changes included are:
* The Developer Guide has moved from under the 'user docs' directory to being under the Developer doc area so that links in CHM are local and work as expected
* For similar reasons, links from foreign language sites to explicit English docs via local URLs have also been removed
* The Russian and Spanish sites now have updated links to the preferred FAQ (LP Answers) and the Migration Docs
* The Russian and Spanish sites now use their native languages for next/previous/ search, etc.
* A link to Emma's Contributing to the docs wiki-page has been added into the Developer docs TOC.
* The developer docs TOC has been split into separate documents (based on the current sections) so that the CHM file has 10 top-level topics in it's TOC, not 50 odd.
Ian C.