Merge lp:~ian-clatworthy/bzr/doc-site-per-language into lp:bzr/2.0

Proposed by Ian Clatworthy
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

This proposal supersedes a proposal from 2009-09-08.

This proposal has been superseded by a proposal from 2009-09-09.

To post a comment you must log in.
Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote : Posted in a previous version of this proposal

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.

Revision history for this message
Robert Collins (lifeless) wrote : Posted in a previous version of this proposal

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

review: Needs Fixing
Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote : Posted in a previous version of this proposal

> Is it rendered somewhere we can look at?

I've uploaded the Developer docs to http://doc.bazaar-vcs.org/developers/. I'm yet to upload the other docs though the English ones don't look any different externally - non-user docs are simply not there any more.

> 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://bazaar-vcs.org/LogoOptions. The svg is attached there I believe.

> 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.

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote : Posted in a previous version of this proposal

This version cleans up the Makefile and gets PDF generation going for the Developer and Spanish docs.

Revision history for this message
Martin Pool (mbp) wrote : Posted in a previous version of this proposal

That looks pretty good. Certainly it's a very nice cleanup of an ugly part of the makefile. My only real concern is the copy & paste of the version number.

Does this add a new hard dependency on anything? If so, we should be careful of the impact on distributions and packagers.

Thanks for fixing the style of NEWS.

1547 +
1548 +# We *could* get this from bzrlib but there's no certainly that the bzr on
1549 +# the Python path is indeed the one we're building the documentation for ...
1550 +bzr_version = (2, 0, 0, 'rc', 2)
1551 +
1552 +

urk, you're right that just 'import bzrlib' will be problematic, but this is almost certainly going to become incorrect. If from the Makefile you do "PYTHONPATH=.:$PYTHONPATH" then future loads of bzrlib should see the right thing.

Especially because it occurs not once but three or more times.

+release = version + ''.join(str(p) for p in bzr_version[3:])

Could you import and use _format_version_tuple?

+http://doc.bazaar-vcs.org/developers/.

Put it in angle brackets so the . isn't part of the url? (I guess it's harmless.)

2079 Bazaar Developer Document Catalog
2080 =================================
2081
2082 -
2083 -Overall developer documentation
2084 -===============================
2085 -
2086 -* `Developer Guide <../en/developer-guide/HACKING.html>`_
2087 -
2088 -* `Architectural Overview <overview.html>`_ |--| describes some of the
2089 - most important classes and concepts.
2090 +.. toctree::
2091 + :hidden:
2092 +
2093 + process
2094 + HACKING
2095 + testing
2096 + overview
2097 + integration
2098 + plans
2099 + specifications
2100 + implementation-notes
2101 + miscellaneous-notes
2102 +
2103 +
2104 +Core developer documentation

What does this do?

Could sphinx help us get away from manually maintaining indexes of documentation?

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote : Posted in a previous version of this proposal

Martin Pool wrote:
> My only real concern is the copy & paste of the version number.

Yes, that's ugly.

> Does this add a new hard dependency on anything? If so, we should be careful of the impact on distributions and packagers.

Sphinx 0.6.x. I guess packagers could pull the generated html docs from
our download area if that's a problem?

The patch currently builds both html and PDF by default. It's probably
better to tweak that to be just the html as the PDF generation requires
a lot of LaTeX-related dependencies.

> 1547 +
> 1548 +# We *could* get this from bzrlib but there's no certainly that the bzr on
> 1549 +# the Python path is indeed the one we're building the documentation for ...
> 1550 +bzr_version = (2, 0, 0, 'rc', 2)
> 1551 +
> 1552 +
>
> urk, you're right that just 'import bzrlib' will be problematic, but this is almost certainly going to become incorrect. If from the Makefile you do "PYTHONPATH=.:$PYTHONPATH" then future loads of bzrlib should see the right thing.

I'd be happy enough to sort this out post shipping rc2. I'm
expecting/hoping to make some *minor* doc tweaks (e.g. fix some
cross-document links) and streamlining the version lookup could come as
part of that patch if you agree?

We need to tweak multiple Makefiles for all 4+ of them to pick up the
right version number. I guess there's some simple, risk-free way of
doing this, but I wasn't inspired at the time to work it out. (We have
various Makefiles are different levels btw.)

> +release = version + ''.join(str(p) for p in bzr_version[3:])
>
> Could you import and use _format_version_tuple?

Probably.

> +http://doc.bazaar-vcs.org/developers/.
>
> Put it in angle brackets so the . isn't part of the url? (I guess it's harmless.)

I assume that's a ReST-ism?

> 2079 Bazaar Developer Document Catalog
> 2080 =================================
> 2081
> 2082 -
> 2083 -Overall developer documentation
> 2084 -===============================
> 2085 -
> 2086 -* `Developer Guide <../en/developer-guide/HACKING.html>`_
> 2087 -
> 2088 -* `Architectural Overview <overview.html>`_ |--| describes some of the
> 2089 - most important classes and concepts.
> 2090 +.. toctree::
> 2091 + :hidden:
> 2092 +
> 2093 + process
> 2094 + HACKING
> 2095 + testing
> 2096 + overview
> 2097 + integration
> 2098 + plans
> 2099 + specifications
> 2100 + implementation-notes
> 2101 + miscellaneous-notes
> 2102 +
> 2103 +
> 2104 +Core developer documentation
>
> What does this do?

It:

1. ensures next and previous topic links work
2. provides checking that all files are in the topic tree somewhere
3. probably provides some other magic I can't remember (or don't know).

> Could sphinx help us get away from manually maintaining indexes of documentation?

It can build a readable TOC from the toctree directive by taking the
titles out of each doc, yes. It can also do some true index stuff but
I'm yet to look into that.

Ian C.

Revision history for this message
Martin Pool (mbp) wrote : Posted in a previous version of this proposal

2009/9/8 Ian Clatworthy <email address hidden>:
> Martin Pool wrote:
>> My only real concern is the copy & paste of the version number.
>
> Yes, that's ugly.

I think it's still ok to merge for 2.0rc2 if the results are much
better, if we try to do a followon to remove the duplication and if
the dependency on sphinx is not mandatory. Because we know sphinx is
hard to build on old platforms this could break packaging on ubuntu
<<jaunty, and that would be bad. Is it feasible to fall back to a
non-sphinx method?

>> urk, you're right that just 'import bzrlib' will be problematic, but this is almost certainly going to become incorrect.  If from the Makefile you do "PYTHONPATH=.:$PYTHONPATH" then future loads of bzrlib should see the right thing.
>
> I'd be happy enough to sort this out post shipping rc2. I'm
> expecting/hoping to make some *minor* doc tweaks (e.g. fix some
> cross-document links) and streamlining the version lookup could come as
> part of that patch if you agree?
>
> We need to tweak multiple Makefiles for all 4+ of them to pick up the
> right version number. I guess there's some simple, risk-free way of
> doing this, but I wasn't inspired at the time to work it out. (We have
> various Makefiles are different levels btw.)
>
>> +release = version + ''.join(str(p) for p in bzr_version[3:])
>>
>> Could you import and use _format_version_tuple?
>
> Probably.

It's probably worth doing that only at the moment of switching to
taking the version from bzrlib - in fact you might as well take the
formatted string.

>
>> +http://doc.bazaar-vcs.org/developers/.
>>
>> Put it in angle brackets so the . isn't part of the url?  (I guess it's harmless.)
>
> I assume that's a ReST-ism?

Yes.

>> Could sphinx help us get away from manually maintaining indexes of documentation?
>
> It can build a readable TOC from the toctree directive by taking the
> titles out of each doc, yes. It can also do some true index stuff but
> I'm yet to look into that.

Great - I actually meant 'index' only in the sense of 'index.html' ie
really a ToC.

--
Martin <http://launchpad.net/~mbp/>

Revision history for this message
Robert Collins (lifeless) wrote : Posted in a previous version of this proposal

On Tue, 2009-09-08 at 02:35 +0000, Ian Clatworthy wrote:
> Ian Clatworthy has proposed merging lp:~ian-clatworthy/bzr/doc-site-per-language into lp:bzr/2.0.

From the prior review:

>> 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.

It will be a /lot/ easier to review, and to change, if this is done as
part of the landing.

If its a hard thing to do, then its likely it will be hard to do post
2.0. So I think it should be at least attempted now, so we're not
diffing 4 or so config files later on as we tweak the docs.

>> 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.

You still have 4 or so repeated makefile.

I think thats a very bad pattern; GNU Make (which is the only make we
need to depend on : we're not part of the bootstrap cycle on any os)
allows includes and can do this without the duplication.

I really really really think this is important to get right before
landing, or we'll have a cleanup problem on our hands where its not
clear what varies, and what doesn't.

 review needsfixing

-Rob

review: Needs Fixing
Revision history for this message
Robert Collins (lifeless) wrote : Posted in a previous version of this proposal

On Tue, 2009-09-08 at 08:51 +0000, Robert Collins wrote:

> You still have 4 or so repeated makefile.
>
> I think thats a very bad pattern; GNU Make (which is the only make we
> need to depend on : we're not part of the bootstrap cycle on any os)
> allows includes and can do this without the duplication.
>
> I really really really think this is important to get right before
> landing, or we'll have a cleanup problem on our hands where its not
> clear what varies, and what doesn't.

I'll note that Martin says its ok to land; and its his call. OTOH we
still have a long list of things to cleanup around 2.0; cleaning this up
will be less trivial the longer we leave it.

As its 'just' docs, we could ship 2.0rc2 without this patch, generate
docs from it, and once the duplication is fixed land it.

-Rob

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote : Posted in a previous version of this proposal

Robert Collins wrote:

> If its a hard thing to do, then its likely it will be hard to do post
> 2.0. So I think it should be at least attempted now, so we're not
> diffing 4 or so config files later on as we tweak the docs.

These are generated files and 90% of them are comments. I therefore
don't think the duplication is a practical problem of high enough
importance to block the patch from landing. The exception to that is the
bzr version #. That's not changing pre 2.0rc2 though. :-)

> You still have 4 or so repeated makefile.

The Makefiles are fully generated and 0% post edited since generation.
Ditto for the 4 make.bat files.

There are plenty of solutions to fixing the duplication. I'm not
disagreeing that it's a problem. I simply think there are bigger
user-impacting issues than ought to be fixed *first* in the docs, e.g.
links that are broken. On the maintenance/internal side of things, there
are bigger issues too, e.g. extending the Makefile with rules to package
the various sites into tar.gz bundles for uploading to doc.bazaar-vcs.org.

I'm planning to do all of the above, hopefully post 2.0rc2 and pre 2.0.
This is still a valuable incremental step forward today and landing it
will make reviewing those follow-on doc patches much easier IMO.

Ian C.

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote : Posted in a previous version of this proposal

Martin Pool wrote:

> if
> the dependency on sphinx is not mandatory. Because we know sphinx is
> hard to build on old platforms this could break packaging on ubuntu
> <<jaunty, and that would be bad. Is it feasible to fall back to a
> non-sphinx method?

Once this patch lands, Sphinx is mandatory. There are 2 reasons for that:

1. to get things working correctly w.r.t. topic-centric navigation
   and multiple formats, the docs now include Sphinx-only markup,
   e.g. the toctree directive and :doc: links.

2. The old rules have been removed from the Makefile.

Ian C.

Revision history for this message
John A Meinel (jameinel) wrote : Posted in a previous version of this proposal

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

...
> 1547 +
> 1548 +# We *could* get this from bzrlib but there's no certainly that the bzr on
> 1549 +# the Python path is indeed the one we're building the documentation for ...
> 1550 +bzr_version = (2, 0, 0, 'rc', 2)
> 1551 +
> 1552 +
>
> urk, you're right that just 'import bzrlib' will be problematic, but this is almost certainly going to become incorrect. If from the Makefile you do "PYTHONPATH=.:$PYTHONPATH" then future loads of bzrlib should see the right thing.
>
> Especially because it occurs not once but three or more times.
>

Note that PYTHONPATH=.:$PYTHONPATH
*doesn't* work on Windows. Cygwin has a lot of intelligence about handling
  PATH=/cygdrive/c/foo:$PATH => PATH=C:\foo;$PATH
but it doesn't seem to apply that to all env vars, just ones it knows about.

I know I had to recently remove a lot of lines like:

 PYTHONPATH=.:$PYTHONPATH $(PYTHON) tools/generate_docs.py ...

by modifying 'generate_docs.py' to find its bzrlib.

I don't have a great answer here, but just wanted to make people aware
that "PYTHONPATH=.:$PYTHONPATH" is not a sufficient solution. :(

(Maybe we could just have a bootstrap.py file that figures out where
bzrlib is and puts it in sys.path as the first action or sets PYTHONPATH
based on platform?)

John
=:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkqmX/sACgkQJdeBCYSNAAMv0QCgyW8kmWOMMMuj5tcm62Pr69bj
nScAoJoVx8sXohYWpEsAugQoFonvOX9i
=wEcj
-----END PGP SIGNATURE-----

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote : Posted in a previous version of this proposal

This version removes most of the duplication Robert was concerned about.

It also:

* includes a first cut at a packaging script for building the desired structure on the doc web site.

* switches the sidebar to the LHS which ought to fix the IE6 (and IE7?) rendering issue.

* makes some more developer docs available as PDF.

Revision history for this message
Martin Pool (mbp) wrote : Posted in a previous version of this proposal

2009/9/8 Ian Clatworthy <email address hidden>:
> Martin Pool wrote:
>
>> if
>> the dependency on sphinx is not mandatory.  Because we know sphinx is
>> hard to build on old platforms this could break packaging on ubuntu
>> <<jaunty, and that would be bad.  Is it feasible to fall back to a
>> non-sphinx method?
>
> Once this patch lands, Sphinx is mandatory. There are 2 reasons for that:
>
> 1. to get things working correctly w.r.t. topic-centric navigation
>   and multiple formats, the docs now include Sphinx-only markup,
>   e.g. the toctree directive and :doc: links.
>
> 2. The old rules have been removed from the Makefile.

For me, that would be a big disincentive to land this after 2.0 has
branched. We shouldn't be shaking the jello under packagers...

--
Martin <http://launchpad.net/~mbp/>

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote :

This version correctly packages the html while building the doc website image. It also fixes the Contents panels in the CHM files. With the exception of some broken links, I believe this is now done.

The final website image including the English, Spanish, Russian, Developers and Downloads sections can be reviewed here: http://doc.bazaar-vcs.org/preview/. (Note the the cross-version HTML indexes will point directly into the en and downloads directories say, so navigation into the various sections won't be done via a directory listing like above.)

Revision history for this message
Martin Pool (mbp) wrote :

It looks like this also gets rid of the duplication of the version numbers, which is great.

If this still adds a hard dependency on sphinx then I'd still be concerned about the impact on packaging; please don't land this til that's addressed or I'm convinced otherwise.

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote :

Martin Pool wrote:
> It looks like this also gets rid of the duplication of the version numbers, which is great.

It does.

> If this still adds a hard dependency on sphinx then I'd still be concerned about the impact on packaging; please don't land this til that's addressed or I'm convinced otherwise.

Sure. Some things to consider:

1. All the distros packaging Bazaar are also packaging python and it's
docs are in Sphinx too. So whatever solution there are using for
packaging the python docs can be reused for Bazaar in theory.

2. The simple solution is for packagers to grab the html.tar.bz2
generated by us from doc.bazaar-vcs.org. There's no compelling reason
they must generate the doc themselves, unless they are applying
downstream patches which impact the doc (extremely unlikely I'd hope).

3. IMO, it would be far more risky to land this post rc2 than pre rc2.
The time between rc2 and 2.0 is the very time when packaging issues
ought to be detected and addressed.

Ian C.

Revision history for this message
Martin Pool (mbp) wrote :

2009/9/9 Ian Clatworthy <email address hidden>:
> Martin Pool wrote:
>> It looks like this also gets rid of the duplication of the version numbers, which is great.
>
> It does.
>
>> If this still adds a hard dependency on sphinx then I'd still be concerned about the impact on packaging; please don't land this til that's addressed or I'm convinced otherwise.
>
> Sure. Some things to consider:
>
> 1. All the distros packaging Bazaar are also packaging python and it's
> docs are in Sphinx too. So whatever solution there are using for
> packaging the python docs can be reused for Bazaar in theory.

That's useful data.

The case I'm thinking of is this though:
http://packages.ubuntu.com/search?keywords=python-sphinx shows jaunty
has sphinx 0.5.2, intrepid has 0.4.2 and early versions have nothing.
Presumably the Python they ship does not depend on sphinx and comes
from before Python started using it. I'm concerned that the circular
dependency our sysadmins pointed out may make it hard to get sphinx
running there. I do want to get bzr 2.0 packaged for Jaunty (at
least).

> 2. The simple solution is for packagers to grab the html.tar.bz2
> generated by us from doc.bazaar-vcs.org. There's no compelling reason
> they must generate the doc themselves, unless they are applying
> downstream patches which impact the doc (extremely unlikely I'd hope).

That seems to mean we can just apply this patch and build the docs
ourselves, regardless of whether it lands?

> 3. IMO, it would be far more risky to land this post rc2 than pre rc2.
> The time between rc2 and 2.0 is the very time when packaging issues
> ought to be detected and addressed.

I agree, it's essentially either now or not in 2.0 at all, but which?

--
Martin <http://launchpad.net/~mbp/>

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file '.bzrignore'
2--- .bzrignore 2009-07-31 19:56:19 +0000
3+++ .bzrignore 2009-09-08 15:44:06 +0000
4@@ -8,6 +8,9 @@
5 bzr.1
6 ./doc/*.html
7 ./doc/_build/
8+./doc/*/_build/
9+./doc/*/Makefile
10+./doc/*/make.bat
11 ./tutorial.html
12 BRANCH-INFO
13 # setup.py working directory
14@@ -53,6 +56,7 @@
15 bzrlib/_rio_pyx.c
16 bzrlib/_walkdirs_win32.c
17 doc/en/release-notes/NEWS.txt
18+doc/en/release-notes/bzr*
19 doc/en/developer-guide/HACKING.txt
20 doc/en/user-reference/bzr_man.txt
21 # built extension modules
22
23=== modified file 'Makefile'
24--- Makefile 2009-08-03 20:38:39 +0000
25+++ Makefile 2009-09-08 15:40:44 +0000
26@@ -1,4 +1,4 @@
27-# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
28+# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
29 #
30 # This program is free software; you can redistribute it and/or modify
31 # it under the terms of the GNU General Public License as published by
32@@ -77,102 +77,64 @@
33 # these are treated as phony so they'll always be rebuilt - it's pretty quick
34 .PHONY: TAGS tags
35
36+
37 ### Documentation ###
38
39-# set PRETTY to get docs that look like the Bazaar web site
40-ifdef PRETTY
41-rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid
42-else
43-rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
44-endif
45-
46-# translate txt docs to html
47-derived_txt_files := \
48- doc/en/user-reference/bzr_man.txt \
49- doc/en/release-notes/NEWS.txt
50-txt_files := \
51- doc/en/tutorials/tutorial.txt \
52- doc/en/tutorials/using_bazaar_with_launchpad.txt \
53- doc/en/tutorials/centralized_workflow.txt \
54- $(wildcard doc/ru/tutorials/*.txt) \
55- $(wildcard doc/*/mini-tutorial/index.txt) \
56- $(wildcard doc/*/user-guide/index.txt) \
57- $(derived_txt_files) \
58- doc/en/developer-guide/HACKING.txt \
59- doc/en/upgrade-guide/index.txt \
60- $(wildcard doc/es/guia-usario/*.txt) \
61- doc/es/mini-tutorial/index.txt \
62- doc/index.txt \
63- $(wildcard doc/index.*.txt)
64-non_txt_files := \
65- doc/default.css \
66- $(wildcard doc/*/quick-reference/bzr-quick-reference.svg) \
67- $(wildcard doc/*/quick-reference/bzr-quick-reference.png) \
68- $(wildcard doc/*/quick-reference/bzr-quick-reference.pdf) \
69- $(wildcard doc/*/user-guide/images/*.png)
70-htm_files := $(patsubst %.txt, %.html, $(txt_files))
71-
72-# doc/developers/*.txt files that should *not* be individually
73-# converted to HTML
74-dev_txt_nohtml := \
75- doc/developers/add.txt \
76- doc/developers/annotate.txt \
77- doc/developers/bundle-creation.txt \
78- doc/developers/commit.txt \
79- doc/developers/diff.txt \
80- doc/developers/directory-fingerprints.txt \
81- doc/developers/gc.txt \
82- doc/developers/incremental-push-pull.txt \
83- doc/developers/initial-push-pull.txt \
84- doc/developers/merge-scaling.txt \
85- doc/developers/missing.txt \
86- doc/developers/performance-roadmap-rationale.txt \
87- doc/developers/performance-use-case-analysis.txt \
88- doc/developers/planned-change-integration.txt \
89- doc/developers/planned-performance-changes.txt \
90- doc/developers/revert.txt \
91- doc/developers/status.txt \
92- doc/developers/uncommit.txt
93-
94-dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
95-dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
96-dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
97-
98-doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide))
99- $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
100-
101-# Set the paper size for PDF files.
102-# Options: 'a4' (ISO A4 size), 'letter' (US Letter size)
103-PAPERSIZE = a4
104-# TODO: Add generation for Russian PDF
105-PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
106-
107-# Copy and modify the RST sources, and convert SVG images to PDF
108-# files for use a images in the LaTeX-generated PDF.
109-# Then generate the PDF output from the modified RST sources.
110-doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
111- mkdir -p doc/en/user-guide/latex_prepared
112- $(PYTHON) tools/prepare_for_latex.py \
113- --out-dir=doc/en/user-guide/latex_prepared \
114- --in-dir=doc/en/user-guide
115- cd doc/en/user-guide/latex_prepared && \
116- $(PYTHON) ../../../../tools/rst2pdf.py \
117- --documentoptions=10pt,$(PAPERSIZE)paper \
118- --input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
119- --strict --title="Bazaar User Guide" \
120- index.txt ../user-guide.$(PAPERSIZE).pdf
121-
122-doc/developers/%.html: doc/developers/%.txt
123- $(rst2html) --stylesheet=../default.css $< $@
124-
125-doc/index.html: doc/index.txt
126- $(rst2html) --stylesheet=default.css $< $@
127-
128-doc/index.%.html: doc/index.%.txt
129- $(rst2html) --stylesheet=default.css $< $@
130-
131-%.html: %.txt
132- $(rst2html) --stylesheet=../../default.css $< $@
133+# Build the documentation. To keep the dependencies down to a minimum
134+# for distro packagers, we only build the html documentation by default.
135+# Sphinx 0.6 or later is required. See http://sphinx.pocoo.org/index.html
136+# for installation instructions.
137+docs: html-docs
138+
139+# Clean out generated documentation
140+clean-docs:
141+ cd doc/en && make clean
142+ cd doc/es && make clean
143+ cd doc/ru && make clean
144+ cd doc/developers && make clean
145+
146+DOC_DEPENDENCIES = doc/en/release-notes/NEWS.txt doc/en/user-reference/bzr_man.txt \
147+ doc/es/Makefile \
148+ doc/es/make.bat \
149+ doc/ru/Makefile \
150+ doc/ru/make.bat \
151+ doc/developers/Makefile \
152+ doc/developers/make.bat
153+
154+doc/%/Makefile: doc/en/Makefile
155+ $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
156+
157+doc/%/make.bat: doc/en/make.bat
158+ $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
159+
160+# Build the html docs. Requires Sphinx 0.6 or later.
161+html-docs: $(DOC_DEPENDENCIES)
162+ cd doc/en && make html
163+ cd doc/es && make html
164+ cd doc/ru && make html
165+ cd doc/developers && make html
166+
167+# Build the PDF docs. Requires Sphinx 0.6 or later and numerous LaTeX
168+# packages. See http://sphinx.pocoo.org/builders.html for details.
169+# Note: We don't currently build PDFs for the Russian docs because
170+# they require additional packages to be installed (to handle
171+# Russian hyphenation rules, etc.)
172+pdf-docs: $(DOC_DEPENDENCIES)
173+ cd doc/en && make latex
174+ cd doc/es && make latex
175+ cd doc/developers && make latex
176+ cd doc/en/_build/latex && make all-pdf
177+ cd doc/es/_build/latex && make all-pdf
178+ cd doc/developers/_build/latex && make all-pdf
179+
180+# Build the CHM (Windows Help) docs. Requires Sphinx 0.6 or later.
181+# Note: HtmlHelp Workshop needs to be used on the generated hhp files
182+# to generate the final chm files.
183+chm-docs: $(DOC_DEPENDENCIES)
184+ cd doc/en && make htmlhelp
185+ cd doc/es && make htmlhelp
186+ cd doc/ru && make htmlhelp
187+ cd doc/developers && make htmlhelp
188
189 MAN_DEPENDENCIES = bzrlib/builtins.py \
190 $(wildcard bzrlib/*.py) \
191@@ -183,46 +145,31 @@
192 doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
193 $(PYTHON) tools/generate_docs.py -o $@ rstx
194
195-doc/en/release-notes/NEWS.txt: NEWS
196- $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
197+doc/en/release-notes/NEWS.txt: NEWS tools/generate_release_notes.py
198+ $(PYTHON) tools/generate_release_notes.py NEWS $@
199
200 MAN_PAGES = man1/bzr.1
201 man1/bzr.1: $(MAN_DEPENDENCIES)
202 $(PYTHON) tools/generate_docs.py -o $@ man
203
204-upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
205-
206-doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
207- $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
208-
209 # build a png of our performance task list
210-#
211 # this is no longer built by default; you can build it if you want to look at it
212 doc/developers/performance.png: doc/developers/performance.dot
213 @echo Generating $@
214 @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
215
216-derived_web_docs = $(htm_files) $(dev_htm_files)
217-WEB_DOCS = $(derived_web_docs) $(non_txt_files)
218-ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
219-
220-# the main target to build all the docs
221-docs: $(ALL_DOCS)
222-
223-# produce a tree containing just the final docs, ready for uploading to the web
224-HTMLDIR := html_docs
225-html-docs: docs
226- $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
227-
228-# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
229-pdf-docs: $(PDF_DOCS)
230-
231-# clean produced docs
232-clean-docs:
233- $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
234- $(HTMLDIR) $(derived_txt_files)
235- rm -f doc/*/user-guide/*.pdf
236- rm -rf doc/*/user-guide/latex_prepared
237+
238+### Documentation Website ###
239+
240+# Where to build the website
241+DOC_WEBSITE_BUILD := html_docs
242+
243+# Build and package docs into a website, complete with downloads.
244+doc-website: html-docs pdf-docs
245+ $(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
246+ $(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
247+ $(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
248+ $(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
249
250
251 ### Windows Support ###
252
253=== modified file 'NEWS'
254--- NEWS 2009-09-07 23:47:14 +0000
255+++ NEWS 2009-09-08 01:46:53 +0000
256@@ -3,9 +3,6 @@
257 ####################
258
259
260-.. contents:: List of Releases
261- :depth: 1
262-
263 bzr 2.0rc2 (not released yet)
264 #############################
265
266@@ -86,6 +83,14 @@
267 * Help on hooks no longer says 'Not deprecated' for hooks that are
268 currently supported. (Ian Clatworthy, #422415)
269
270+* PDF and CHM (Windows HtmlHelp) formats are now supported for the
271+ user documentation. The HTML documentation is better broken up into
272+ topics. (Ian Clatworthy)
273+
274+* The developer and foreign language documents are now separated
275+ out so that searching in the HTML and CHM files produces more
276+ useful results. (Ian Clatworthy)
277+
278 * The main table of contents now provides links to the new Migration Docs
279 and Plugins Guide. (Ian Clatworthy)
280
281@@ -93,7 +98,6 @@
282 bzr 2.0rc1
283 ##########
284
285-
286 :Codename: no worries
287 :2.0rc1: 2009-08-26
288
289@@ -558,8 +562,8 @@
290 ``countTestsCases``. (Robert Collins)
291
292
293-bzr 1.17 "So late it's brunch" 2009-07-20
294-#########################################
295+bzr 1.17
296+########
297 :Codename: so-late-its-brunch
298 :1.17rc1: 2009-07-13
299 :1.17: 2009-07-20
300@@ -808,8 +812,10 @@
301 this class and the UI. (Martin Pool)
302
303
304-bzr 1.16.1 2009-06-26
305-#####################
306+bzr 1.16.1
307+##########
308+
309+:Released: 2009-06-26
310
311 End user testing of the 2a format revealed two serious bugs. The first,
312 #365615, caused bzr to raise AbsentContentFactory errors when autopacking.
313@@ -864,8 +870,8 @@
314 (Robert Collins, #376748)
315
316
317-bzr 1.16 "It's yesterday in California" 2009-06-18
318-##################################################
319+bzr 1.16
320+########
321 :Codename: yesterday-in-california
322 :1.16rc1: 2009-06-11
323 :1.16: 2009-06-18
324@@ -2339,8 +2345,11 @@
325 (Vincent Ladeuil)
326
327
328-bzr 1.11 "Eyes up!" 2009-01-19
329-##############################
330+bzr 1.11
331+########
332+
333+:Codename: "Eyes up!"
334+:Released: 2009-01-19
335
336 This first monthly release of Bazaar for 2009 improves Bazaar's operation
337 in Windows, Mac OS X, and other situations where file names are matched
338@@ -2366,8 +2375,11 @@
339
340
341
342-bzr 1.11rc1 "Eyes up!" 2009-01-09
343-#################################
344+bzr 1.11rc1
345+###########
346+
347+:Codename: "Eyes up!"
348+:Released: 2009-01-09
349
350 Changes
351 *******
352@@ -2603,8 +2615,10 @@
353
354
355
356-bzr 1.10 2008-12-05
357-###################
358+bzr 1.10
359+########
360+
361+:Released: 2008-12-05
362
363 Bazaar 1.10 has several performance improvements for copying revisions
364 (especially for small updates to large projects). There has also been a
365@@ -2629,8 +2643,10 @@
366 topologically. (John Arbash Meinel, #304841)
367
368
369-bzr 1.10rc1 2008-11-28
370-######################
371+bzr 1.10rc1
372+###########
373+
374+:Released: 2008-11-28
375
376 This release of Bazaar focuses on performance improvements when pushing
377 and pulling revisions, both locally and to remote networks. The popular
378@@ -2750,8 +2766,10 @@
379 * Doctests now only report the first failure. (Martin Pool)
380
381
382-bzr 1.9 2008-11-07
383-##################
384+bzr 1.9
385+#######
386+
387+:Released: 2008-11-07
388
389 This release of Bazaar adds a new repository format, ``1.9``, with smaller
390 and more efficient index files. This format can be specified when
391@@ -2773,8 +2791,10 @@
392 (John Arbash Meinel, #293746)
393
394
395-bzr 1.9rc1 2008-10-31
396-#####################
397+bzr 1.9rc1
398+##########
399+
400+:Released: 2008-10-31
401
402 New Features
403 ************
404@@ -2891,8 +2911,10 @@
405 configuration of authetication credentials.
406
407
408-bzr 1.8 2008-10-16
409-##################
410+bzr 1.8
411+#######
412+
413+:Released: 2008-10-16
414
415 Bazaar 1.8 includes several fixes that improve working tree performance,
416 display of revision logs, and merges. The bzr testsuite now passes on OS
417@@ -2913,8 +2935,10 @@
418 that platform. (Alexander Belchenko, Martin Pool, #277481)
419
420
421-bzr 1.8rc1 2008-10-07
422-#####################
423+bzr 1.8rc1
424+##########
425+
426+:Released: 2008-10-07
427
428 Changes
429 *******
430@@ -3112,14 +3136,18 @@
431 (Vincent Ladeuil)
432
433
434-bzr 1.7.1 2008-10-01
435-####################
436+bzr 1.7.1
437+#########
438+
439+:Released: 2008-10-01
440
441 No changes from 1.7.1rc1.
442
443
444-bzr 1.7.1rc1 2008-09-24
445-#######################
446+bzr 1.7.1rc1
447+############
448+
449+:Released: 2008-09-24
450
451 This release just includes an update to how the merge algorithm handles
452 file paths when we encounter complex history.
453@@ -3134,8 +3162,10 @@
454 (John Arbash Meinel)
455
456
457-bzr 1.7 2008-09-23
458-##################
459+bzr 1.7
460+#######
461+
462+:Released: 2008-09-23
463
464 This release includes many bug fixes and a few performance and feature
465 improvements. ``bzr rm`` will now scan for missing files and remove them,
466@@ -3152,8 +3182,10 @@
467 packaging qbzr. (Mark Hammond)
468
469
470-bzr 1.7rc2 2008-09-17
471-#####################
472+bzr 1.7rc2
473+##########
474+
475+:Released: 2008-09-17
476
477 A few bug fixes from 1.7rc1. The biggest change is a new
478 ``RemoteBranch.get_stacked_on_url`` rpc. This allows clients that are
479@@ -3177,8 +3209,10 @@
480 (Andrew Bennetts)
481
482
483-bzr 1.7rc1 2008-09-09
484-#####################
485+bzr 1.7rc1
486+##########
487+
488+:Released: 2008-09-09
489
490 This release candidate for bzr 1.7 has several bug fixes and a few
491 performance and feature improvements. ``bzr rm`` will now scan for
492@@ -3375,16 +3409,20 @@
493 clients now use this mechanism. (Neil Martinsen-Burrell)
494
495
496-bzr 1.6.1 2008-09-05
497-####################
498+bzr 1.6.1
499+#########
500+
501+:Released: 2008-09-05
502
503 A couple regressions were found in the 1.6 release. There was a
504 performance issue when using ``bzr+ssh`` to branch large repositories,
505 and some problems with stacking and ``rich-root`` capable repositories.
506
507
508-bzr 1.6.1rc2 2008-09-03
509-#######################
510+bzr 1.6.1rc2
511+############
512+
513+:Released: 2008-09-03
514
515 Bug Fixes
516 *********
517@@ -3395,8 +3433,10 @@
518 (John Arbash Meinel, #264321)
519
520
521-bzr 1.6.1rc1 2008-08-29
522-#######################
523+bzr 1.6.1rc1
524+############
525+
526+:Released: 2008-08-29
527
528 This release fixes a few regressions found in the 1.6 client. Fetching
529 changes was using an O(N^2) buffering algorithm, so for large projects it
530@@ -3436,8 +3476,10 @@
531 (John Arbash Meinel, #262333)
532
533
534-bzr 1.6 2008-08-25
535-##################
536+bzr 1.6
537+#######
538+
539+:Released: 2008-08-25
540
541 Finally, the long awaited bzr 1.6 has been released. This release includes
542 new features like Stacked Branches, improved weave merge, and an updated
543@@ -3450,8 +3492,10 @@
544 TortoiseBzr in the standalone Windows installer.
545
546
547-bzr 1.6rc5 2008-08-19
548-#####################
549+bzr 1.6rc5
550+##########
551+
552+:Released: 2008-08-19
553
554 Bug Fixes
555 *********
556@@ -3463,8 +3507,10 @@
557 (This change was reverted when merged to bzr.dev)
558
559
560-bzr 1.6rc4 2008-08-18
561-#####################
562+bzr 1.6rc4
563+##########
564+
565+:Released: 2008-08-18
566
567 Bug Fixes
568 *********
569@@ -3474,8 +3520,10 @@
570 rather than preserving deltas. (John Arbash Meinel, #256757)
571
572
573-bzr 1.6rc3 2008-08-14
574-#####################
575+bzr 1.6rc3
576+##########
577+
578+:Released: 2008-08-14
579
580 Changes
581 *******
582@@ -3508,8 +3556,10 @@
583 development which is substantially faster. (Robert Collins)
584
585
586-bzr 1.6rc2 2008-08-13
587-#####################
588+bzr 1.6rc2
589+##########
590+
591+:Released: 2008-08-13
592
593 This release candidate has a few minor bug fixes, and some regression
594 fixes for Windows.
595@@ -3547,8 +3597,10 @@
596 will get the same results. (John Arbash Meinel, #232188)
597
598
599-bzr 1.6rc1 2008-08-06
600-#####################
601+bzr 1.6rc1
602+##########
603+
604+:Released: 2008-08-06
605
606 This release candidate for bzr 1.6 solidifies the new branch stacking
607 feature. Bazaar now recommends that users upgrade all knit repositories,
608@@ -3684,8 +3736,10 @@
609 (Ian Clatworthy)
610
611
612-bzr 1.6beta3 2008-07-17
613-#######################
614+bzr 1.6beta3
615+############
616+
617+:Released: 2008-07-17
618
619 This release adds a new 'stacked branches' feature allowing branches to
620 share storage without being in the same repository or on the same machine.
621@@ -3857,8 +3911,10 @@
622 (Robert Collins)
623
624
625-bzr 1.6beta2 2008-06-10
626-#######################
627+bzr 1.6beta2
628+############
629+
630+:Released: 2008-06-10
631
632 This release contains further progress towards our 1.6 goals of shallow
633 repositories, and contains a fix for some user-affecting bugs in the
634@@ -3941,9 +3997,10 @@
635 * Knit record serialisation is now stricter on what it will accept, to
636 guard against potential internal bugs, or broken input. (Robert Collins)
637
638-bzr 1.6beta1 2008-06-02
639-#######################
640+bzr 1.6beta1
641+############
642
643+:Released: 2008-06-02
644
645 Commands that work on the revision history such as push, pull, missing,
646 uncommit and log are now substantially faster. This release adds a
647@@ -4161,8 +4218,10 @@
648 (Martin Pool)
649
650
651-bzr 1.5 2008-05-16
652-##################
653+bzr 1.5
654+#######
655+
656+:Released: 2008-05-16
657
658 This release of Bazaar includes several updates to the documentation, and fixes
659 to prepare for making rich root support the default format. Many bugs have been
660@@ -4183,8 +4242,10 @@
661 (Ian Clatworthy)
662
663
664-bzr 1.5rc1 2008-05-09
665-#####################
666+bzr 1.5rc1
667+##########
668+
669+:Released: 2008-05-09
670
671 Changes
672 *******
673@@ -4354,8 +4415,10 @@
674 (Martin Pool)
675
676
677-bzr 1.4 2008-04-28
678-##################
679+bzr 1.4
680+#######
681+
682+:Released: 2008-04-28
683
684 This release of Bazaar includes handy improvements to the speed of log and
685 status, new options for several commands, improved documentation, and better
686@@ -4374,8 +4437,10 @@
687 (John Arbash Meinel, Andrew Bennetts, #214894)
688
689
690-bzr 1.4rc2 2008-04-21
691-#####################
692+bzr 1.4rc2
693+##########
694+
695+:Released: 2008-04-21
696
697 Bug Fixes
698 *********
699@@ -4398,8 +4463,10 @@
700 (Robert Collins, John Arbash Meinel)
701
702
703-bzr 1.4rc1 2008-04-11
704-#####################
705+bzr 1.4rc1
706+##########
707+
708+:Released: 2008-04-11
709
710 Changes
711 *******
712@@ -4686,14 +4753,18 @@
713 ``Graph.get_parent_map`` returns a dict of key:parents. (Robert Collins)
714
715
716-bzr 1.3.1 2008-04-09
717-####################
718+bzr 1.3.1
719+#########
720+
721+:Released: 2008-04-09
722
723 No changes from 1.3.1rc1.
724
725
726-bzr 1.3.1rc1 2008-04-04
727-#######################
728+bzr 1.3.1rc1
729+############
730+
731+:Released: 2008-04-04
732
733 Bug Fixes
734 *********
735@@ -4704,8 +4775,10 @@
736 (#208418, Andrew Bennetts, Martin Pool, Robert Collins)
737
738
739-bzr 1.3 2008-03-20
740-##################
741+bzr 1.3
742+#######
743+
744+:Released: 2008-03-20
745
746 Bazaar has become part of the GNU project <http://www.gnu.org>
747
748@@ -4721,8 +4794,10 @@
749 (#202778, Martin Pool)
750
751
752-bzr 1.3rc1 2008-03-16
753-#####################
754+bzr 1.3rc1
755+##########
756+
757+:Released: 2008-03-16
758
759 Notes When Upgrading
760 ********************
761@@ -4908,8 +4983,10 @@
762 format. (Robert Collins)
763
764
765-bzr 1.2 2008-02-15
766-##################
767+bzr 1.2
768+#######
769+
770+:Released: 2008-02-15
771
772 Bug Fixes
773 *********
774@@ -4917,8 +4994,10 @@
775 * Fix failing test in Launchpad plugin. (Martin Pool)
776
777
778-bzr 1.2rc1 2008-02-13
779-#####################
780+bzr 1.2rc1
781+##########
782+
783+:Released: 2008-02-13
784
785 Notes When Upgrading
786 ********************
787@@ -5119,13 +5198,17 @@
788 revision names etc. (Robert Collins)
789
790
791-bzr 1.1 2008-01-15
792-##################
793+bzr 1.1
794+#######
795+
796+:Released: 2008-01-15
797
798 (no changes from 1.1rc1)
799
800-bzr 1.1rc1 2008-01-05
801-#####################
802+bzr 1.1rc1
803+##########
804+
805+:Released: 2008-01-05
806
807 Changes
808 *******
809@@ -5335,8 +5418,10 @@
810 replaced by the new helper methods added in this release. (Robert Collins)
811
812
813-bzr 1.0 2007-12-14
814-##################
815+bzr 1.0
816+#######
817+
818+:Released: 2007-12-14
819
820 Documentation
821 *************
822@@ -5353,8 +5438,10 @@
823 (Ian Clatworthy)
824
825
826-bzr 1.0rc3 2007-12-11
827-#####################
828+bzr 1.0rc3
829+##########
830+
831+:Released: 2007-12-11
832
833 Changes
834 *******
835@@ -5395,8 +5482,10 @@
836 (Vincent Ladeuil)
837
838
839-bzr 1.0rc2 2007-12-07
840-#####################
841+bzr 1.0rc2
842+##########
843+
844+:Released: 2007-12-07
845
846 Improvements
847 ************
848@@ -5470,8 +5559,10 @@
849 ``started`` methods. (Matt Nordhoff)
850
851
852-bzr 1.0rc1 2007-11-30
853-#####################
854+bzr 1.0rc1
855+##########
856+
857+:Released: 2007-11-30
858
859 Notes When Upgrading
860 ********************
861@@ -5747,8 +5838,10 @@
862 * InventoryEntry.diff is now deprecated. Please use diff.DiffTree instead.
863
864
865-bzr 0.92 2007-11-05
866-###################
867+bzr 0.92
868+########
869+
870+:Released: 2007-11-05
871
872 Changes
873 *******
874@@ -5756,8 +5849,10 @@
875 * New uninstaller on Win32. (Alexander Belchenko)
876
877
878-bzr 0.92rc1 2007-10-29
879-######################
880+bzr 0.92rc1
881+###########
882+
883+:Released: 2007-10-29
884
885 Changes
886 *******
887@@ -6076,8 +6171,10 @@
888 raises a Python warning. (Martin Pool)
889
890
891-bzr 0.91 2007-09-26
892-###################
893+bzr 0.91
894+########
895+
896+:Released: 2007-09-26
897
898 Bug Fixes
899 *********
900@@ -6098,15 +6195,19 @@
901 (Andrew Bennetts)
902
903
904-bzr 0.91rc2 2007-09-11
905-######################
906+bzr 0.91rc2
907+###########
908+
909+:Released: 2007-09-11
910
911 * Replaced incorrect tarball for previous release; a debug statement was left
912 in bzrlib/remote.py.
913
914
915-bzr 0.91rc1 2007-09-11
916-######################
917+bzr 0.91rc1
918+###########
919+
920+:Released: 2007-09-11
921
922 Changes
923 *******
924@@ -6433,8 +6534,10 @@
925 [] to revert all files is deprecated. (Aaron Bentley)
926
927
928-bzr 0.90 2007-08-28
929-###################
930+bzr 0.90
931+########
932+
933+:Released: 2007-08-28
934
935 Improvements
936 ************
937@@ -6457,8 +6560,10 @@
938 and call ``create_repository`` on that. (Martin Pool)
939
940
941-bzr 0.90rc1 2007-08-14
942-######################
943+bzr 0.90rc1
944+###########
945+
946+:Released: 2007-08-14
947
948 Bugfixes
949 ********
950@@ -6730,8 +6835,10 @@
951 parameter. Varargs-style parameters are deprecated. (Aaron Bentley)
952
953
954-bzr 0.18 2007-07-17
955-####################
956+bzr 0.18
957+########
958+
959+:Released: 2007-07-17
960
961 Bugfixes
962 ********
963@@ -6739,8 +6846,10 @@
964 * Fix 'bzr add' crash under Win32 (Kuno Meyer)
965
966
967-bzr 0.18rc1 2007-07-10
968-#######################
969+bzr 0.18rc1
970+###########
971+
972+:Released: 2007-07-10
973
974 Bugfixes
975 ********
976@@ -6991,8 +7100,10 @@
977 (Vincent Ladeuil, #110448)
978
979
980-bzr 0.17 2007-06-18
981-####################
982+bzr 0.17
983+########
984+
985+:Released: 2007-06-18
986
987 Bugfixes
988 ********
989@@ -7004,8 +7115,10 @@
990 (Aaron Bentley, Ian Clatworthy, #120930)
991
992
993-bzr 0.17rc1 2007-06-12
994-#######################
995+bzr 0.17rc1
996+###########
997+
998+:Released: 2007-06-12
999
1000 Notes When Upgrading
1001 ********************
1002@@ -7106,8 +7219,10 @@
1003 your repository. (Previously Branch6 only supported revisions in your
1004 mainline). (John Arbash Meinel, #115343)
1005
1006-bzr 0.16 2007-05-07
1007-####################
1008+bzr 0.16
1009+########
1010+
1011+:Released: 2007-05-07
1012
1013 Bugfixes
1014 ********
1015@@ -7137,8 +7252,10 @@
1016 diff`` and ``bzr status`` significantly improving the speed of
1017 both. (John Arbash Meinel)
1018
1019-bzr 0.16rc2 2007-04-30
1020-#######################
1021+bzr 0.16rc2
1022+###########
1023+
1024+:Released: 2007-04-30
1025
1026 Bugfixes
1027 ********
1028@@ -7161,8 +7278,10 @@
1029 * ``WorkingTree4._iter_changes`` should not descend into unversioned
1030 directories. (John Arbash Meinel, #110399)
1031
1032-bzr 0.16rc1 2007-04-26
1033-#######################
1034+bzr 0.16rc1
1035+###########
1036+
1037+:Released: 2007-04-26
1038
1039 Notes When Upgrading
1040 ********************
1041@@ -7469,8 +7588,10 @@
1042 implementation of new auth schemes for both http and proxy.
1043 (Vincent Ladeuil)
1044
1045-bzr 0.15 2007-04-01
1046-###################
1047+bzr 0.15
1048+########
1049+
1050+:Released: 2007-04-01
1051
1052 Bugfixes
1053 ********
1054@@ -7482,8 +7603,10 @@
1055 checking out a branch that contains an old-format working tree.
1056 (Martin Pool)
1057
1058-bzr 0.15rc3 2007-03-26
1059-#######################
1060+bzr 0.15rc3
1061+###########
1062+
1063+:Released: 2007-03-26
1064
1065 Changes
1066 *******
1067@@ -7558,8 +7681,10 @@
1068 * Correctly handles mutiple permanent http redirections.
1069 (vila, #88780)
1070
1071-bzr 0.15rc2 2007-03-14
1072-#######################
1073+bzr 0.15rc2
1074+###########
1075+
1076+:Released: 2007-03-14
1077
1078 Notes When Upgrading
1079 ********************
1080@@ -7612,8 +7737,10 @@
1081 (Wouter van Heyst, #53483)
1082
1083
1084-bzr 0.15rc1 2007-03-07
1085-#######################
1086+bzr 0.15rc1
1087+###########
1088+
1089+:Released: 2007-03-07
1090
1091 Surprises
1092 *********
1093@@ -7843,8 +7970,10 @@
1094 before the rest of the suite. (Martin Pool)
1095
1096
1097-bzr 0.14 2007-01-23
1098-####################
1099+bzr 0.14
1100+########
1101+
1102+:Released: 2007-01-23
1103
1104 Improvements
1105 ************
1106@@ -7863,8 +7992,10 @@
1107 it is in is below a repository. (James Westby, #77306)
1108
1109
1110-bzr 0.14rc1 2007-01-16
1111-#######################
1112+bzr 0.14rc1
1113+###########
1114+
1115+:Released: 2007-01-16
1116
1117 Improvements
1118 ************
1119@@ -7998,14 +8129,18 @@
1120 (Alexander Belchenko, #68124)
1121
1122
1123-bzr 0.13 2006-12-05
1124-####################
1125+bzr 0.13
1126+########
1127+
1128+:Released: 2006-12-05
1129
1130 No changes from 0.13rc
1131
1132
1133-bzr 0.13rc1 2006-11-27
1134-#######################
1135+bzr 0.13rc1
1136+###########
1137+
1138+:Released: 2006-11-27
1139
1140 Improvements
1141 ************
1142@@ -8130,8 +8265,10 @@
1143 * TestingHTTPRequestHandler really handles the Range header
1144 (previously it was ignoring it and returning the whole file,).
1145
1146-bzr 0.12 2006-10-30
1147-####################
1148+bzr 0.12
1149+########
1150+
1151+:Released: 2006-10-30
1152
1153 Internals
1154 *********
1155@@ -8140,8 +8277,10 @@
1156 and remove benchmarks that take longer than 10min to run.
1157 (John Arbash Meinel)
1158
1159-bzr 0.12rc1 2006-10-23
1160-#######################
1161+bzr 0.12rc1
1162+###########
1163+
1164+:Released: 2006-10-23
1165
1166 Improvements
1167 ************
1168@@ -8262,13 +8401,17 @@
1169 option to set the BzrDir, Repository and Branch formats of the
1170 created objects. (Robert Collins, John Arbash Meinel)
1171
1172-bzr 0.11 2006-10-02
1173-####################
1174+bzr 0.11
1175+########
1176+
1177+:Released: 2006-10-02
1178
1179 * Smart server transport test failures on windows fixed. (Lukáš Lalinský).
1180
1181-bzr 0.11rc2 2006-09-27
1182-#######################
1183+bzr 0.11rc2
1184+###########
1185+
1186+:Released: 2006-09-27
1187
1188 Bug Fixes
1189 *********
1190@@ -8278,8 +8421,10 @@
1191 * Commit performance regression fixed. (Aaron Bentley, Robert Collins, John
1192 Arbash Meinel).
1193
1194-bzr 0.11rc1 2006-09-25
1195-#######################
1196+bzr 0.11rc1
1197+###########
1198+
1199+:Released: 2006-09-25
1200
1201 Improvements
1202 ************
1203@@ -8472,8 +8617,10 @@
1204 allow upgrades to a richer interface than the VFS one provided by
1205 Transport. (Andrew Bennetts, Martin Pool)
1206
1207-bzr 0.10 2006-08-29
1208-####################
1209+bzr 0.10
1210+########
1211+
1212+:Released: 2006-08-29
1213
1214 Improvements
1215 ************
1216@@ -8550,8 +8697,10 @@
1217 need to be installed. This should help make the life of packagers
1218 easier. (John Arbash Meinel)
1219
1220-bzr 0.9.0 2006-08-11
1221-#####################
1222+bzr 0.9.0
1223+#########
1224+
1225+:Released: 2006-08-11
1226
1227 Surprises
1228 *********
1229@@ -8818,16 +8967,20 @@
1230
1231 * "RevisionTree" is now in bzrlib/revisiontree.py. (Robert Collins)
1232
1233-bzr 0.8.2 2006-05-17
1234-#####################
1235+bzr 0.8.2
1236+#########
1237+
1238+:Released: 2006-05-17
1239
1240 Bug Fixes
1241 *********
1242
1243 * setup.py failed to install launchpad plugin. (Martin Pool)
1244
1245-bzr 0.8.1 2006-05-16
1246-#####################
1247+bzr 0.8.1
1248+#########
1249+
1250+:Released: 2006-05-16
1251
1252 Bug Fixes
1253 *********
1254@@ -8880,8 +9033,10 @@
1255 * Fix test case for bzr info in upgrading a standalone branch to metadir,
1256 uses bzrlib api now. (Olaf Conradi)
1257
1258-bzr 0.8 2006-05-08
1259-###################
1260+bzr 0.8
1261+#######
1262+
1263+:Released: 2006-05-08
1264
1265 Notes When Upgrading
1266 ********************
1267@@ -9142,8 +9297,10 @@
1268 * ``run_bzr`` and ``run_bzr_captured`` now accept a 'stdin="foo"'
1269 parameter which will provide String("foo") to the command as its stdin.
1270
1271-bzr 0.7 2006-01-09
1272-##################
1273+bzr 0.7
1274+#######
1275+
1276+:Released: 2006-01-09
1277
1278 Changes
1279 *******
1280@@ -9438,8 +9595,10 @@
1281 * ``bzrlib.osutils.safe_unicode`` now exists to provide parameter coercion
1282 for functions that need unicode strings. (Robert Collins)
1283
1284-bzr 0.6 2005-10-28
1285-##################
1286+bzr 0.6
1287+#######
1288+
1289+:Released: 2005-10-28
1290
1291 Improvements
1292 ************
1293@@ -9654,8 +9813,10 @@
1294 [-1] in the revision-history. (Andres Salomon)
1295
1296
1297-bzr 0.1.1 2005-10-12
1298-####################
1299+bzr 0.1.1
1300+#########
1301+
1302+:Released: 2005-10-12
1303
1304 Bug Fixes
1305 *********
1306@@ -9672,8 +9833,10 @@
1307 * Avoid some unnecessary http operations in branch and pull.
1308
1309
1310-bzr 0.1 2005-10-11
1311-##################
1312+bzr 0.1
1313+#######
1314+
1315+:Released: 2005-10-11
1316
1317 Notes
1318 *****
1319@@ -9802,8 +9965,10 @@
1320 of tests to run, e.g. ``bzr selftest test_weave``
1321
1322
1323-bzr 0.0.9 2005-09-23
1324-####################
1325+bzr 0.0.9
1326+#########
1327+
1328+:Released: 2005-09-23
1329
1330 Bug Fixes
1331 *********
1332@@ -9844,8 +10009,11 @@
1333 another (used by pull, merged, etc.)
1334
1335
1336-bzr 0.0.8 2005-09-20
1337-####################
1338+bzr 0.0.8
1339+#########
1340+
1341+:Released: 2005-09-20
1342+
1343
1344 Improvements
1345 ************
1346@@ -9895,8 +10063,10 @@
1347 * Quieten warnings about locking; patch from Matt Lavin.
1348
1349
1350-bzr-0.0.7 2005-09-02
1351-####################
1352+bzr-0.0.7
1353+#########
1354+
1355+:Released: 2005-09-02
1356
1357 New Features
1358 ************
1359@@ -9950,8 +10120,10 @@
1360
1361
1362
1363-bzr-0.0.6 2005-08-18
1364-####################
1365+bzr-0.0.6
1366+#########
1367+
1368+:Released: 2005-08-18
1369
1370 New Features
1371 ************
1372@@ -10036,8 +10208,10 @@
1373 * Fix bugs in committing only selected files or within a subdirectory.
1374
1375
1376-bzr-0.0.5 2005-06-15
1377-#####################
1378+bzr-0.0.5
1379+#########
1380+
1381+:Released: 2005-06-15
1382
1383 Changes
1384 *******
1385@@ -10178,8 +10352,10 @@
1386 2.4 is now only recommended.
1387
1388
1389-bzr-0.0.4 2005-04-22
1390-#####################
1391+bzr-0.0.4
1392+#########
1393+
1394+:Released: 2005-04-22
1395
1396 Enhancements
1397 ************
1398@@ -10247,8 +10423,10 @@
1399 from QuantumG.
1400
1401
1402-bzr-0.0.3 2005-04-06
1403-#####################
1404+bzr-0.0.3
1405+#########
1406+
1407+:Released: 2005-04-06
1408
1409 Enhancements
1410 ************
1411@@ -10302,8 +10480,11 @@
1412 * Win32 fixes from Steve Brown.
1413
1414
1415-bzr-0.0.2 "black cube" 2005-03-31
1416-###################################
1417+bzr-0.0.2
1418+#########
1419+
1420+:Codename: "black cube"
1421+:Released: 2005-03-31
1422
1423 Enhancements
1424 ************
1425@@ -10331,8 +10512,10 @@
1426 the root directory only.
1427
1428
1429-bzr-0.0.1 2005-03-26
1430-#####################
1431+bzr-0.0.1
1432+#########
1433+
1434+:Released: 2005-03-26
1435
1436 Enhancements
1437 ************
1438@@ -10361,8 +10544,10 @@
1439 supported).
1440
1441
1442-bzr-0.0.0.69 2005-03-22
1443-########################
1444+bzr-0.0.0.69
1445+############
1446+
1447+:Released: 2005-03-22
1448
1449 Enhancements
1450 ************
1451
1452=== added file 'bzrlib/doc_generate/sphinx_conf.py'
1453--- bzrlib/doc_generate/sphinx_conf.py 1970-01-01 00:00:00 +0000
1454+++ bzrlib/doc_generate/sphinx_conf.py 2009-09-08 16:37:05 +0000
1455@@ -0,0 +1,214 @@
1456+# -*- coding: utf-8 -*-
1457+#
1458+# Bazaar documentation build configuration file, created by
1459+# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
1460+#
1461+# All configuration values have a default; values that are commented out
1462+# serve to show the default.
1463+
1464+import sys, os
1465+
1466+# If extensions (or modules to document with autodoc) are in another directory,
1467+# add these directories to sys.path here. If the directory is relative to the
1468+# documentation root, use os.path.abspath to make it absolute, like shown here.
1469+#sys.path.append(os.path.abspath('.'))
1470+
1471+
1472+# -- General configuration -----------------------------------------------------
1473+
1474+# Add any Sphinx extension module names here, as strings. They can be extensions
1475+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
1476+extensions = ['sphinx.ext.ifconfig']
1477+
1478+# Add any paths that contain templates here, relative to this directory.
1479+templates_path = ['_templates']
1480+
1481+# The suffix of source filenames.
1482+source_suffix = '.txt'
1483+
1484+# The encoding of source files.
1485+#source_encoding = 'utf-8'
1486+
1487+# The master toctree document.
1488+master_doc = 'index'
1489+
1490+# General information about the project.
1491+project = u'Bazaar'
1492+copyright = u'2009, Canonical Ltd'
1493+
1494+# The version info for the project you're documenting, acts as replacement for
1495+# |version| and |release|, also used in various other places throughout the
1496+# built documents.
1497+#
1498+# The short X.Y version.
1499+import bzrlib
1500+version = '.'.join(str(p) for p in bzrlib.version_info[:2])
1501+# The full version, including alpha/beta/rc tags.
1502+release = bzrlib.version_string
1503+
1504+# The language for content autogenerated by Sphinx. Refer to documentation
1505+# for a list of supported languages.
1506+#language = None
1507+
1508+# There are two options for replacing |today|: either, you set today to some
1509+# non-false value, then it is used:
1510+#today = ''
1511+# Else, today_fmt is used as the format for a strftime call.
1512+#today_fmt = '%B %d, %Y'
1513+
1514+# List of documents that shouldn't be included in the build.
1515+#unused_docs = []
1516+
1517+# List of directories, relative to source directory, that shouldn't be searched
1518+# for source files.
1519+exclude_trees = ['_build']
1520+
1521+# The reST default role (used for this markup: `text`) to use for all documents.
1522+#default_role = None
1523+
1524+# If true, '()' will be appended to :func: etc. cross-reference text.
1525+#add_function_parentheses = True
1526+
1527+# If true, the current module name will be prepended to all description
1528+# unit titles (such as .. function::).
1529+#add_module_names = True
1530+
1531+# If true, sectionauthor and moduleauthor directives will be shown in the
1532+# output. They are ignored by default.
1533+#show_authors = False
1534+
1535+# The name of the Pygments (syntax highlighting) style to use.
1536+pygments_style = 'sphinx'
1537+
1538+# A list of ignored prefixes for module index sorting.
1539+#modindex_common_prefix = []
1540+
1541+
1542+# -- Options for HTML output ---------------------------------------------------
1543+
1544+# The theme to use for HTML and HTML Help pages. Major themes that come with
1545+# Sphinx are currently 'default' and 'sphinxdoc'.
1546+html_theme = 'default'
1547+
1548+# Theme options are theme-specific and customize the look and feel of a theme
1549+# further. For a list of options available for each theme, see the
1550+# documentation.
1551+html_theme_options = {
1552+ # Unfortunately, the right sidebar breaks under IE6 and maybe IE7.
1553+ # So we stick with the default left placement to cater for users stuck
1554+ # on those browsers.
1555+ #'rightsidebar': True,
1556+
1557+ # Non-document areas: header (relbar), footer, sidebar, etc.
1558+ # Some useful colours here:
1559+ # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
1560+ # midnightblue
1561+ # * gray: dimgray, slategray, lightslategray
1562+ 'sidebarbgcolor': "cornflowerblue",
1563+ 'sidebarlinkcolor': "midnightblue",
1564+ 'relbarbgcolor': "darkblue",
1565+ 'footerbgcolor': "lightslategray",
1566+
1567+ # Text, heading and code colouring
1568+ 'codebgcolor': "lightyellow",
1569+ 'codetextcolor': "firebrick",
1570+ 'linkcolor': "mediumblue",
1571+ }
1572+
1573+# Add any paths that contain custom themes here, relative to this directory.
1574+#html_theme_path = []
1575+
1576+# The name for this set of Sphinx documents. If None, it defaults to
1577+# "<project> v<release> documentation".
1578+#html_title = None
1579+
1580+# A shorter title for the navigation bar. Default is the same as html_title.
1581+#html_short_title = None
1582+
1583+# The name of an image file (relative to this directory) to place at the top
1584+# of the sidebar.
1585+#html_logo = None
1586+
1587+# The name of an image file (within the static path) to use as favicon of the
1588+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
1589+# pixels large.
1590+html_favicon = "bzr.ico"
1591+
1592+# Add any paths that contain custom static files (such as style sheets) here,
1593+# relative to this directory. They are copied after the builtin static files,
1594+# so a file named "default.css" will overwrite the builtin "default.css".
1595+html_static_path = ['_static']
1596+
1597+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
1598+# using the given strftime format.
1599+#html_last_updated_fmt = '%b %d, %Y'
1600+
1601+# If true, SmartyPants will be used to convert quotes and dashes to
1602+# typographically correct entities.
1603+#html_use_smartypants = True
1604+
1605+# Custom sidebar templates, maps document names to template names.
1606+#html_sidebars = {}
1607+
1608+# Additional templates that should be rendered to pages, maps page names to
1609+# template names.
1610+#html_additional_pages = {}
1611+
1612+# If false, no module index is generated.
1613+html_use_modindex = False
1614+
1615+# If false, no index is generated.
1616+html_use_index = False
1617+
1618+# If true, the index is split into individual pages for each letter.
1619+#html_split_index = False
1620+
1621+# If true, links to the reST sources are added to the pages.
1622+html_show_sourcelink = True
1623+
1624+# If true, an OpenSearch description file will be output, and all pages will
1625+# contain a <link> tag referring to it. The value of this option must be the
1626+# base URL from which the finished HTML is served.
1627+#html_use_opensearch = ''
1628+
1629+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
1630+#html_file_suffix = ''
1631+
1632+# Output file base name for HTML help builder.
1633+htmlhelp_basename = 'bzr-docs'
1634+
1635+
1636+# -- Options for LaTeX output --------------------------------------------------
1637+
1638+# The paper size ('letter' or 'a4').
1639+#latex_paper_size = 'letter'
1640+
1641+# The font size ('10pt', '11pt' or '12pt').
1642+#latex_font_size = '10pt'
1643+
1644+# Grouping the document tree into LaTeX files. List of tuples
1645+# (source start file, target name, title, author, documentclass [howto/manual]).
1646+latex_documents = []
1647+
1648+# The name of an image file (relative to this directory) to place at the top of
1649+# the title page.
1650+latex_logo = '../Bazaar-Logo-For-Manuals.png'
1651+
1652+# For "manual" documents, if this is true, then toplevel headings are parts,
1653+# not chapters.
1654+#latex_use_parts = False
1655+
1656+# Additional stuff for the LaTeX preamble.
1657+#latex_preamble = ''
1658+
1659+# Documents to append as an appendix to all manuals.
1660+#latex_appendices = []
1661+
1662+# If false, no module index is generated.
1663+#latex_use_modindex = True
1664+
1665+
1666+# -- Bazaar-specific configuration ---------------------------------------------
1667+
1668+# Authors of the documents
1669+bzr_team = u'Bazaar Developers'
1670
1671=== removed file 'doc/BUILD-NOTES'
1672--- doc/BUILD-NOTES 2009-07-26 15:58:33 +0000
1673+++ doc/BUILD-NOTES 1970-01-01 00:00:00 +0000
1674@@ -1,35 +0,0 @@
1675-To build Bazaar's documentation using Sphinx, follow the
1676-steps below.
1677-
1678-0. Install Sphinx. You'll need Sphinx 0.6 or later. If that
1679- version isn't available in your package manager repositories
1680- yet, install python-easyinstall and use it to install Sphinx.
1681- See http://sphinx.pocoo.org/ for details.
1682-
1683-1. Build the Bazaar docs normally, i.e. in the project root, run:
1684-
1685- make docs
1686-
1687-2. Tweak the User Guide index page used:
1688-
1689- cd doc/en/user-guide
1690- bzr mv index.txt index-for-1x.txt
1691- bzr mv index-for-2x.txt index.txt
1692-
1693-3. Tweak the Release Notes TOC depth:
1694-
1695- cd ../release-notes
1696- vi NEWS.txt (change depth to 2)
1697-
1698-4. Change to the docs directory and build the site:
1699-
1700- cd ../..
1701- make html
1702-
1703-The generated output site can be found in _build/html.
1704-
1705-Note: All of the above will Just Work soon. For now, we don't
1706-want to break the existing doc generation until a few issues
1707-with the Sphinx-generated site are ironed out, e.g. links from
1708-the User Reference to ../user-guide/index.html#foo no longer
1709-work when the User Guide is nicely split into topic pages.
1710
1711=== added file 'doc/Bazaar-Logo-For-Manuals.png'
1712Binary 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
1713=== removed directory 'doc/_static/en/quick-reference'
1714=== removed file 'doc/bazaar-vcs.org.kid'
1715--- doc/bazaar-vcs.org.kid 2007-08-14 03:59:22 +0000
1716+++ doc/bazaar-vcs.org.kid 1970-01-01 00:00:00 +0000
1717@@ -1,482 +0,0 @@
1718-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1719- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1720-<?python
1721- def update_attrib(attrib, **kwargs):
1722- attrib = dict(attrib)
1723- attrib.update(kwargs)
1724- return attrib
1725-?>
1726-<html xmlns="http://www.w3.org/1999/xhtml" xmlns:py="http://purl.org/kid/ns#">
1727-<head>
1728-<script type="text/javascript" src=
1729-"/htdocs/bazaarNew/js/opacity.js">
1730-</script>
1731-<link rel="shortcut icon" href=
1732-"http://bazaar-vcs.org/Welcome?action=AttachFile&amp;do=get&amp;target=favicon.ico"
1733-type="image/x-icon" />
1734-<meta http-equiv="Content-Type" content=
1735-"text/html; charset=us-ascii" />
1736-<meta name="robots" content="index,follow" />
1737-<title>Welcome - Bazaar Version Control</title>
1738-
1739-<script type="text/javascript" src="http://bazaar-vcs.org/htdocs/common/js/common.js">
1740-</script>
1741-<script type="text/javascript">
1742-//<![CDATA[
1743-<!--// common functions
1744-
1745-// We keep here the state of the search box
1746-searchIsDisabled = false;
1747-
1748-function searchChange(e) {
1749- // Update search buttons status according to search box content.
1750- // Ignore empty or whitespace search term.
1751- var value = e.value.replace(/\s+/, '');
1752- if (value == '' || searchIsDisabled) {
1753- searchSetDisabled(true);
1754- } else {
1755- searchSetDisabled(false);
1756- }
1757-}
1758-
1759-function searchSetDisabled(flag) {
1760- // Enable or disable search
1761- document.getElementById('fullsearch').disabled = flag;
1762- document.getElementById('titlesearch').disabled = flag;
1763-}
1764-
1765-function searchFocus(e) {
1766- // Update search input content on focus
1767- if (e.value == 'Search') {
1768- e.value = '';
1769- e.className = '';
1770- searchIsDisabled = false;
1771- }
1772-}
1773-
1774-function searchBlur(e) {
1775- // Update search input content on blur
1776- if (e.value == '') {
1777- e.value = 'Search';
1778- e.className = 'disabled';
1779- searchIsDisabled = true;
1780- }
1781-}
1782-
1783-function actionsMenuInit(title) {
1784- // Initialize action menu
1785- for (i = 0; i < document.forms.length; i++) {
1786- var form = document.forms[i];
1787- if (form.className == 'actionsmenu') {
1788- // Check if this form needs update
1789- var div = form.getElementsByTagName('div')[0];
1790- var label = div.getElementsByTagName('label')[0];
1791- if (label) {
1792- // This is the first time: remove label and do buton.
1793- div.removeChild(label);
1794- var dobutton = div.getElementsByTagName('input')[0];
1795- div.removeChild(dobutton);
1796- // and add menu title
1797- var select = div.getElementsByTagName('select')[0];
1798- var item = document.createElement('option');
1799- item.appendChild(document.createTextNode(title));
1800- item.value = 'show';
1801- select.insertBefore(item, select.options[0]);
1802- select.selectedIndex = 0;
1803- }
1804- }
1805- }
1806-}
1807-//-->
1808-//]]>
1809-</script>
1810-<link rel="stylesheet" type="text/css" charset="utf-8" media="all"
1811-href="http://bazaar-vcs.org/htdocs/bazaarNew/css/common.css" />
1812-<link rel="stylesheet" type="text/css" charset="utf-8" media=
1813-"screen" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/screen.css" />
1814-<link rel="stylesheet" type="text/css" charset="utf-8" media=
1815-"print" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/print.css" />
1816-<link rel="stylesheet" type="text/css" charset="utf-8" media=
1817-"projection" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/projection.css" />
1818-<link rel="stylesheet" type="text/css" charset="utf-8" media=
1819-"screen" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/v4.css" />
1820-<link rel="stylesheet" type="text/css" charset="utf-8" media=
1821-"screen" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/screen2.css" />
1822-<link rel="stylesheet" type="text/css" charset="utf-8" media=
1823-"screen" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/twoColumnsRight.css" />
1824-<style type="text/css">
1825-a.toc-backref
1826-{
1827- color: black;
1828- text-decoration: none;
1829-}
1830-</style>
1831-<link rel="alternate" title="Bazaar Version Control Recent Changes"
1832-href="http://bazaar-vcs.org/RecentChanges?action=rss_rc&amp;ddiffs=1&amp;unique=1" type=
1833-"application/rss+xml" />
1834-<link rel="Start" href="http://bazaar-vcs.org/Welcome" />
1835-<link rel="Alternate" title="Wiki Markup" href=
1836-"http://bazaar-vcs.org/Welcome?action=raw" />
1837-<link rel="Alternate" media="print" title="Print View" href=
1838-"http://bazaar-vcs.org/Welcome?action=print" />
1839-<link rel="Appendix" title="favicon.ico" href=
1840-"http://bazaar-vcs.org/Welcome?action=AttachFile&amp;do=view&amp;target=favicon.ico" />
1841-<link rel="Search" href="http://bazaar-vcs.org/FindPage" />
1842-<link rel="Index" href="http://bazaar-vcs.org/TitleIndex" />
1843-<link rel="Glossary" href="http://bazaar-vcs.org/WordIndex" />
1844-<link rel="Help" href="http://bazaar-vcs.org/HelpOnFormatting" />
1845-</head>
1846-<body lang="en" dir="ltr" xml:lang="en">
1847-<div id="page_header1_div"><script type="text/javascript">
1848-//<![CDATA[
1849-gui_editor_link_text = gui_editor_link_href = null;
1850-//]]>
1851-</script></div>
1852-<div id="pageWrapper">
1853-<hr class="hide" />
1854-<div id="masthead" class="inside">
1855-<div id="logoimage"><a href="http://bazaar-vcs.org/"><img src=
1856-"http://bazaar-vcs.org/htdocs/bazaarNew/css/logo.png" width="144" height="149" alt=
1857-"Bazaar" /></a></div>
1858-<h1><a href="http://bazaar-vcs.org/">Bazaar</a></h1>
1859-<p>GPL Distributed Version Control Software</p>
1860-</div>
1861-<hr class="hide" />
1862-<div class="hnav">
1863-<ul>
1864-<li class="hide"><a class="hide" href="#skipToContent"><em>Skip
1865-Navigation</em></a> <span class="divider">:</span></li>
1866-<li><a href="http://bazaar-vcs.org/Documentation" id="hnav_learn" name=
1867-"hnav_learn">Learn</a> <span class="divider">:</span></li>
1868-<li><a href="http://bazaar-vcs.org/Download" id="hnav_get" name="hnav_get">Get</a>
1869-<span class="divider">:</span></li>
1870-<li><a href="http://bazaar-vcs.org/BzrSupport" id="hnav_community" name=
1871-"hnav_community">Community</a> <span class="divider">:</span></li>
1872-<li><a href="http://bazaar-vcs.org/BzrPlugins" id="hnav_plugins" name=
1873-"hnav_plugins">Plugins</a></li>
1874-</ul>
1875-</div>
1876-<div id="outerColumnContainer">
1877-<div id="innerColumnContainer">
1878-<hr class="hide" />
1879-<div id="leftColumn">
1880-<div class="inside"></div>
1881-</div>
1882-<hr class="hide" />
1883-<div id="rightColumn">
1884-<div class="inside">
1885-<div id="searchbox">
1886-<form name="search" method="get" action="http://bazaar-vcs.org/" id="search">
1887-<div><input type="hidden" name="action" value="fullsearch" id=
1888-"fullsearch" /> <input type="hidden" name="context" value="180" />
1889-<input type="hidden" name="fullsearch" value="Text" /> <label for=
1890-"search_q" py:content="'Search Wiki'">Search Bazaar</label> <input type="text" name="value"
1891-id="search_q" value="" onfocus="searchFocus(this)" onblur=
1892-"searchBlur(this)" onkeyup="searchChange(this)" onchange=
1893-"searchChange(this)" alt="Search" /> <input type="submit" value=
1894-"go" name="go" id="search_go" /></div>
1895-</form>
1896-</div>
1897-<div id="searchform"></div>
1898-<div id="username" class="vnav">
1899-<h4>Website Links</h4>
1900-<ul>
1901-<li><a href="http://doc.bazaar-vcs.org">Documentation</a></li>
1902-<li><a href="http://bazaar-vcs.org">Wiki</a></li>
1903-</ul>
1904-</div>
1905-</div>
1906-</div>
1907-<div id="contentColumn" class="page_Welcome">
1908-<hr class="hide" />
1909-<div id="msg" class="vnav"></div>
1910-<a name="skipToContent" id="skipToContent"></a>
1911-<div class="inside" >
1912-<!--<img id="navProtection" width="1" height="1" border="0" src="/htdocs/bazaarNew/css/spacer.gif" alt="" style="height: 1px"/>-->
1913-<a py:match="item.tag == 'a' and 'href' not in item.attrib" py:content="item.text" py:attrs="update_attrib(item.attrib, style='color: black')"/>
1914-<div dir="ltr" id="content" lang="en" xml:lang="en" py:content="body[:]"><span
1915-class="anchor" id="top"></span> <span class="anchor" id="line-8"></span>
1916-<h1 id="head-31592baed255c2a5cdfdaafb9521b837ea61021f">Performance
1917-Drive Under Way</h1>
1918-<span class="anchor" id="line-9"></span>
1919-<p class="line879">There was substantial progress on performance
1920-since 0.8. See <a href="/Performance/0.9">Performance/0.9</a>,
1921-<a href="/Performance/0.10">Performance/0.10</a> and <a href=
1922-"/Performance/0.11">Performance/0.11</a>. Thanks to everyone who
1923-has contributed patches and ideas! The focus from here to 1.0 will
1924-continue to be performance and documentation. Already there is work
1925-in progress to: <span class="anchor" id="line-10"></span></p>
1926-<span class="anchor" id="line-11"></span>
1927-<ul>
1928-<li>
1929-<p class="line879">write a <a href="/SmartServer">SmartServer</a>
1930-for high speed network operations (first look in 0.11).
1931-<span class="anchor" id="line-12"></span></p>
1932-</li>
1933-<li>
1934-<p class="line886">optimise file system access (tune our code and
1935-data structures to minimise probable disk io and disk seeking)
1936-<span class="anchor" id="line-13"></span></p>
1937-</li>
1938-<li>
1939-<p class="line886">optimise file formats for performance without
1940-sacrificing proven correctness and completeness <span class=
1941-"anchor" id="line-14"></span></p>
1942-</li>
1943-<li>
1944-<p class="line886">tune the codepaths that are most heavily used
1945-<span class="anchor" id="line-15"></span></p>
1946-</li>
1947-<li>
1948-<p class="line886">ensure that large imports are only done when
1949-needed, and use lightweight imports where possible <span class=
1950-"anchor" id="line-16"></span></p>
1951-<span class="anchor" id="line-17"></span></li>
1952-</ul>
1953-<h1 id="head-ceb9b8e0146b0ce087048f495b2ff2964c5d57ec">News</h1>
1954-<span class="anchor" id="line-18"></span>
1955-<h2 id="head-39a1524e97c9a6ba89ecee7856cb1a2e68134373">27th
1956-September 2006 - 0.11rc2 released</h2>
1957-<span class="anchor" id="line-19"></span>
1958-<p class="line879">bzr 0.11rc2 has been released. This release
1959-candidate corrects two regressions that occured from 0.10. Windows
1960-developers and users with very large source trees should upgrade
1961-immediately. Release <a class="https" href=
1962-"https://lists.canonical.com/archives/bazaar-ng/2006q3/017581.html">
1963-announcement</a> or <a class="http" href=
1964-"http://bazaar-vcs.org/releases/src/bzr-0.11rc2.tar.gz">download
1965-now</a>. For details of the original 0.11 release candidate, see
1966-the <a class="https" href=
1967-"https://lists.canonical.com/archives/bazaar-ng/2006q3/017502.html">
1968-announcement</a>. <span class="anchor" id="line-20"></span></p>
1969-<span class="anchor" id="line-21"></span>
1970-<h2 id="head-9940b3014f81c7b8ca65aa3235341588859d09dd">4th
1971-September 2006 - 0.10 released</h2>
1972-<span class="anchor" id="line-22"></span>
1973-<p class="line879">bzr 0.10 has been released after a smooth beta
1974-period. <a class="http" href=
1975-"http://bazaar-vcs.org/releases/src/bzr-0.10.tar.gz">download it
1976-now</a>! <span class="anchor" id="line-23"></span></p>
1977-<span class="anchor" id="line-24"></span>
1978-<h1 id="head-c2a87bc7d0bc411d33e18585154e534201115501">What is
1979-Bazaar?</h1>
1980-<span class="anchor" id="line-25"></span>
1981-<p class="line879">Bazaar is a decentralized revision control
1982-system designed to be easy for developers and end users alike.
1983-Decentralized revision control systems give people the ability to
1984-work over the internet using the <a class="http" href=
1985-"http://en.wikipedia.org/wiki/The_Cathedral_and_the_Bazaar">bazaar
1986-development model</a>. When you use Bazaar, you can commit to your
1987-own branches of your favorite free software projects without
1988-needing special permission. For more information, see: <span class=
1989-"anchor" id="line-26"></span></p>
1990-<span class="anchor" id="line-27"></span>
1991-<ul>
1992-<li>
1993-<p class="line903"><a href="/Bzr">What Is Bazaar?</a> <span class=
1994-"anchor" id="line-28"></span></p>
1995-</li>
1996-<li>
1997-<p class="line903"><a href="/WhoUsesBzr">Who Uses Bazaar?</a>
1998-<span class="anchor" id="line-29"></span></p>
1999-</li>
2000-<li>
2001-<p class="line903"><a href="/BzrFeatures">Bazaar Features</a>
2002-<span class="anchor" id="line-30"></span></p>
2003-</li>
2004-<li>
2005-<p class="line903"><a href="/FAQ">FAQ</a> (Frequently Asked
2006-Questions) <span class="anchor" id="line-31"></span></p>
2007-</li>
2008-<li>
2009-<p class="line903"><a href="/BzrGlossary">Bazaar Glossary</a>
2010-<span class="anchor" id="line-32"></span></p>
2011-</li>
2012-<li>
2013-<p class="line903"><a href="/ReleaseRoadmap">What's Coming</a> (the
2014-release roadmap) <span class="anchor" id="line-33"></span></p>
2015-<span class="anchor" id="line-34"></span></li>
2016-</ul>
2017-<h1 id="head-54a84f21f8314a452aecfb4e2da59fcb246fee7b">Where do I
2018-get it?</h1>
2019-<span class="anchor" id="line-35"></span>
2020-<p class="line886">The easiest place to get Bazaar is with your
2021-distribution. Do not despair if your distribution does not have
2022-Bazaar, as plain installation is still easy. <span class="anchor"
2023-id="line-36"></span></p>
2024-<span class="anchor" id="line-37"></span>
2025-<ul>
2026-<li>
2027-<p class="line903"><a href="/DistroDownloads">Packages</a> -
2028-Downloads for various distributions <span class="anchor" id=
2029-"line-38"></span></p>
2030-</li>
2031-<li>
2032-<p class="line903"><a href="/OfficialDownloads">Source</a> - Source
2033-downloads <span class="anchor" id="line-39"></span></p>
2034-</li>
2035-<li>
2036-<p class="line903"><a href="/WindowsDownloads">Windows</a> -
2037-Downloads for windows <span class="anchor" id="line-40"></span></p>
2038-<span class="anchor" id="line-41"></span></li>
2039-</ul>
2040-<h1 id="head-400b61668c5f3ab729ffbfeed0f9fc93e853044e">How do I
2041-install it?</h1>
2042-<span class="anchor" id="line-42"></span>
2043-<p class="line879">Installation for Bazaar is a snap. Supported
2044-operating systems include Linux, FreeBSD, Windows (Native &amp;
2045-Cygwin) and Solaris. If you can run Python 2.4, then you can run
2046-Bazaar. <span class="anchor" id="line-43"></span></p>
2047-<span class="anchor" id="line-44"></span>
2048-<ul>
2049-<li>
2050-<p class="line903"><a href="/DistroDownloads">Packages</a> -
2051-Downloads for various distributions <span class="anchor" id=
2052-"line-45"></span></p>
2053-</li>
2054-<li>
2055-<p class="line903"><a href="/Installation">Generic</a> - Generic
2056-Installation Instructions. <span class="anchor" id=
2057-"line-46"></span></p>
2058-</li>
2059-<li>
2060-<p class="line903"><a href="/BzrOnPureWindows">Native Windows</a> -
2061-Installation of Bazaar on Native windows. <span class="anchor" id=
2062-"line-47"></span></p>
2063-<span class="anchor" id="line-48"></span></li>
2064-</ul>
2065-<h1 id="head-6350ee8bfd03b56b430e775595af1eb29ac7bdb4">How do I use
2066-it?</h1>
2067-<span class="anchor" id="line-49"></span>
2068-<p class="line886">Included are the pearls of wisdom from people
2069-that have already branched off into a new world of development.
2070-<span class="anchor" id="line-50"></span></p>
2071-<span class="anchor" id="line-51"></span>
2072-<ul>
2073-<li>
2074-<p class="line903"><a href="/Documentation">Documents</a> - The
2075-main documentation page for Bazaar. <span class="anchor" id=
2076-"line-52"></span></p>
2077-</li>
2078-<li>
2079-<p class="line903"><a href="/IntroductionToBzr">Introduction</a> -
2080-Introduction to Bazaar gives a walkthough of the simpler commands.
2081-<span class="anchor" id="line-53"></span></p>
2082-</li>
2083-<li>
2084-<p class="line903"><a href="/QuickHackingWithBzr">Mini Tutorial</a>
2085-- The five minutes Bazaar Tutorial. <span class="anchor" id=
2086-"line-54"></span></p>
2087-</li>
2088-<li>
2089-<p class="line903"><a href="/BzrRevisionSpec">Revision Specs</a> -
2090-Arguments for -r that can be given with "bzr log", "bzr merge" and
2091-such. <span class="anchor" id="line-55"></span></p>
2092-<span class="anchor" id="line-56"></span></li>
2093-</ul>
2094-<h1 id="head-148c5debbd034308b67411c490e69555ee5a03a3">How does it
2095-compare?</h1>
2096-<span class="anchor" id="line-57"></span>
2097-<p class="line886">If you're familiar with other version control
2098-systems, you might like to see a quick comparison to them, or read
2099-guidelines to help you understand how to use bzr most effectively
2100-given your current experience. <span class="anchor" id=
2101-"line-58"></span></p>
2102-<span class="anchor" id="line-59"></span>
2103-<ul>
2104-<li>
2105-<p class="line903"><a href="/BzrForCVSUsers">BzrForCVSUsers</a> -
2106-Learning Bazaar for CVS users. <span class="anchor" id=
2107-"line-60"></span></p>
2108-</li>
2109-<li>
2110-<p class="line903"><a href="/BzrForGITUsers">BzrForGITUsers</a> -
2111-(In progress) Learning Bazaar for GIT users <span class="anchor"
2112-id="line-61"></span></p>
2113-</li>
2114-<li>
2115-<p class="line903"><a href="/RcsComparisons">RcsComparisons</a> -
2116-Comparison table of functionality and performance with Bazaar, GIT,
2117-Mercurial, SVN and other VCS systems. <span class="anchor" id=
2118-"line-62"></span></p>
2119-<span class="anchor" id="line-63"></span></li>
2120-</ul>
2121-<h1 id="head-e966f9f6520262482dc713218b2a916600636f14">How can I
2122-get Help?</h1>
2123-<span class="anchor" id="line-64"></span>
2124-<p class="line879">Our primary page for getting help is the
2125-<a href="/BzrSupport">BzrSupport</a> page. <span class="anchor" id=
2126-"line-65"></span></p>
2127-<span class="anchor" id="line-66"></span>
2128-<ul>
2129-<li>
2130-<p class="line903"><a class="https" href=
2131-"https://launchpad.net/products/bzr/+bugs">Bug Tracker</a> - You
2132-can check here to see if someone else is experiencing the same
2133-problem that you are. <span class="anchor" id="line-67"></span></p>
2134-</li>
2135-<li>
2136-<p class="line903"><a class="http" href=
2137-"http://lists.canonical.com/mailman/listinfo/bazaar-ng">Mailing
2138-List</a> - A high volume list focused upon Bazaar development and
2139-support. <span class="anchor" id="line-68"></span></p>
2140-</li>
2141-<li>
2142-<p class="line886">IRC - #bzr on irc.freenode.net <span class=
2143-"anchor" id="line-69"></span></p>
2144-<span class="anchor" id="line-70"></span></li>
2145-</ul>
2146-<h1 id="head-45d36005ff61e184525081c9c40ed26ded3c8f02">How can I
2147-contribute?</h1>
2148-<span class="anchor" id="line-71"></span>
2149-<p class="line879">Our primary development doc page is <a href=
2150-"/BzrDevelopment">BzrDevelopment</a>. <span class="anchor" id=
2151-"line-72"></span></p>
2152-<span class="anchor" id="line-73"></span>
2153-<ul>
2154-<li>
2155-<p class="line903"><a href="/BzrDevelopment">Development
2156-Instructions</a> - We keep our main development instructions here.
2157-<span class="anchor" id="line-74"></span></p>
2158-</li>
2159-<li>
2160-<p class="line903"><a href="/OfficialDownloads">Source Code</a> -
2161-Source code to get hacking with. <span class="anchor" id=
2162-"line-75"></span></p>
2163-</li>
2164-<li>
2165-<p class="line903"><a class="https" href=
2166-"https://launchpad.net/products/bzr/+specs">Specifications</a> -
2167-Specifications list which things are being worked on today and are
2168-likely to be worked on next. <span class="anchor" id=
2169-"line-76"></span></p>
2170-</li>
2171-<li>
2172-<p class="line903"><a class="https" href=
2173-"https://launchpad.net/products/bzr/+bugs">BugTracker</a> - Open
2174-bugs that you can work on. <span class="anchor" id=
2175-"line-77"></span></p>
2176-<span class="anchor" id="line-78"></span></li>
2177-</ul>
2178-<p class="line879">You are also welcome to improve this wiki site.
2179-To edit pages, please <a href="/UserPreferences">register</a>.
2180-Anonymous editing is disabled to prevent spammer attacks.
2181-<span class="anchor" id="line-79"></span></p>
2182-<span class="anchor" id="bottom"></span></div>
2183-</div>
2184-<div class="clear mozclear"></div>
2185-</div>
2186-</div>
2187-<div class="hide" id="nsFooterClear"><!-- for NS4's sake --></div>
2188-<hr class="hide" />
2189-<div id="footer" class="inside">
2190-<p style="margin:0;">&copy; 2006 - <a href=
2191-"http://canonical.com/">Canonical Ltd.</a></p>
2192-<div id="endofpage"></div>
2193-<div id="footer_custom_html"></div>
2194-<div id="footer_links"></div>
2195-</div>
2196-<hr class="hide" /></div>
2197-</div>
2198-</body>
2199-</html>
2200
2201=== removed file 'doc/default.css'
2202--- doc/default.css 2008-02-07 07:05:13 +0000
2203+++ doc/default.css 1970-01-01 00:00:00 +0000
2204@@ -1,164 +0,0 @@
2205-/* from John Arbash Meinel's `Short tutorial' */
2206-
2207-body {
2208- background-color: #ffffff;
2209- color: #303030;
2210- margin-top: 50px;
2211- margin-left: 50px;
2212- margin-right: 50px;
2213- margin-bottom: 70px;
2214- font-family: Verdana, Geneva, Arial, sans-serif;
2215- font-size: small;
2216- line-height: 140%
2217- }
2218-
2219-/* p {
2220- text-indent: 3em
2221-} */
2222-
2223-h1, h2, h3 {
2224- font-family: Georgia, "Times New Roman", Times, serif;
2225-}
2226-
2227-h1.title {
2228- text-align: center;
2229- color: #000000;
2230- font-size: 1.8em;
2231- }
2232-
2233-
2234-div.contents p {
2235- font-weight: bold;
2236- }
2237-
2238-div.contents p a:hover {
2239- color: inherit;
2240- }
2241-
2242-/* Format ".. note:" sections nicely */
2243-div.note {
2244- margin-left: 5em;
2245- margin-right: 5em;
2246- color: #000000;
2247- background-color: #c1d1ff;
2248- border: 1px solid #888888;
2249- padding-left: 1em;
2250- padding-right: 1em;
2251- }
2252-
2253-div.note .first {
2254- font-weight: bold;
2255- }
2256-
2257-h1 {
2258- color: #b52b2b;
2259- /* DKREDcolor: #966b72; */
2260- /* GREY color: #444444; */
2261- font-size: 1.5em;
2262- }
2263-
2264-h1 a:link {
2265- color: inherit;
2266- }
2267-
2268-h1 a:hover {
2269- color: inherit;
2270- }
2271-
2272-h1 a:visited {
2273- color: inherit;
2274- }
2275-
2276-h2 {
2277- color: #222;
2278- /* RED color: #966b72; */
2279- text-decoration: underline;
2280- font-size: 1.4em;
2281- }
2282-
2283-h2 a:link {
2284- color: inherit;
2285- }
2286-
2287-h2 a:hover {
2288- color: inherit;
2289- }
2290-
2291-h2 a:visited {
2292- color: inherit;
2293- }
2294-
2295-h3 {
2296- color: #966b72;
2297- /* color: #966b72; */
2298- }
2299-
2300-h3 a:link {
2301- color: inherit;
2302- }
2303-
2304-h3 a:hover {
2305- color: inherit;
2306- }
2307-
2308-h3 a:visited {
2309- color: inherit;
2310- }
2311-
2312-dt {
2313- color: #000000;
2314- font-weight: bold;
2315- }
2316-/*
2317- border: 4px solid blue;
2318- padding: 1ex;
2319- background: #7777FF;
2320- }
2321-dt:hover
2322- {
2323- background-color: black;
2324- }
2325-dt:active
2326- {
2327- background-color: red;
2328- }
2329-*/
2330-
2331-tt, .literal-block {
2332- font-family: monospace;
2333- line-height: 100%
2334- }
2335-
2336-tt {
2337- color: #000000;
2338- font-weight: normal;
2339- }
2340-
2341-.literal-block {
2342- margin-left: 5em;
2343- margin-right: 5em;
2344- color: #000000;
2345- font-weight: normal;
2346- background-color: #e5ecf9;
2347- border: 1px solid #888888;
2348- padding: 1em;
2349- }
2350-
2351-a:link {
2352- color: #4c52ff;
2353- text-decoration: none;
2354- }
2355-
2356-a:visited {
2357- color: #4c53ff;
2358- text-decoration: none;
2359- }
2360-
2361-a:hover {
2362- color: #b52727;
2363- text-decoration: none;
2364- }
2365-
2366-span, th.field-name {
2367- white-space: nowrap;
2368-}
2369
2370=== renamed file 'doc/en/developer-guide/HACKING.txt' => 'doc/developers/HACKING.txt'
2371--- doc/en/developer-guide/HACKING.txt 2009-08-13 17:16:31 +0000
2372+++ doc/developers/HACKING.txt 2009-09-08 01:11:40 +0000
2373@@ -11,14 +11,8 @@
2374 the Bazaar mailing list. To propose a correction or addition to this
2375 document, send a merge request or new text to the mailing list.
2376
2377-The current version of this document is available in the file
2378-``doc/en/developer-guide/HACKING.txt`` in the source tree, or at
2379-http://doc.bazaar-vcs.org/bzr.dev/en/developer-guide/HACKING.html
2380-
2381-See also:
2382-`Bazaar Developer Documentation Catalog <../../developers/index.html>`_.
2383-
2384-.. contents::
2385+The latest developer documentation can be found online at
2386+http://doc.bazaar-vcs.org/developers/.
2387
2388
2389 Getting Started
2390@@ -266,7 +260,7 @@
2391 Automatically-generated API reference information is available at
2392 <http://starship.python.net/crew/mwh/bzrlibapi/>.
2393
2394-See also the `Bazaar Architectural Overview <../../developers/overview.html>`_.
2395+See also the :doc:`Bazaar Architectural Overview <overview>`.
2396
2397
2398 The Code Review Process
2399@@ -841,8 +835,8 @@
2400 Test coverage
2401 =============
2402
2403-All code should be exercised by the test suite. See `Guide to Testing
2404-Bazaar <../../developers/testing.html>`_ for detailed information about writing tests.
2405+All code should be exercised by the test suite. See :doc:`Guide to Testing
2406+Bazaar <testing>` for detailed information about writing tests.
2407
2408
2409 Core Topics
2410@@ -1403,7 +1397,7 @@
2411 * reviewing changes
2412 * reviewing blueprints
2413 * planning releases
2414-* managing releases (see the `Releasing Bazaar <../../developers/releasing.html>`_)
2415+* managing releases (see :doc:`Releasing Bazaar <releasing>`)
2416
2417 .. note::
2418 Removing barriers to community participation is a key reason for adopting
2419
2420=== added directory 'doc/developers/_static'
2421=== added file 'doc/developers/_static/bzr icon 16.png'
2422Binary 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
2423=== added file 'doc/developers/_static/bzr.ico'
2424Binary 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
2425=== added directory 'doc/developers/_templates'
2426=== added file 'doc/developers/_templates/layout.html'
2427--- doc/developers/_templates/layout.html 1970-01-01 00:00:00 +0000
2428+++ doc/developers/_templates/layout.html 2009-09-07 07:44:36 +0000
2429@@ -0,0 +1,8 @@
2430+{% extends "!layout.html" %}
2431+
2432+{% block rootrellink %}
2433+<li><a href="http://bazaar-vcs.org/">
2434+ <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Home</a>&nbsp;|&nbsp;</li>
2435+<a href="http://doc.bazaar-vcs.org/en/">Documentation</a>&nbsp;|&nbsp;</li>
2436+{{ super() }}
2437+{% endblock %}
2438
2439=== added file 'doc/developers/conf.py'
2440--- doc/developers/conf.py 1970-01-01 00:00:00 +0000
2441+++ doc/developers/conf.py 2009-09-09 00:34:29 +0000
2442@@ -0,0 +1,45 @@
2443+# -*- coding: utf-8 -*-
2444+#
2445+# Bazaar documentation build configuration file, created by
2446+# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
2447+#
2448+# This file is execfile()d with the current directory set to its containing dir.
2449+
2450+import sys, os
2451+
2452+# If extensions (or modules to document with autodoc) are in another directory,
2453+# add these directories to sys.path here. If the directory is relative to the
2454+# documentation root, use os.path.abspath to make it absolute, like shown here.
2455+sys.path = [os.path.abspath('../..')] + sys.path
2456+
2457+# Most of the configuration for Bazaar docs is defined here ...
2458+from bzrlib.doc_generate.sphinx_conf import *
2459+
2460+
2461+## Configuration specific to this site ##
2462+
2463+# The locale code for this documentation set
2464+bzr_locale = 'en'
2465+
2466+# A shorter title for the navigation bar. Default is the same as html_title.
2467+html_short_title = u"Developer Document Catalog (%s)" % (release,)
2468+
2469+# Additional templates that should be rendered to pages, maps page names to
2470+# template names.
2471+#html_additional_pages = {'index': 'index.html'}
2472+
2473+# Output file base name for HTML help builder.
2474+htmlhelp_basename = 'bzr-developers'
2475+
2476+# Grouping the document tree into LaTeX files. List of tuples
2477+# (source start file, target name, title, author, documentclass [howto/manual]).
2478+latex_documents = [
2479+ ('HACKING', 'bzr-en-developer-guide.tex', u'Bazaar Developer Guide',
2480+ u'Bazaar Developers', 'manual'),
2481+ ('testing', 'bzr-en-testing-guide.tex', u'Bazaar Testing Guide',
2482+ u'Bazaar Developers', 'manual'),
2483+ ('overview', 'bzr-en-architecture-overview.tex', u'Bazaar Architecture Overview',
2484+ u'Bazaar Developers', 'howto'),
2485+ ('integration', 'bzr-en-integration-guide.tex', u'Bazaar Integration Guide',
2486+ u'Bazaar Developers', 'howto'),
2487+]
2488
2489=== added file 'doc/developers/implementation-notes.txt'
2490--- doc/developers/implementation-notes.txt 1970-01-01 00:00:00 +0000
2491+++ doc/developers/implementation-notes.txt 2009-09-07 07:44:36 +0000
2492@@ -0,0 +1,28 @@
2493+Implementation notes
2494+====================
2495+
2496+.. toctree::
2497+ :hidden:
2498+
2499+ btree_index_prefetch
2500+ last-modified
2501+ content-filtering
2502+ lca_tree_merging
2503+
2504+
2505+* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
2506+ to pre-read extra nodes in the btree index.
2507+
2508+* `Computing last_modified values <last-modified.html>`_ for inventory
2509+ entries
2510+
2511+* `Content filtering <content-filtering.html>`_
2512+
2513+* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
2514+ there is not a single unique ancestor (criss-cross merge).
2515+
2516+
2517+.. |--| unicode:: U+2014
2518+
2519+..
2520+ vim: ft=rst tw=74 ai
2521
2522=== modified file 'doc/developers/index.txt'
2523--- doc/developers/index.txt 2009-08-26 03:20:32 +0000
2524+++ doc/developers/index.txt 2009-09-09 02:21:47 +0000
2525@@ -2,142 +2,44 @@
2526 Bazaar Developer Document Catalog
2527 =================================
2528
2529-
2530-Overall developer documentation
2531-===============================
2532-
2533-* `Developer Guide <../en/developer-guide/HACKING.html>`_
2534-
2535-* `Architectural Overview <overview.html>`_ |--| describes some of the
2536- most important classes and concepts.
2537+Enhancing Bazaar
2538+================
2539+
2540+.. toctree::
2541+ :maxdepth: 1
2542+
2543+ process
2544+ HACKING
2545+ testing
2546+
2547+* `Bazaar Writer Guide <http://bazaar-vcs.org/ContributingToTheDocs>`_ (web link)
2548+
2549+
2550+Developing using bzrlib
2551+=======================
2552+
2553+.. toctree::
2554+ :maxdepth: 1
2555+
2556+ overview
2557+ integration
2558+
2559+* `Writing plugins for Bazaar <http://bazaar-vcs.org/WritingPlugins>`_ (web link)
2560
2561 * `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_
2562- (external link)
2563- |--| automatically generated API reference information
2564-
2565-* `Integrating with Bazaar <http://bazaar-vcs.org/Integrating_with_Bazaar>`_
2566- (wiki) |--| a guide for writing Python programs that work with Bazaar.
2567-
2568-* `Revision Properties <revision-properties.html>`_ |--| An application
2569- can set arbitrary per-revision key/value pairs to store app-specific
2570- data.
2571-
2572-* `Testing <testing.html>`_ |--| Guide to writing tests for Bazaar.
2573-
2574-* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki)
2575- |--| specific advice on writing Bazaar plugins.
2576-
2577-Process
2578-=======
2579-
2580-* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
2581- development cycle and how to run it.
2582-
2583-* `Releasing Bazaar <releasing.html>`_ |--|
2584- Checklist to make a release of Bazaar.
2585-
2586-* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
2587-
2588-* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
2589- your changes to Bazaar integrated into a release.
2590-
2591-* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
2592- bzr code and visualize the results.
2593-
2594-* `EC2 resources <ec2.html>`_ |--| A team resource for
2595- Windows packaging and testing, and Ubuntu testing.
2596-
2597-* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug
2598- tracker.
2599-
2600-Plans
2601-=====
2602-
2603-* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
2604- for fixing performance in bzr over the next few releases.
2605-
2606-* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
2607- for storing multiple branches in one file-system directory.
2608-
2609-* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
2610- Implmentation strategy for Bazaar Windows Shell Extensions, aka
2611- TortoiseBzr.
2612-
2613-* `CHK Optimized index <improved_chk_index.html>`_
2614-
2615-Specifications
2616-==============
2617-
2618-* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
2619-
2620-* `Apport error reporting <apport.html>`_ |--| Capture data to report
2621- bugs.
2622-
2623-* `Authentication ring <authentication-ring.html>`_ |--| Configuring
2624- authentication.
2625-
2626-* `Bundles <bundles.html>`_ |--| All about bzr bundles.
2627-
2628-* `Container format <container-format.html>`_ |--| Notes on a container format
2629- for streaming and storing Bazaar data.
2630-
2631-* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
2632- technology used in CHK repositories.
2633-
2634-* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
2635-
2636-* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
2637-
2638-* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
2639-
2640-* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
2641-
2642-* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
2643-
2644-* `Repositories <repository.html>`_ |--| What repositories do and are used for.
2645-
2646-* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
2647- for repositories (a layer above the container format).
2648-
2649-* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
2650- any python application.
2651-
2652-* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
2653- |--| How Bazaar operates on case-insensitive file systems such as commonly
2654- found on Windows, USB sticks, etc.
2655-
2656-* `Development repository formats <development-repo.html>`_ |--| How to
2657- work with repository formats that are still under development.
2658- Contains instructions for those implementing new formats, of course,
2659- but also for (bleeding-edge) end users of those formats.
2660-
2661-Data formats
2662-============
2663-
2664-* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories
2665- (new in Bazaar 0.92).
2666-
2667-Implementation notes
2668-====================
2669-
2670-* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
2671- to pre-read extra nodes in the btree index.
2672-
2673-* `Computing last_modified values <last-modified.html>`_ for inventory
2674- entries
2675-
2676-* `Content filtering <content-filtering.html>`_
2677-
2678-* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
2679- there is not a single unique ancestor (criss-cross merge).
2680-
2681-Miscellaneous
2682-=============
2683-
2684-* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
2685-
2686-* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
2687- performance analysis
2688+ (web link)
2689+
2690+
2691+Other documents
2692+===============
2693+
2694+.. toctree::
2695+ :maxdepth: 1
2696+
2697+ plans
2698+ specifications
2699+ implementation-notes
2700+ miscellaneous-notes
2701
2702
2703 .. |--| unicode:: U+2014
2704
2705=== modified file 'doc/developers/integration.txt'
2706--- doc/developers/integration.txt 2008-04-08 10:55:41 +0000
2707+++ doc/developers/integration.txt 2009-09-09 02:21:47 +0000
2708@@ -244,12 +244,12 @@
2709
2710 source.create_checkout('/tmp/newBzrCheckout', None, False, accelerator_tree
2711
2712-==================
2713+
2714 History Operations
2715 ==================
2716
2717 Finding the last revision number or id
2718-======================================
2719+--------------------------------------
2720
2721 To get the last revision number and id of a branch use::
2722
2723@@ -263,7 +263,7 @@
2724
2725
2726 Getting the list of revision ids that make up a branch
2727-======================================================
2728+------------------------------------------------------
2729
2730 IMPORTANT: This should be avoided wherever possible, as it scales with the
2731 length of history::
2732@@ -277,7 +277,7 @@
2733
2734
2735 Getting a Revision object from a revision id
2736-============================================
2737+--------------------------------------------
2738
2739 The Revision object has attributes like "message" to get the information
2740 about the revision::
2741@@ -287,7 +287,7 @@
2742
2743
2744 Accessing the files from a revision
2745-===================================
2746+-----------------------------------
2747
2748 To get the file contents and tree shape for a specific revision you need
2749 a RevisionTree. These are supplied by the repository for a specific
2750
2751=== added file 'doc/developers/miscellaneous-notes.txt'
2752--- doc/developers/miscellaneous-notes.txt 1970-01-01 00:00:00 +0000
2753+++ doc/developers/miscellaneous-notes.txt 2009-09-07 07:44:36 +0000
2754@@ -0,0 +1,20 @@
2755+Miscellaneous notes
2756+===================
2757+
2758+.. toctree::
2759+ :hidden:
2760+
2761+ dirstate
2762+ update
2763+
2764+
2765+* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
2766+
2767+* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
2768+ performance analysis
2769+
2770+
2771+.. |--| unicode:: U+2014
2772+
2773+..
2774+ vim: ft=rst tw=74 ai
2775
2776=== modified file 'doc/developers/overview.txt'
2777--- doc/developers/overview.txt 2009-03-20 02:08:23 +0000
2778+++ doc/developers/overview.txt 2009-09-08 01:11:40 +0000
2779@@ -12,16 +12,9 @@
2780 document, send a merge request or new text to the mailing list.
2781
2782 The current version of this document is available in the file
2783-``doc/developers/overview.txt`` in the source tree, and from
2784-<http://doc.bazaar-vcs.org/bzr.dev/>.
2785-
2786-See also:
2787-
2788- * `Bazaar Developer Documentation Catalog <index.html>`_.
2789- * `Bazaar Developer Guide <../en/developer-guide/HACKING.html>`_
2790- (particularly the *Coding Style Guidelines* section.)
2791-
2792-.. contents::
2793+``doc/developers/overview.txt`` in the source tree, and available online
2794+within the developer documentation, <http://doc.bazaar-vcs.org/developers/>.
2795+
2796
2797 Essential Domain Classes
2798 ########################
2799
2800=== added file 'doc/developers/plans.txt'
2801--- doc/developers/plans.txt 1970-01-01 00:00:00 +0000
2802+++ doc/developers/plans.txt 2009-09-07 07:44:36 +0000
2803@@ -0,0 +1,29 @@
2804+Plans
2805+=====
2806+
2807+.. toctree::
2808+ :hidden:
2809+
2810+ performance-roadmap
2811+ colocated-branches
2812+ tortoise-strategy
2813+ improved_chk_index
2814+
2815+
2816+* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
2817+ for fixing performance in bzr over the next few releases.
2818+
2819+* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
2820+ for storing multiple branches in one file-system directory.
2821+
2822+* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
2823+ Implmentation strategy for Bazaar Windows Shell Extensions, aka
2824+ TortoiseBzr.
2825+
2826+* `CHK Optimized index <improved_chk_index.html>`_
2827+
2828+
2829+.. |--| unicode:: U+2014
2830+
2831+..
2832+ vim: ft=rst tw=74 ai
2833
2834=== added file 'doc/developers/process.txt'
2835--- doc/developers/process.txt 1970-01-01 00:00:00 +0000
2836+++ doc/developers/process.txt 2009-09-09 02:21:47 +0000
2837@@ -0,0 +1,39 @@
2838+Bazaar Development Processes
2839+============================
2840+
2841+.. toctree::
2842+ :hidden:
2843+
2844+ cycle
2845+ releasing
2846+ ppa
2847+ profiling
2848+ ec2
2849+ bug-handling
2850+
2851+
2852+* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
2853+ development cycle and how to run it.
2854+
2855+* `Releasing Bazaar <releasing.html>`_ |--|
2856+ Checklist to make a release of Bazaar.
2857+
2858+* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
2859+
2860+* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
2861+ your changes to Bazaar integrated into a release.
2862+
2863+* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
2864+ bzr code and visualize the results.
2865+
2866+* `EC2 resources <ec2.html>`_ |--| A team resource for
2867+ Windows packaging and testing, and Ubuntu testing.
2868+
2869+* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug
2870+ tracker.
2871+
2872+
2873+.. |--| unicode:: U+2014
2874+
2875+..
2876+ vim: ft=rst tw=74 ai
2877
2878=== modified file 'doc/developers/releasing.txt'
2879--- doc/developers/releasing.txt 2009-08-28 14:35:26 +0000
2880+++ doc/developers/releasing.txt 2009-09-08 01:11:40 +0000
2881@@ -3,7 +3,7 @@
2882
2883 This document describes the processes for making and announcing a Bazaar
2884 release, and managing the release process. This is just one phase of the
2885-`overall development cycle <cycle.html>`_, but it's the most complex part.
2886+:doc:`overall development cycle <cycle>`, but it's the most complex part.
2887 This document gives a checklist you can follow from start to end in one
2888 go.
2889
2890@@ -81,7 +81,7 @@
2891 submit_to = bazaar@lists.canonical.com
2892 smtp_server = mail.example.com:25
2893
2894- Please see <http://doc.bazaar-vcs.org/latest/developers/HACKING.html#an-overview-of-pqm>
2895+ Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
2896 for more details on PQM
2897
2898 #. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
2899
2900=== added file 'doc/developers/specifications.txt'
2901--- doc/developers/specifications.txt 1970-01-01 00:00:00 +0000
2902+++ doc/developers/specifications.txt 2009-09-07 07:44:36 +0000
2903@@ -0,0 +1,77 @@
2904+Specifications
2905+==============
2906+
2907+.. toctree::
2908+ :hidden:
2909+
2910+ revision-properties
2911+ api-versioning
2912+ apport
2913+ authentication-ring
2914+ bundles
2915+ container-format
2916+ groupcompress-design
2917+ indices
2918+ inventory
2919+ lca-merge
2920+ network-protocol
2921+ plugin-api
2922+ repository
2923+ repository-stream
2924+ case-insensitive-file-systems
2925+ development-repo
2926+ packrepo
2927+
2928+
2929+* `Revision Properties <revision-properties.html>`_ |--| An application
2930+ can set arbitrary per-revision key/value pairs to store app-specific
2931+ data.
2932+
2933+* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
2934+
2935+* `Apport error reporting <apport.html>`_ |--| Capture data to report
2936+ bugs.
2937+
2938+* `Authentication ring <authentication-ring.html>`_ |--| Configuring
2939+ authentication.
2940+
2941+* `Bundles <bundles.html>`_ |--| All about bzr bundles.
2942+
2943+* `Container format <container-format.html>`_ |--| Notes on a container format
2944+ for streaming and storing Bazaar data.
2945+
2946+* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
2947+ technology used in CHK repositories.
2948+
2949+* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
2950+
2951+* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
2952+
2953+* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
2954+
2955+* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
2956+
2957+* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
2958+
2959+* `Repositories <repository.html>`_ |--| What repositories do and are used for.
2960+
2961+* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
2962+ for repositories (a layer above the container format).
2963+
2964+* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
2965+ |--| How Bazaar operates on case-insensitive file systems such as commonly
2966+ found on Windows, USB sticks, etc.
2967+
2968+* `Development repository formats <development-repo.html>`_ |--| How to
2969+ work with repository formats that are still under development.
2970+ Contains instructions for those implementing new formats, of course,
2971+ but also for (bleeding-edge) end users of those formats.
2972+
2973+* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories
2974+ (new in Bazaar 0.92).
2975+
2976+
2977+.. |--| unicode:: U+2014
2978+
2979+..
2980+ vim: ft=rst tw=74 ai
2981
2982=== modified file 'doc/developers/testing.txt'
2983--- doc/developers/testing.txt 2009-03-03 01:45:32 +0000
2984+++ doc/developers/testing.txt 2009-09-09 02:21:47 +0000
2985@@ -1,11 +1,7 @@
2986-=======================
2987-Guide to Testing Bazaar
2988-=======================
2989-
2990-.. contents::
2991-
2992-Testing Bazaar
2993-##############
2994+====================
2995+Bazaar Testing Guide
2996+====================
2997+
2998
2999 The Importance of Testing
3000 =========================
3001
3002=== renamed file 'doc/Makefile' => 'doc/en/Makefile'
3003=== renamed directory 'doc/_static' => 'doc/en/_static'
3004=== renamed file 'doc/_static/en/quick-reference/Makefile' => 'doc/en/_static/en/Makefile'
3005--- doc/_static/en/quick-reference/Makefile 2009-07-22 14:07:56 +0000
3006+++ doc/en/_static/en/Makefile 2009-09-09 00:49:50 +0000
3007@@ -2,8 +2,8 @@
3008 # doc/*/quick-reference/Makefile and update TARGETS and OBJECTS usages in
3009 # doc/Makefile
3010
3011-TARGETS=bzr-quick-reference.png bzr-quick-reference.pdf
3012-OBJECTS=bzr-quick-reference.svg Makefile
3013+TARGETS=bzr-en-quick-reference.png bzr-en-quick-reference.pdf
3014+OBJECTS=bzr-en-quick-reference.svg Makefile
3015
3016 all: $(TARGETS)
3017
3018@@ -15,9 +15,9 @@
3019 .svg.png:
3020 rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $<
3021
3022-bzr-quickref.png: $(OBJECTS)
3023+bzr-en-quick-reference.png: $(OBJECTS)
3024
3025-bzr-quickref.pdf: $(OBJECTS)
3026+bzr-en-quick-reference.pdf: $(OBJECTS)
3027
3028 clean:
3029 rm -f $(TARGETS)
3030
3031=== renamed file 'doc/_static/en/quick-reference/bzr-quick-reference.pdf' => 'doc/en/_static/en/bzr-en-quick-reference.pdf'
3032=== renamed file 'doc/_static/en/quick-reference/bzr-quick-reference.png' => 'doc/en/_static/en/bzr-en-quick-reference.png'
3033=== renamed file 'doc/_static/en/quick-reference/bzr-quick-reference.svg' => 'doc/en/_static/en/bzr-en-quick-reference.svg'
3034=== renamed directory 'doc/_templates' => 'doc/en/_templates'
3035=== modified file 'doc/en/_templates/index.html'
3036--- doc/_templates/index.html 2009-08-18 00:10:19 +0000
3037+++ doc/en/_templates/index.html 2009-09-08 12:33:30 +0000
3038@@ -7,25 +7,39 @@
3039
3040 <table class="contentstable" align="center" style="margin-left: 30px"><tr>
3041 <td width="50%">
3042- <p class="biglink"><a class="biglink" href="{{ pathto("en/user-guide/index") }}">User Guide</a><br/>
3043+ <p class="biglink"><a class="biglink" href="{{ pathto("user-guide/index") }}">User Guide</a><br/>
3044 <span class="linkdescr">how to use Bazaar effectively</span>
3045 </p>
3046- <p class="biglink"><a class="biglink" href="{{ pathto("en/tutorials/index") }}">Tutorials</a><br/>
3047+ <p class="biglink"><a class="biglink" href="{{ pathto("tutorials/index") }}">Tutorials</a><br/>
3048 <span class="linkdescr">brief introductions</span>
3049 </p>
3050- <p class="biglink"><a class="biglink" href="{{ pathto("en/quick-reference/index") }}">Quick Reference</a><br/>
3051+ <p class="biglink"><a class="biglink" href="{{ pathto("quick-reference/index") }}">Quick Reference</a><br/>
3052 <span class="linkdescr">for your wall</span>
3053 </p>
3054- <p class="biglink"><a class="biglink" href="{{ pathto("en/user-reference/bzr_man") }}">User Reference</a><br/>
3055- <span class="linkdescr">all the gory details</span>
3056- </p>
3057 </td><td width="50%">
3058- <p class="biglink"><a class="biglink" href="{{ pathto("en/release-notes/NEWS") }}">Release Notes</a><br/>
3059+ <p class="biglink"><a class="biglink" href="{{ pathto("release-notes/NEWS") }}">Release Notes</a><br/>
3060 <span class="linkdescr">what's new</span>
3061 </p>
3062- <p class="biglink"><a class="biglink" href="{{ pathto("en/upgrade-guide/index") }}">Upgrade Guide</a><br/>
3063+ <p class="biglink"><a class="biglink" href="{{ pathto("upgrade-guide/index") }}">Upgrade Guide</a><br/>
3064 <span class="linkdescr">moving to Bazaar 2.x</span>
3065 </p>
3066+ <p class="biglink"><a class="biglink" href="{{ pathto("user-reference/bzr_man") }}">User Reference</a><br/>
3067+ <span class="linkdescr">all the gory details</span>
3068+ </p>
3069+ </td></tr>
3070+ </table>
3071+
3072+ <h2>Related links</h2>
3073+
3074+ <table class="contentstable" align="center" style="margin-left: 30px"><tr>
3075+ <td width="50%">
3076+ <p class="biglink"><a class="biglink" href="https://answers.launchpad.net/bzr">FAQ</a><br/>
3077+ <span class="linkdescr">frequently asked questions</span>
3078+ </p>
3079+ <p class="biglink"><a class="biglink" href="http://bazaar-vcs.org/BzrGlossary/">Glossary</a><br/>
3080+ <span class="linkdescr">help with terminology</span>
3081+ </p>
3082+ </td><td width="50%">
3083 <p class="biglink"><a class="biglink" href="http://doc.bazaar-vcs.org/migration/en/">Migration Docs</a><br/>
3084 <span class="linkdescr">for refugees of other tools</span>
3085 </p>
3086@@ -35,31 +49,7 @@
3087 </td></tr>
3088 </table>
3089
3090- <p>Keen to help? See the <a href="{{ pathto("developers/index") }}">Developer Docs</a>
3091+ <p>Keen to help? See the <a href="http://doc.bazaar-vcs.org/developers/">Developer Docs</a>
3092 for policies and tools on contributing code, tests and documentation.</p>
3093
3094-
3095- <h2>Related Links</h2>
3096-
3097- <table class="contentstable" align="center" style="margin-left: 30px"><tr>
3098- <td width="25%">
3099- <p><a href="https://answers.launchpad.net/bzr">FAQ</a>
3100- </p>
3101- </td><td width="25%">
3102- <p><a href="http://bazaar-vcs.org/BzrGlossary/">Glossary</a>
3103- </p>
3104- </td><td width="25%">
3105- <p><a href="{{ pathto("genindex") }}">Index</a>
3106- </p>
3107- </td><td width="25%">
3108- <p><a href="{{ pathto("search") }}">Search</a>
3109- </p>
3110- </td></tr>
3111- </table>
3112-
3113- <hr>
3114- <p>Other languages:
3115- <a href="{{ pathto("index.es") }}">Spanish</a>,
3116- <a href="{{ pathto("index.ru") }}">Russian</a>
3117- </p>
3118 {% endblock %}
3119
3120=== modified file 'doc/en/_templates/layout.html'
3121--- doc/_templates/layout.html 2009-07-22 13:41:01 +0000
3122+++ doc/en/_templates/layout.html 2009-09-03 00:21:59 +0000
3123@@ -3,5 +3,6 @@
3124 {% block rootrellink %}
3125 <li><a href="http://bazaar-vcs.org/">
3126 <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Home</a>&nbsp;|&nbsp;</li>
3127+<a href="http://doc.bazaar-vcs.org/en/">Documentation</a>&nbsp;|&nbsp;</li>
3128 {{ super() }}
3129 {% endblock %}
3130
3131=== renamed file 'doc/conf.py' => 'doc/en/conf.py'
3132--- doc/conf.py 2009-07-22 13:41:01 +0000
3133+++ doc/en/conf.py 2009-09-09 00:34:29 +0000
3134@@ -4,208 +4,69 @@
3135 # sphinx-quickstart on Tue Jul 21 17:04:52 2009.
3136 #
3137 # This file is execfile()d with the current directory set to its containing dir.
3138-#
3139-# Note that not all possible configuration values are present in this
3140-# autogenerated file.
3141-#
3142-# All configuration values have a default; values that are commented out
3143-# serve to show the default.
3144
3145 import sys, os
3146
3147 # If extensions (or modules to document with autodoc) are in another directory,
3148 # add these directories to sys.path here. If the directory is relative to the
3149 # documentation root, use os.path.abspath to make it absolute, like shown here.
3150-#sys.path.append(os.path.abspath('.'))
3151-
3152-# -- General configuration -----------------------------------------------------
3153-
3154-# Add any Sphinx extension module names here, as strings. They can be extensions
3155-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
3156-extensions = ['sphinx.ext.ifconfig']
3157-
3158-# Add any paths that contain templates here, relative to this directory.
3159-templates_path = ['_templates']
3160-
3161-# The suffix of source filenames.
3162-source_suffix = '.txt'
3163-
3164-# The encoding of source files.
3165-#source_encoding = 'utf-8'
3166-
3167-# The master toctree document.
3168-master_doc = 'contents'
3169-
3170-# General information about the project.
3171-project = u'Bazaar'
3172-copyright = u'2009, Canonical Ltd'
3173-
3174-# The version info for the project you're documenting, acts as replacement for
3175-# |version| and |release|, also used in various other places throughout the
3176-# built documents.
3177-#
3178-# The short X.Y version.
3179-version = '1.18'
3180-# The full version, including alpha/beta/rc tags.
3181-release = '1.18dev'
3182-
3183-# The language for content autogenerated by Sphinx. Refer to documentation
3184-# for a list of supported languages.
3185-#language = None
3186-
3187-# There are two options for replacing |today|: either, you set today to some
3188-# non-false value, then it is used:
3189-#today = ''
3190-# Else, today_fmt is used as the format for a strftime call.
3191-#today_fmt = '%B %d, %Y'
3192-
3193-# List of documents that shouldn't be included in the build.
3194-#unused_docs = []
3195-
3196-# List of directories, relative to source directory, that shouldn't be searched
3197-# for source files.
3198-exclude_trees = ['_build']
3199-
3200-# The reST default role (used for this markup: `text`) to use for all documents.
3201-#default_role = None
3202-
3203-# If true, '()' will be appended to :func: etc. cross-reference text.
3204-#add_function_parentheses = True
3205-
3206-# If true, the current module name will be prepended to all description
3207-# unit titles (such as .. function::).
3208-#add_module_names = True
3209-
3210-# If true, sectionauthor and moduleauthor directives will be shown in the
3211-# output. They are ignored by default.
3212-#show_authors = False
3213-
3214-# The name of the Pygments (syntax highlighting) style to use.
3215-pygments_style = 'sphinx'
3216-
3217-# A list of ignored prefixes for module index sorting.
3218-#modindex_common_prefix = []
3219-
3220-
3221-# -- Options for HTML output ---------------------------------------------------
3222-
3223-# The theme to use for HTML and HTML Help pages. Major themes that come with
3224-# Sphinx are currently 'default' and 'sphinxdoc'.
3225-html_theme = 'default'
3226-
3227-# Theme options are theme-specific and customize the look and feel of a theme
3228-# further. For a list of options available for each theme, see the
3229-# documentation.
3230-html_theme_options = {
3231- 'rightsidebar': True,
3232-
3233- # Non-document areas: header (relbar), footer, sidebar, etc.
3234- # Some useful colours here:
3235- # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
3236- # midnightblue
3237- # * gray: dimgray, slategray, lightslategray
3238- 'sidebarbgcolor': "cornflowerblue",
3239- 'sidebarlinkcolor': "midnightblue",
3240- 'relbarbgcolor': "darkblue",
3241- 'footerbgcolor': "lightslategray",
3242-
3243- # Text, heading and code colouring
3244- 'codebgcolor': "lightyellow",
3245- 'codetextcolor': "firebrick",
3246- 'linkcolor': "mediumblue",
3247+sys.path = [os.path.abspath('../..')] + sys.path
3248+
3249+# Most of the configuration for Bazaar docs is defined here ...
3250+from bzrlib.doc_generate.sphinx_conf import *
3251+
3252+
3253+## Configuration specific to this site ##
3254+
3255+# The locale code for this documentation set
3256+bzr_locale = 'en'
3257+
3258+# Translations & supporting helper function
3259+bzr_titles = {
3260+ u'Table of Contents (%s)': None,
3261+ u'Bazaar User Guide': None,
3262+ u'Bazaar User Reference': None,
3263+ u'Bazaar Release Notes': None,
3264+ u'Bazaar Upgrade Guide': None,
3265+ u'Bazaar in five minutes': None,
3266+ u'Bazaar Tutorial': None,
3267+ u'Using Bazaar With Launchpad': None,
3268+ u'Centralized Workflow Tutorial': None,
3269 }
3270-
3271-# Add any paths that contain custom themes here, relative to this directory.
3272-#html_theme_path = []
3273-
3274-# The name for this set of Sphinx documents. If None, it defaults to
3275-# "<project> v<release> documentation".
3276-#html_title = None
3277+def bzr_title(s):
3278+ return bzr_titles.get(s) or s
3279
3280 # A shorter title for the navigation bar. Default is the same as html_title.
3281-#html_short_title = None
3282-
3283-# The name of an image file (relative to this directory) to place at the top
3284-# of the sidebar.
3285-#html_logo = None
3286-
3287-# The name of an image file (within the static path) to use as favicon of the
3288-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
3289-# pixels large.
3290-html_favicon = "bzr.ico"
3291-
3292-# Add any paths that contain custom static files (such as style sheets) here,
3293-# relative to this directory. They are copied after the builtin static files,
3294-# so a file named "default.css" will overwrite the builtin "default.css".
3295-html_static_path = ['_static']
3296-
3297-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
3298-# using the given strftime format.
3299-#html_last_updated_fmt = '%b %d, %Y'
3300-
3301-# If true, SmartyPants will be used to convert quotes and dashes to
3302-# typographically correct entities.
3303-#html_use_smartypants = True
3304-
3305-# Custom sidebar templates, maps document names to template names.
3306-#html_sidebars = {}
3307+html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
3308
3309 # Additional templates that should be rendered to pages, maps page names to
3310 # template names.
3311-html_additional_pages = {'contents': 'index.html'}
3312-
3313-# If false, no module index is generated.
3314-#html_use_modindex = True
3315-
3316-# If false, no index is generated.
3317-#html_use_index = True
3318-
3319-# If true, the index is split into individual pages for each letter.
3320-#html_split_index = False
3321-
3322-# If true, links to the reST sources are added to the pages.
3323-html_show_sourcelink = True
3324-
3325-# If true, an OpenSearch description file will be output, and all pages will
3326-# contain a <link> tag referring to it. The value of this option must be the
3327-# base URL from which the finished HTML is served.
3328-#html_use_opensearch = ''
3329-
3330-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
3331-#html_file_suffix = ''
3332+html_additional_pages = {'index': 'index.html'}
3333
3334 # Output file base name for HTML help builder.
3335-htmlhelp_basename = 'Bazaardoc'
3336-
3337-
3338-# -- Options for LaTeX output --------------------------------------------------
3339-
3340-# The paper size ('letter' or 'a4').
3341-#latex_paper_size = 'letter'
3342-
3343-# The font size ('10pt', '11pt' or '12pt').
3344-#latex_font_size = '10pt'
3345+htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
3346
3347 # Grouping the document tree into LaTeX files. List of tuples
3348 # (source start file, target name, title, author, documentclass [howto/manual]).
3349 latex_documents = [
3350- ('contents', 'Bazaar.tex', u'Bazaar Documentation',
3351- u'Bazaar Developers', 'manual'),
3352+ # Manuals
3353+ ('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
3354+ bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
3355+ ('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
3356+ bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
3357+ ('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
3358+ bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
3359+ ('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
3360+ bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
3361+ # Tutorials
3362+ ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
3363+ bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
3364+ ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
3365+ bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
3366+ ('tutorials/using_bazaar_with_launchpad',
3367+ 'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
3368+ bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
3369+ ('tutorials/centralized_workflow',
3370+ 'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
3371+ bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
3372 ]
3373-
3374-# The name of an image file (relative to this directory) to place at the top of
3375-# the title page.
3376-#latex_logo = None
3377-
3378-# For "manual" documents, if this is true, then toplevel headings are parts,
3379-# not chapters.
3380-#latex_use_parts = False
3381-
3382-# Additional stuff for the LaTeX preamble.
3383-#latex_preamble = ''
3384-
3385-# Documents to append as an appendix to all manuals.
3386-#latex_appendices = []
3387-
3388-# If false, no module index is generated.
3389-#latex_use_modindex = True
3390
3391=== removed directory 'doc/en/developer-guide'
3392=== renamed file 'doc/contents.txt' => 'doc/en/index.txt'
3393--- doc/contents.txt 2009-08-18 00:10:19 +0000
3394+++ doc/en/index.txt 2009-09-08 12:33:30 +0000
3395@@ -4,39 +4,15 @@
3396 contain the root `toctree` directive.
3397
3398
3399-Core documentation
3400-==================
3401-
3402-.. toctree::
3403- :maxdepth: 1
3404-
3405- en/user-guide/index
3406- en/tutorials/index
3407- en/quick-reference/index
3408- en/user-reference/index
3409-
3410-.. toctree::
3411- :maxdepth: 1
3412-
3413- en/release-notes/index
3414- en/upgrade-guide/index
3415- developers/index
3416-
3417-
3418-Other languages:
3419-
3420-.. toctree::
3421- :maxdepth: 1
3422-
3423- index.es
3424- index.ru
3425-
3426-
3427-Related links
3428-=============
3429-
3430-* `Frequently Asked Questions <http://bazaar-vcs.org/FAQ>`_
3431-* `Glossary <http://bazaar-vcs.org/BzrGlossary>`_
3432-* :ref:`genindex`
3433-* :ref:`search`
3434-
3435+Table of Contents
3436+=================
3437+
3438+.. toctree::
3439+ :maxdepth: 1
3440+
3441+ user-guide/index
3442+ tutorials/index
3443+ quick-reference/index
3444+ release-notes/NEWS
3445+ upgrade-guide/index
3446+ user-reference/bzr_man
3447
3448=== renamed file 'doc/make.bat' => 'doc/en/make.bat'
3449=== modified file 'doc/en/mini-tutorial/index.txt'
3450--- doc/en/mini-tutorial/index.txt 2009-04-04 02:50:01 +0000
3451+++ doc/en/mini-tutorial/index.txt 2009-09-02 16:03:51 +0000
3452@@ -2,8 +2,6 @@
3453 Bazaar in five minutes
3454 ======================
3455
3456-.. contents::
3457-
3458 Introduction
3459 ============
3460
3461
3462=== modified file 'doc/en/quick-reference/index.txt'
3463--- doc/en/quick-reference/index.txt 2009-07-22 14:07:56 +0000
3464+++ doc/en/quick-reference/index.txt 2009-09-09 02:32:10 +0000
3465@@ -1,6 +1,6 @@
3466 Quick Reference
3467 ===============
3468
3469-* `SVG format <../../_static/en/quick-reference/bzr-quick-reference.svg>`_
3470-* `PDF format <../../_static/en/quick-reference/bzr-quick-reference.pdf>`_
3471-* `PNG format <../../_static/en/quick-reference/bzr-quick-reference.png>`_
3472+* `PDF format <../_static/en/bzr-en-quick-reference.pdf>`_
3473+* `PNG format <../_static/en/bzr-en-quick-reference.png>`_
3474+* `SVG format <../_static/en/bzr-en-quick-reference.svg>`_
3475
3476=== modified file 'doc/en/tutorials/centralized_workflow.txt'
3477--- doc/en/tutorials/centralized_workflow.txt 2009-07-22 13:41:01 +0000
3478+++ doc/en/tutorials/centralized_workflow.txt 2009-09-02 16:03:51 +0000
3479@@ -1,6 +1,6 @@
3480-====================
3481-Centralized Workflow
3482-====================
3483+=============================
3484+Centralized Workflow Tutorial
3485+=============================
3486
3487
3488 Overview
3489@@ -23,8 +23,6 @@
3490
3491 .. _Bazaar: http://bazaar-vcs.org
3492
3493-.. contents::
3494-
3495
3496 Initial Setup
3497 =============
3498
3499=== modified file 'doc/en/tutorials/tutorial.txt'
3500--- doc/en/tutorials/tutorial.txt 2009-06-27 08:10:13 +0000
3501+++ doc/en/tutorials/tutorial.txt 2009-09-02 16:03:51 +0000
3502@@ -11,8 +11,6 @@
3503 Bazaar Tutorial
3504 ===============
3505
3506-Current for bzr-0.91, 2007-08
3507-
3508
3509 Introduction
3510 ============
3511@@ -24,8 +22,8 @@
3512 different." Otherwise, get some coffee or tea, get comfortable and get
3513 ready to catch up.
3514
3515-The Purposes of Revision Control
3516-================================
3517+The purpose of revision control
3518+===============================
3519
3520 Odds are that you have worked on some sort of textual data -- the sources
3521 to a program, web sites or the config files that Unix system
3522@@ -57,8 +55,8 @@
3523 We keep these logs so that if later there is some sort of problem with
3524 sftp, we can figure out when the problem probably happened.
3525
3526-How DRCS is Different
3527----------------------
3528+How DRCS is different
3529+=====================
3530
3531 Many Revision Control Systems (RCS) are stored on servers. If one wants to
3532 work on the code stored within an RCS, then one needs to connect to the
3533@@ -282,6 +280,7 @@
3534 As a shortcut, ``bzr diff -p1`` produces a form that works with the
3535 command ``patch -p1``.
3536
3537+
3538 Committing changes
3539 ==================
3540
3541@@ -308,7 +307,7 @@
3542 can also be useful when you pick up your work after a break.)
3543
3544 Message from an editor
3545-======================
3546+----------------------
3547
3548 If you use neither the ``-m`` nor the ``-F`` option then bzr will open an
3549 editor for you to enter a message. The editor to run is controlled by
3550@@ -355,9 +354,13 @@
3551 given then only those ones will be affected. ``bzr revert`` also clears the
3552 list of pending merges revisions.
3553
3554+
3555 Ignoring files
3556 ==============
3557
3558+The .bzrignore file
3559+-------------------
3560+
3561 Many source trees contain some files that do not need to be versioned,
3562 such as editor backups, object or bytecode files, and built programs. You
3563 can simply not add them, but then they'll always crop up as unknown files.
3564@@ -400,7 +403,7 @@
3565 % bzr commit -m "Add ignore patterns"
3566
3567
3568-Global Ignores
3569+Global ignores
3570 --------------
3571
3572 There are some ignored files which are not project specific, but more user
3573@@ -574,6 +577,7 @@
3574 rsync, or other related file transfer methods. This is usually less safe
3575 than using ``push``, but may be faster or easier in some situations.
3576
3577+
3578 Moving changes between trees
3579 ============================
3580
3581
3582=== modified file 'doc/en/tutorials/using_bazaar_with_launchpad.txt'
3583--- doc/en/tutorials/using_bazaar_with_launchpad.txt 2009-07-22 13:41:01 +0000
3584+++ doc/en/tutorials/using_bazaar_with_launchpad.txt 2009-09-02 16:03:51 +0000
3585@@ -2,8 +2,6 @@
3586 Using Bazaar with Launchpad
3587 ===========================
3588
3589-.. contents::
3590-
3591
3592 Motivation
3593 ==========
3594
3595=== modified file 'doc/en/upgrade-guide/index.txt'
3596--- doc/en/upgrade-guide/index.txt 2009-07-22 13:41:01 +0000
3597+++ doc/en/upgrade-guide/index.txt 2009-09-02 16:03:51 +0000
3598@@ -8,8 +8,6 @@
3599 .. level 3 ~~~~~~~~
3600 .. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
3601
3602-.. contents::
3603-
3604 .. include:: overview.txt
3605 .. include:: data_migration.txt
3606 .. include:: tips_and_tricks.txt
3607
3608=== removed file 'doc/en/user-guide/index.txt'
3609--- doc/en/user-guide/index.txt 2009-07-26 15:58:33 +0000
3610+++ doc/en/user-guide/index.txt 1970-01-01 00:00:00 +0000
3611@@ -1,118 +0,0 @@
3612-#################
3613-Bazaar User Guide
3614-#################
3615-
3616-.. Please mark sections in included files as following:
3617-.. level 1 ========
3618-.. level 2 --------
3619-.. level 3 ~~~~~~~~
3620-.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
3621-
3622-.. contents:: :depth: 3
3623-
3624-
3625-Introduction
3626-############
3627-
3628-.. include:: introducing_bazaar.txt
3629-.. include:: core_concepts.txt
3630-.. include:: bazaar_workflows.txt
3631-
3632-
3633-Getting started
3634-###############
3635-
3636-.. include:: installing_bazaar.txt
3637-.. include:: entering_commands.txt
3638-.. include:: getting_help.txt
3639-.. include:: configuring_bazaar.txt
3640-.. include:: using_aliases.txt
3641-.. include:: plugins.txt
3642-.. include:: zen.txt
3643-
3644-
3645-Personal version control
3646-########################
3647-
3648-.. include:: solo_intro.txt
3649-.. include:: starting_a_project.txt
3650-.. include:: controlling_registration.txt
3651-.. include:: reviewing_changes.txt
3652-.. include:: recording_changes.txt
3653-.. include:: browsing_history.txt
3654-.. include:: releasing_a_project.txt
3655-.. include:: undoing_mistakes.txt
3656-
3657-
3658-Sharing with peers
3659-##################
3660-
3661-.. include:: partner_intro.txt
3662-.. include:: branching_a_project.txt
3663-.. include:: merging_changes.txt
3664-.. include:: resolving_conflicts.txt
3665-.. include:: annotating_changes.txt
3666-
3667-
3668-Team collaboration, central style
3669-#################################
3670-
3671-.. include:: central_intro.txt
3672-.. include:: publishing_a_branch.txt
3673-.. include:: using_checkouts.txt
3674-.. include:: working_offline_central.txt
3675-.. include:: reusing_a_checkout.txt
3676-
3677-
3678-Team collaboration, distributed style
3679-#####################################
3680-
3681-.. include:: distributed_intro.txt
3682-.. include:: organizing_branches.txt
3683-.. include:: using_gatekeepers.txt
3684-.. include:: sending_changes.txt
3685-
3686-
3687-Miscellaneous topics
3688-####################
3689-
3690-.. include:: part2_intro.txt
3691-.. include:: adv_merging.txt
3692-.. include:: shelving_changes.txt
3693-.. include:: filtered_views.txt
3694-.. include:: stacked.txt
3695-.. include:: server.txt
3696-.. include:: hooks.txt
3697-.. include:: version_info.txt
3698-
3699-
3700-A brief tour of some popular plugins
3701-####################################
3702-
3703-.. include:: bzrtools_plugin.txt
3704-.. include:: svn_plugin.txt
3705-.. include later looms_plugin.txt
3706-
3707-
3708-Integrating Bazaar into your environment
3709-########################################
3710-
3711-.. include:: web_browsing.txt
3712-.. include later - file_explorers.txt
3713-.. include later - desktop_integration.txt
3714-.. include later - editors_and_ides.txt
3715-.. include later - email.txt
3716-.. include:: bug_trackers.txt
3717-
3718-
3719-Appendices
3720-##########
3721-
3722-.. include:: specifying_revisions.txt
3723-.. include:: organizing_your_workspace.txt
3724-.. include:: shared_repository_layouts.txt
3725-.. include:: setting_up_email.txt
3726-.. include:: http_smart_server.txt
3727-.. include:: writing_a_plugin.txt
3728-
3729-.. |--| unicode:: U+2014
3730
3731=== renamed file 'doc/en/user-guide/index-for-2x.txt' => 'doc/en/user-guide/index.txt'
3732=== added directory 'doc/es/_static'
3733=== added file 'doc/es/_static/bzr icon 16.png'
3734Binary 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
3735=== added file 'doc/es/_static/bzr.ico'
3736Binary 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
3737=== added directory 'doc/es/_static/es'
3738=== renamed file 'doc/es/quick-reference/Makefile' => 'doc/es/_static/es/Makefile'
3739--- doc/es/quick-reference/Makefile 2009-06-29 11:02:31 +0000
3740+++ doc/es/_static/es/Makefile 2009-09-09 00:49:50 +0000
3741@@ -1,5 +1,5 @@
3742-TARGETS=quick-start-summary.png quick-start-summary.pdf
3743-OBJECTS=quick-start-summary.svg Makefile
3744+TARGETS=bzr-es-quick-reference.png bzr-es-quick-reference.pdf
3745+OBJECTS=bzr-es-quick-reference.svg Makefile
3746
3747 all: $(TARGETS)
3748
3749@@ -11,9 +11,9 @@
3750 .svg.png:
3751 rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $<
3752
3753-bzr-quickref.png: $(OBJECTS)
3754+bzr-es-quick-reference.png: $(OBJECTS)
3755
3756-bzr-quickref.pdf: $(OBJECTS)
3757+bzr-es-quick-reference.pdf: $(OBJECTS)
3758
3759 clean:
3760 rm -f $(TARGETS)
3761
3762=== renamed file 'doc/es/quick-reference/quick-start-summary.pdf' => 'doc/es/_static/es/bzr-es-quick-reference.pdf'
3763=== renamed file 'doc/es/quick-reference/quick-start-summary.png' => 'doc/es/_static/es/bzr-es-quick-reference.png'
3764=== renamed file 'doc/es/quick-reference/quick-start-summary.svg' => 'doc/es/_static/es/bzr-es-quick-reference.svg'
3765=== added directory 'doc/es/_templates'
3766=== added file 'doc/es/_templates/layout.html'
3767--- doc/es/_templates/layout.html 1970-01-01 00:00:00 +0000
3768+++ doc/es/_templates/layout.html 2009-09-07 06:12:15 +0000
3769@@ -0,0 +1,8 @@
3770+{% extends "!layout.html" %}
3771+
3772+{% block rootrellink %}
3773+<li><a href="http://bazaar-vcs.org/">
3774+ <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Inicio</a>&nbsp;|&nbsp;</li>
3775+<a href="http://doc.bazaar-vcs.org/en/">Documentación</a>&nbsp;|&nbsp;</li>
3776+{{ super() }}
3777+{% endblock %}
3778
3779=== added file 'doc/es/conf.py'
3780--- doc/es/conf.py 1970-01-01 00:00:00 +0000
3781+++ doc/es/conf.py 2009-09-09 00:34:29 +0000
3782@@ -0,0 +1,76 @@
3783+# -*- coding: utf-8 -*-
3784+#
3785+# Bazaar documentation build configuration file, created by
3786+# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
3787+#
3788+# This file is execfile()d with the current directory set to its containing dir.
3789+
3790+import sys, os
3791+
3792+# If extensions (or modules to document with autodoc) are in another directory,
3793+# add these directories to sys.path here. If the directory is relative to the
3794+# documentation root, use os.path.abspath to make it absolute, like shown here.
3795+sys.path = [os.path.abspath('../..')] + sys.path
3796+
3797+# Most of the configuration for Bazaar docs is defined here ...
3798+from bzrlib.doc_generate.sphinx_conf import *
3799+
3800+
3801+## Configuration specific to this site ##
3802+
3803+# The locale code for this documentation set
3804+bzr_locale = 'es'
3805+
3806+# Translations & supporting helper function
3807+bzr_titles = {
3808+ u'Table of Contents (%s)': u'Contenidos (%s)',
3809+ u'Bazaar User Guide': u'Guia de Usuario',
3810+ u'Bazaar User Reference': None,
3811+ u'Bazaar Release Notes': None,
3812+ u'Bazaar Upgrade Guide': None,
3813+ u'Bazaar in five minutes': u'Bazaar en cinco minutos',
3814+ u'Bazaar Tutorial': None,
3815+ u'Using Bazaar With Launchpad': None,
3816+ u'Centralized Workflow Tutorial': None,
3817+ }
3818+def bzr_title(s):
3819+ return bzr_titles.get(s) or s
3820+
3821+# The language for content autogenerated by Sphinx. Refer to documentation
3822+# for a list of supported languages.
3823+language = bzr_locale
3824+
3825+# A shorter title for the navigation bar. Default is the same as html_title.
3826+html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
3827+
3828+# Additional templates that should be rendered to pages, maps page names to
3829+# template names.
3830+#html_additional_pages = {'index': 'index.html'}
3831+
3832+# Output file base name for HTML help builder.
3833+htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
3834+
3835+# Grouping the document tree into LaTeX files. List of tuples
3836+# (source start file, target name, title, author, documentclass [howto/manual]).
3837+latex_documents = [
3838+ # Manuals
3839+ ('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
3840+ bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
3841+ #('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
3842+ # bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
3843+ #('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
3844+ # bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
3845+ #('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
3846+ # bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
3847+ # Tutorials
3848+ ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
3849+ bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
3850+ #('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
3851+ # bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
3852+ #('tutorials/using_bazaar_with_launchpad',
3853+ # 'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
3854+ # bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
3855+ #('tutorials/centralized_workflow',
3856+ # 'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
3857+ # bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
3858+]
3859
3860=== removed directory 'doc/es/developer-guide'
3861=== renamed file 'doc/index.es.txt' => 'doc/es/index.txt'
3862--- doc/index.es.txt 2009-06-29 11:02:31 +0000
3863+++ doc/es/index.txt 2009-09-09 02:30:32 +0000
3864@@ -1,46 +1,40 @@
3865-==================================
3866+=================================
3867 Indice de Documentacion de Bazaar
3868-==================================
3869+=================================
3870
3871 Las ultimas versiones de estos documentos se encuentran disponibles
3872-en la pagina de Bazaar, http://doc.bazaar-vcs.org.
3873+en la pagina de Bazaar, http://doc.bazaar-vcs.org/en/.
3874
3875 Documentacion Principal
3876 =======================
3877
3878-* `Mini Tutorial <es/mini-tutorial/index.html>`_
3879-
3880-* `Referencia Rapida <es/quick-reference/quick-start-summary.svg>`_
3881-
3882-* `Guia de Usuario <es/user-guide/index.html>`_
3883-
3884-* `Referencia <es/user-reference/bzr_man.html>`_
3885-
3886-* `Notas sobre la Version <es/release-notes/NEWS.html>`_
3887-
3888-* `Guia del Desarrollador <es/developer-guide/HACKING.html>`_
3889+.. toctree::
3890+ :maxdepth: 1
3891+
3892+ mini-tutorial/index
3893+ quick-reference/index
3894+ user-guide/index
3895
3896
3897 Otra Documentacion
3898-===================
3899+==================
3900
3901 Mudandose a Bazaar (enlances web):
3902
3903-* `Guias de Mudanzas <http://bazaar-vcs.org/BzrSwitching>`_
3904- - para los usuarios que se mudan de otros SCV
3905-
3906-* `Guias de Migracion <http://bazaar-vcs.org/BzrMigration>`_
3907+* `Guias de Migracion <http://doc.bazaar-vcs.org/migration/en/>`_
3908 - para equipos que mudan el historial de otros SCV
3909
3910+* `Guias de Plugins <http://doc.bazaar-vcs.org/plugins/en/>`_
3911+
3912 Otros Documentos (enlances web):
3913
3914 * `Glosario <http://bazaar-vcs.org/BzrGlossary>`_
3915
3916-* `Preguntas Frecuentes <http://bazaar-vcs.org/FAQ>`_
3917+* `Preguntas Frecuentes <https://answers.launchpad.net/bzr>`_
3918
3919 * `Referencia del API bzrlib <http://bazaar-vcs.org/BzrLib>`_
3920
3921 Especificaciones tecnicas, planes a futuro y varias
3922 notas tecnicas varias en Ingles:
3923
3924-* `Catalogo de Documentos para Desarrolladores <developers/index.html>`_
3925+* `Catalogo de Documentos para Desarrolladores <http://doc.bazaar-vcs.org/latest/developers/>`_
3926
3927=== modified file 'doc/es/mini-tutorial/index.txt'
3928--- doc/es/mini-tutorial/index.txt 2009-06-29 11:02:31 +0000
3929+++ doc/es/mini-tutorial/index.txt 2009-09-08 01:19:48 +0000
3930@@ -2,8 +2,6 @@
3931 Bazaar en cinco minutos
3932 =======================
3933
3934-.. contents:: Contenidos
3935-
3936 Introducción
3937 ============
3938
3939
3940=== added file 'doc/es/quick-reference/index.txt'
3941--- doc/es/quick-reference/index.txt 1970-01-01 00:00:00 +0000
3942+++ doc/es/quick-reference/index.txt 2009-09-09 02:32:10 +0000
3943@@ -0,0 +1,6 @@
3944+Referencia Rapida
3945+=================
3946+
3947+* `PDF format <../_static/es/bzr-es-quick-reference.pdf>`_
3948+* `PNG format <../_static/es/bzr-es-quick-reference.png>`_
3949+* `SVG format <../_static/es/bzr-es-quick-reference.svg>`_
3950
3951=== removed directory 'doc/es/release-notes'
3952=== modified file 'doc/es/user-guide/index.txt'
3953--- doc/es/user-guide/index.txt 2008-05-12 00:59:13 +0000
3954+++ doc/es/user-guide/index.txt 2009-09-08 01:19:48 +0000
3955@@ -10,9 +10,6 @@
3956 .. level 3 ~~~~~~~~
3957 .. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
3958
3959-.. contents:: :depth: 2
3960-.. sectnum::
3961-
3962
3963 Introducción
3964 ############
3965
3966=== removed directory 'doc/es/user-reference'
3967=== removed file 'doc/index.txt'
3968--- doc/index.txt 2009-08-10 06:53:44 +0000
3969+++ doc/index.txt 1970-01-01 00:00:00 +0000
3970@@ -1,66 +0,0 @@
3971-============================
3972-Bazaar Main Document Catalog
3973-============================
3974-
3975-The latest version of these documents are available from Bazaar's
3976-documentation site, <http://doc.bazaar-vcs.org/>, and more documentation
3977-may be linked from <http://bazaar-vcs.org/Documentation>.
3978-
3979-Core Documentation
3980-==================
3981-
3982-* `User Guide <en/user-guide/index.html>`_
3983-
3984-* `User Reference <en/user-reference/bzr_man.html>`_
3985-
3986-* `Quick Start Card <_static/en/quick-reference/bzr-quick-reference.svg>`_
3987- (`PDF <_static/en/quick-reference/bzr-quick-reference.pdf>`_,
3988- `PNG <_static/en/quick-reference/bzr-quick-reference.png>`_)
3989-
3990-* `Release Notes <en/release-notes/NEWS.html>`_
3991-
3992-* `2.0 Upgrade Guide <en/upgrade-guide/index.html>`_
3993-
3994-
3995-Tutorials
3996-=========
3997-
3998-* `Bazaar in five minutes <en/mini-tutorial/index.html>`_
3999-
4000-* `A longer tutorial <en/tutorials/tutorial.html>`_
4001-
4002-* `Using Bazaar with Launchpad <en/tutorials/using_bazaar_with_launchpad.html>`_
4003-
4004-* `Centralized workflow <en/tutorials/centralized_workflow.html>`_
4005-
4006-
4007-Developer Documentation
4008-=======================
4009-
4010-* `Developer Document Catalog <developers/index.html>`_ |--| for developers
4011- of Bazaar and plugins
4012-
4013-Web links
4014-=========
4015-
4016-* `Switching Guides <http://bazaar-vcs.org/BzrSwitching>`_
4017- |--| for users moving from another VCS tool
4018-
4019-* `Migration Guide <http://bazaar-vcs.org/BzrMigration>`_
4020- |--| for teams migrating history from another VCS tool
4021-
4022-* `Glossary <http://bazaar-vcs.org/BzrGlossary>`_
4023-
4024-* `Frequently Asked Questions <http://bazaar-vcs.org/FAQ>`_
4025-
4026-
4027-Other Languages
4028-===============
4029-
4030-* `Spanish Documentation <index.es.html>`_
4031-* `Russian Documentation <index.ru.html>`_ |--| документация на русском
4032-
4033-.. |--| unicode:: U+2014
4034-
4035-..
4036- vim: ft=rst tw=74 ai
4037
4038=== added directory 'doc/ru/_static'
4039=== added file 'doc/ru/_static/bzr icon 16.png'
4040Binary 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
4041=== added file 'doc/ru/_static/bzr.ico'
4042Binary 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
4043=== added directory 'doc/ru/_static/ru'
4044=== renamed file 'doc/ru/quick-reference/Makefile' => 'doc/ru/_static/ru/Makefile'
4045--- doc/ru/quick-reference/Makefile 2008-08-19 06:29:48 +0000
4046+++ doc/ru/_static/ru/Makefile 2009-09-07 05:26:43 +0000
4047@@ -1,5 +1,5 @@
4048-TARGETS=quick-start-summary.png quick-start-summary.pdf
4049-OBJECTS=quick-start-summary.svg Makefile
4050+TARGETS=bzr-quick-reference.png bzr-quick-reference.pdf
4051+OBJECTS=bzr-quick-reference.svg Makefile
4052
4053 all: $(TARGETS)
4054
4055@@ -11,9 +11,9 @@
4056 .svg.png:
4057 rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $<
4058
4059-bzr-quickref.png: $(OBJECTS)
4060+bzr-quick-reference.png: $(OBJECTS)
4061
4062-bzr-quickref.pdf: $(OBJECTS)
4063+bzr-quick-reference.pdf: $(OBJECTS)
4064
4065 clean:
4066 rm -f $(TARGETS)
4067
4068=== renamed file 'doc/ru/quick-reference/quick-start-summary.pdf' => 'doc/ru/_static/ru/bzr-ru-quick-reference.pdf'
4069=== renamed file 'doc/ru/quick-reference/quick-start-summary.png' => 'doc/ru/_static/ru/bzr-ru-quick-reference.png'
4070=== renamed file 'doc/ru/quick-reference/quick-start-summary.svg' => 'doc/ru/_static/ru/bzr-ru-quick-reference.svg'
4071=== added directory 'doc/ru/_templates'
4072=== added file 'doc/ru/_templates/layout.html'
4073--- doc/ru/_templates/layout.html 1970-01-01 00:00:00 +0000
4074+++ doc/ru/_templates/layout.html 2009-09-08 15:06:56 +0000
4075@@ -0,0 +1,8 @@
4076+{% extends "!layout.html" %}
4077+
4078+{% block rootrellink %}
4079+<li><a href="http://bazaar-vcs.org/">
4080+ <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Главная</a>&nbsp;|&nbsp;</li>
4081+<a href="http://doc.bazaar-vcs.org/ru/">Документация</a>&nbsp;|&nbsp;</li>
4082+{{ super() }}
4083+{% endblock %}
4084
4085=== added file 'doc/ru/conf.py'
4086--- doc/ru/conf.py 1970-01-01 00:00:00 +0000
4087+++ doc/ru/conf.py 2009-09-09 02:30:32 +0000
4088@@ -0,0 +1,76 @@
4089+# -*- coding: utf-8 -*-
4090+#
4091+# Bazaar documentation build configuration file, created by
4092+# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
4093+#
4094+# This file is execfile()d with the current directory set to its containing dir.
4095+
4096+import sys, os
4097+
4098+# If extensions (or modules to document with autodoc) are in another directory,
4099+# add these directories to sys.path here. If the directory is relative to the
4100+# documentation root, use os.path.abspath to make it absolute, like shown here.
4101+sys.path = [os.path.abspath('../..')] + sys.path
4102+
4103+# Most of the configuration for Bazaar docs is defined here ...
4104+from bzrlib.doc_generate.sphinx_conf import *
4105+
4106+
4107+## Configuration specific to this site ##
4108+
4109+# The locale code for this documentation set
4110+bzr_locale = 'ru'
4111+
4112+# Translations & supporting helper function
4113+bzr_titles = {
4114+ u'Table of Contents (%s)': u'Содержание (%s)',
4115+ u'Bazaar User Guide': None,
4116+ u'Bazaar User Reference': None,
4117+ u'Bazaar Release Notes': None,
4118+ u'Bazaar Upgrade Guide': None,
4119+ u'Bazaar in five minutes': u'Базар за пять минут',
4120+ u'Bazaar Tutorial': u'Большой учебник',
4121+ u'Using Bazaar With Launchpad': u'Использование Bazaar с Launchpad',
4122+ u'Centralized Workflow Tutorial': u'Работа в централизованном стиле',
4123+ }
4124+def bzr_title(s):
4125+ return bzr_titles.get(s) or s
4126+
4127+# The language for content autogenerated by Sphinx. Refer to documentation
4128+# for a list of supported languages.
4129+language = bzr_locale
4130+
4131+# A shorter title for the navigation bar. Default is the same as html_title.
4132+html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
4133+
4134+# Additional templates that should be rendered to pages, maps page names to
4135+# template names.
4136+#html_additional_pages = {'index': 'index.html'}
4137+
4138+# Output file base name for HTML help builder.
4139+htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
4140+
4141+# Grouping the document tree into LaTeX files. List of tuples
4142+# (source start file, target name, title, author, documentclass [howto/manual]).
4143+latex_documents = [
4144+ # Manuals
4145+ #('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
4146+ # bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
4147+ #('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
4148+ # bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
4149+ #('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
4150+ # bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
4151+ #('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
4152+ # bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
4153+ # Tutorials
4154+ ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
4155+ bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
4156+ ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
4157+ bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
4158+ #('tutorials/using_bazaar_with_launchpad',
4159+ # 'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
4160+ # bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
4161+ #('tutorials/centralized_workflow',
4162+ # 'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
4163+ # bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
4164+]
4165
4166=== renamed file 'doc/index.ru.txt' => 'doc/ru/index.txt'
4167--- doc/index.ru.txt 2009-06-02 18:07:12 +0000
4168+++ doc/ru/index.txt 2009-09-09 02:30:32 +0000
4169@@ -3,45 +3,26 @@
4170 =================================
4171
4172 Последняя версия этих документов доступа со страницы документации
4173-на сайте Bazaar, <http://doc.bazaar-vcs.org/>. Еще больше информации
4174-можно получить по адресу <http://bazaar-vcs.org/Documentation>.
4175+на сайте Bazaar, <http://doc.bazaar-vcs.org/ru/>.
4176
4177 Основная документация
4178 =====================
4179
4180-* `Руководство пользователя <ru/user-guide/index.html>`_
4181-
4182-* `Справочник пользователя <en/user-reference/bzr_man.html>`_ (англ.)
4183-
4184-* `Карточка быстрого старта <ru/quick-reference/quick-start-summary.svg>`_
4185- (`PDF <ru/quick-reference/quick-start-summary.pdf>`_,
4186- `PNG <ru/quick-reference/quick-start-summary.png>`_)
4187-
4188-* `Список изменений <en/release-notes/NEWS.html>`_ (англ.)
4189-
4190-* `Каталог информации для разработчиков <developers/index.html>`_ (англ.) |--|
4191- для разработчиков Bazaar и плагинов
4192-
4193-Учебники
4194-========
4195-
4196-* `Базар за пять минут <ru/mini-tutorial/index.html>`_
4197-
4198-* `Большой учебник <ru/tutorials/tutorial.html>`_
4199-
4200-* `Использование Bazaar с Launchpad
4201- <ru/tutorials/using_bazaar_with_launchpad.html>`_
4202-
4203-* `Работа в централизованном стиле
4204- <ru/tutorials/centralized_workflow.html>`_
4205+.. toctree::
4206+ :maxdepth: 1
4207+
4208+ user-guide/index
4209+ quick-reference/index
4210+ mini-tutorial/index
4211+ tutorials/tutorial
4212+ tutorials/using_bazaar_with_launchpad
4213+ tutorials/centralized_workflow
4214+
4215
4216 Ссылки в сети
4217 =============
4218
4219-* `Руководства по переходу <http://bazaar-vcs.org/BzrSwitching>`_
4220- |--| для пользователей переходящих с других систем контроля версий
4221-
4222-* `Руководство по миграции <http://bazaar-vcs.org/BzrMigration>`_
4223+* `Руководство по миграции <http://doc.bazaar-vcs.org/migration/en/>`_
4224 |--| для команд переносящих историю с других систем контроля версий
4225
4226 * `Словарь терминов <http://bazaar-vcs.org/BzrGlossary>`_ (англ.),
4227@@ -49,13 +30,8 @@
4228
4229 __ 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
4230
4231-* `Часто задаваемые вопросы <http://bazaar-vcs.org/FAQ>`_ (англ.)
4232-
4233-Другие языки
4234-============
4235-
4236-* `Документация на английском <index.html>`_ |--| English Documentation
4237-* `Документация на испанском <index.es.html>`_
4238+* `Часто задаваемые вопросы <https://answers.launchpad.net/bzr>`_ (англ.)
4239+
4240
4241 .. |--| unicode:: U+2014
4242
4243
4244=== added file 'doc/ru/quick-reference/index.txt'
4245--- doc/ru/quick-reference/index.txt 1970-01-01 00:00:00 +0000
4246+++ doc/ru/quick-reference/index.txt 2009-09-09 02:32:10 +0000
4247@@ -0,0 +1,6 @@
4248+Карточка быстрого старта
4249+========================
4250+
4251+* `PDF <../_static/ru/bzr-ru-quick-reference.pdf>`_
4252+* `PNG <../_static/ru/bzr-ru-quick-reference.png>`_
4253+* `SVG <../_static/ru/bzr-ru-quick-reference.svg>`_
4254
4255=== added file 'tools/generate_release_notes.py'
4256--- tools/generate_release_notes.py 1970-01-01 00:00:00 +0000
4257+++ tools/generate_release_notes.py 2009-09-03 05:09:22 +0000
4258@@ -0,0 +1,86 @@
4259+#!/usr/bin/python
4260+
4261+# Copyright 2009 Canonical Ltd.
4262+#
4263+# This program is free software; you can redistribute it and/or modify
4264+# it under the terms of the GNU General Public License as published by
4265+# the Free Software Foundation; either version 2 of the License, or
4266+# (at your option) any later version.
4267+#
4268+# This program is distributed in the hope that it will be useful,
4269+# but WITHOUT ANY WARRANTY; without even the implied warranty of
4270+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4271+# GNU General Public License for more details.
4272+#
4273+# You should have received a copy of the GNU General Public License
4274+# along with this program; if not, write to the Free Software
4275+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
4276+
4277+import os
4278+import sys
4279+from optparse import OptionParser
4280+
4281+sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
4282+
4283+
4284+def split_into_topics(lines, out_file, out_dir):
4285+ """Split a large NEWS file into topics, one per release.
4286+
4287+ Releases are detected by matching headings that look like
4288+ release names. Topics are created with matching names
4289+ replacing spaces with dashes.
4290+ """
4291+ topic_file = None
4292+ for index, line in enumerate(lines):
4293+ maybe_new_topic = line[:4] in ['bzr ', 'bzr-0',]
4294+ if maybe_new_topic and lines[index + 1].startswith('####'):
4295+ release = line.strip()
4296+ if topic_file is None:
4297+ # First topic found
4298+ out_file.write(".. toctree::\n :maxdepth: 1\n\n")
4299+ else:
4300+ # close the current topic
4301+ topic_file.close()
4302+ topic_file = open_topic_file(out_file, out_dir, release)
4303+ elif topic_file:
4304+ topic_file.write(line)
4305+ else:
4306+ # Still in the header - dump content straight to output
4307+ out_file.write(line)
4308+
4309+
4310+def open_topic_file(out_file, out_dir, release):
4311+ topic_name = release.replace(' ', '-')
4312+ out_file.write(" %s\n" % (topic_name,))
4313+ topic_path = os.path.join(out_dir, "%s.txt" % (topic_name,))
4314+ result = open(topic_path, 'w')
4315+ result.write("%s\n" % (release,))
4316+ return result
4317+
4318+
4319+def main(argv):
4320+ # Check usage
4321+ parser = OptionParser(usage="%prog SOURCE DESTINATION")
4322+ (options, args) = parser.parse_args(argv)
4323+ if len(args) != 2:
4324+ parser.print_help()
4325+ sys.exit(1)
4326+
4327+ # Open the files and do the work
4328+ infile_name = args[0]
4329+ outfile_name = args[1]
4330+ outdir = os.path.dirname(outfile_name)
4331+ infile = open(infile_name, 'r')
4332+ try:
4333+ lines = infile.readlines()
4334+ finally:
4335+ infile.close()
4336+ outfile = open(outfile_name, 'w')
4337+ try:
4338+ split_into_topics(lines, outfile, outdir)
4339+ finally:
4340+ outfile.close()
4341+
4342+
4343+if __name__ == '__main__':
4344+ main(sys.argv[1:])
4345
4346=== added file 'tools/package_docs.py'
4347--- tools/package_docs.py 1970-01-01 00:00:00 +0000
4348+++ tools/package_docs.py 2009-09-09 00:49:50 +0000
4349@@ -0,0 +1,109 @@
4350+#!/usr/bin/python
4351+
4352+# Copyright 2009 Canonical Ltd.
4353+#
4354+# This program is free software; you can redistribute it and/or modify
4355+# it under the terms of the GNU General Public License as published by
4356+# the Free Software Foundation; either version 2 of the License, or
4357+# (at your option) any later version.
4358+#
4359+# This program is distributed in the hope that it will be useful,
4360+# but WITHOUT ANY WARRANTY; without even the implied warranty of
4361+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4362+# GNU General Public License for more details.
4363+#
4364+# You should have received a copy of the GNU General Public License
4365+# along with this program; if not, write to the Free Software
4366+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
4367+
4368+import os
4369+import sys
4370+import tarfile
4371+from optparse import OptionParser
4372+from shutil import copy2, copytree, rmtree
4373+
4374+sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
4375+
4376+
4377+def package_docs(section, src_build, dest_html, dest_downloads):
4378+ """Package docs from a Sphinx _build directory into target directories.
4379+
4380+ :param section: section in the website being built
4381+ :param src_build: the _build directory
4382+ :param dest_html: the directory where html should go
4383+ :param downloads: the directory where downloads should go
4384+ """
4385+ # Copy across the HTML. Explicitly delete the html destination
4386+ # directory first though because copytree insists on it not existing.
4387+ src_html = os.path.join(src_build, 'html')
4388+ if os.path.exists(dest_html):
4389+ rmtree(dest_html)
4390+ copytree(src_html, dest_html)
4391+
4392+ # Package the html as a downloadable archive
4393+ archive_root = "bzr-%s-html" % (section,)
4394+ archive_basename = "%s.tar.bz2" % (archive_root,)
4395+ archive_name = os.path.join(dest_downloads, archive_basename)
4396+ build_archive(src_html, archive_name, archive_root, 'bz2')
4397+
4398+ # Copy across the PDF docs, if any, including the quick ref card
4399+ pdf_files = []
4400+ quick_ref = os.path.join(src_html,
4401+ '_static/%s/bzr-%s-quick-reference.pdf' % (section, section))
4402+ if os.path.exists(quick_ref):
4403+ pdf_files.append(quick_ref)
4404+ src_pdf = os.path.join(src_build, 'latex')
4405+ if os.path.exists(src_pdf):
4406+ for name in os.listdir(src_pdf):
4407+ if name.endswith('.pdf'):
4408+ pdf_files.append(os.path.join(src_pdf, name))
4409+ if pdf_files:
4410+ dest_pdf = os.path.join(dest_downloads, 'pdf-%s' % (section,))
4411+ if not os.path.exists(dest_pdf):
4412+ os.mkdir(dest_pdf)
4413+ for pdf in pdf_files:
4414+ copy2(pdf, dest_pdf)
4415+
4416+ # TODO: copy across the CHM files, if any
4417+
4418+
4419+def build_archive(src_dir, archive_name, archive_root, format):
4420+ print "creating %s ..." % (archive_name,)
4421+ tar = tarfile.open(archive_name, "w:%s" % (format,))
4422+ for relpath in os.listdir(src_dir):
4423+ src_path = os.path.join(src_dir, relpath)
4424+ archive_path = os.path.join(archive_root, relpath)
4425+ tar.add(src_path, arcname=archive_path)
4426+ tar.close()
4427+
4428+
4429+def main(argv):
4430+ # Check usage. The first argument is the parent directory of
4431+ # the Sphinx _build directory. It will typically be 'doc/xx'.
4432+ # The second argument is the website build directory.
4433+ parser = OptionParser(usage="%prog SOURCE-DIR WEBSITE-BUILD-DIR")
4434+ (options, args) = parser.parse_args(argv)
4435+ if len(args) != 2:
4436+ parser.print_help()
4437+ sys.exit(1)
4438+
4439+ # Get the section - locale code or 'developers'
4440+ src_dir = args[0]
4441+ section = os.path.basename(src_dir)
4442+ src_build = os.path.join(src_dir, '_build')
4443+
4444+ # Create the destination directories if they doesn't exist.
4445+ dest_dir = args[1]
4446+ dest_html = os.path.join(dest_dir, section)
4447+ dest_downloads = os.path.join(dest_dir, 'downloads')
4448+ for d in [dest_dir, dest_downloads]:
4449+ if not os.path.exists(d):
4450+ print "creating directory %s ..." % (d,)
4451+ os.mkdir(d)
4452+
4453+ # Package and copy the files across
4454+ package_docs(section, src_build, dest_html, dest_downloads)
4455+
4456+
4457+if __name__ == '__main__':
4458+ main(sys.argv[1:])

Subscribers

People subscribed via source and target branches