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
=== modified file '.bzrignore'
--- .bzrignore 2009-07-31 19:56:19 +0000
+++ .bzrignore 2009-09-08 15:44:06 +0000
@@ -8,6 +8,9 @@
8bzr.18bzr.1
9./doc/*.html9./doc/*.html
10./doc/_build/10./doc/_build/
11./doc/*/_build/
12./doc/*/Makefile
13./doc/*/make.bat
11./tutorial.html14./tutorial.html
12BRANCH-INFO15BRANCH-INFO
13# setup.py working directory16# setup.py working directory
@@ -53,6 +56,7 @@
53bzrlib/_rio_pyx.c56bzrlib/_rio_pyx.c
54bzrlib/_walkdirs_win32.c57bzrlib/_walkdirs_win32.c
55doc/en/release-notes/NEWS.txt58doc/en/release-notes/NEWS.txt
59doc/en/release-notes/bzr*
56doc/en/developer-guide/HACKING.txt60doc/en/developer-guide/HACKING.txt
57doc/en/user-reference/bzr_man.txt61doc/en/user-reference/bzr_man.txt
58# built extension modules62# built extension modules
5963
=== modified file 'Makefile'
--- Makefile 2009-08-03 20:38:39 +0000
+++ Makefile 2009-09-08 15:40:44 +0000
@@ -1,4 +1,4 @@
1# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd1# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2#2#
3# This program is free software; you can redistribute it and/or modify3# This program is free software; you can redistribute it and/or modify
4# it under the terms of the GNU General Public License as published by4# it under the terms of the GNU General Public License as published by
@@ -77,102 +77,64 @@
77# these are treated as phony so they'll always be rebuilt - it's pretty quick77# these are treated as phony so they'll always be rebuilt - it's pretty quick
78.PHONY: TAGS tags78.PHONY: TAGS tags
7979
80
80### Documentation ###81### Documentation ###
8182
82# set PRETTY to get docs that look like the Bazaar web site83# Build the documentation. To keep the dependencies down to a minimum
83ifdef PRETTY84# for distro packagers, we only build the html documentation by default.
84rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid 85# Sphinx 0.6 or later is required. See http://sphinx.pocoo.org/index.html
85else86# for installation instructions.
86rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning87docs: html-docs
87endif88
8889# Clean out generated documentation
89# translate txt docs to html90clean-docs:
90derived_txt_files := \91 cd doc/en && make clean
91 doc/en/user-reference/bzr_man.txt \92 cd doc/es && make clean
92 doc/en/release-notes/NEWS.txt93 cd doc/ru && make clean
93txt_files := \94 cd doc/developers && make clean
94 doc/en/tutorials/tutorial.txt \95
95 doc/en/tutorials/using_bazaar_with_launchpad.txt \96DOC_DEPENDENCIES = doc/en/release-notes/NEWS.txt doc/en/user-reference/bzr_man.txt \
96 doc/en/tutorials/centralized_workflow.txt \97 doc/es/Makefile \
97 $(wildcard doc/ru/tutorials/*.txt) \98 doc/es/make.bat \
98 $(wildcard doc/*/mini-tutorial/index.txt) \99 doc/ru/Makefile \
99 $(wildcard doc/*/user-guide/index.txt) \100 doc/ru/make.bat \
100 $(derived_txt_files) \101 doc/developers/Makefile \
101 doc/en/developer-guide/HACKING.txt \102 doc/developers/make.bat
102 doc/en/upgrade-guide/index.txt \103
103 $(wildcard doc/es/guia-usario/*.txt) \104doc/%/Makefile: doc/en/Makefile
104 doc/es/mini-tutorial/index.txt \105 $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
105 doc/index.txt \106
106 $(wildcard doc/index.*.txt)107doc/%/make.bat: doc/en/make.bat
107non_txt_files := \108 $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
108 doc/default.css \109
109 $(wildcard doc/*/quick-reference/bzr-quick-reference.svg) \110# Build the html docs. Requires Sphinx 0.6 or later.
110 $(wildcard doc/*/quick-reference/bzr-quick-reference.png) \111html-docs: $(DOC_DEPENDENCIES)
111 $(wildcard doc/*/quick-reference/bzr-quick-reference.pdf) \112 cd doc/en && make html
112 $(wildcard doc/*/user-guide/images/*.png)113 cd doc/es && make html
113htm_files := $(patsubst %.txt, %.html, $(txt_files)) 114 cd doc/ru && make html
114115 cd doc/developers && make html
115# doc/developers/*.txt files that should *not* be individually116
116# converted to HTML117# Build the PDF docs. Requires Sphinx 0.6 or later and numerous LaTeX
117dev_txt_nohtml := \118# packages. See http://sphinx.pocoo.org/builders.html for details.
118 doc/developers/add.txt \119# Note: We don't currently build PDFs for the Russian docs because
119 doc/developers/annotate.txt \120# they require additional packages to be installed (to handle
120 doc/developers/bundle-creation.txt \121# Russian hyphenation rules, etc.)
121 doc/developers/commit.txt \122pdf-docs: $(DOC_DEPENDENCIES)
122 doc/developers/diff.txt \123 cd doc/en && make latex
123 doc/developers/directory-fingerprints.txt \124 cd doc/es && make latex
124 doc/developers/gc.txt \125 cd doc/developers && make latex
125 doc/developers/incremental-push-pull.txt \126 cd doc/en/_build/latex && make all-pdf
126 doc/developers/initial-push-pull.txt \127 cd doc/es/_build/latex && make all-pdf
127 doc/developers/merge-scaling.txt \128 cd doc/developers/_build/latex && make all-pdf
128 doc/developers/missing.txt \129
129 doc/developers/performance-roadmap-rationale.txt \130# Build the CHM (Windows Help) docs. Requires Sphinx 0.6 or later.
130 doc/developers/performance-use-case-analysis.txt \131# Note: HtmlHelp Workshop needs to be used on the generated hhp files
131 doc/developers/planned-change-integration.txt \132# to generate the final chm files.
132 doc/developers/planned-performance-changes.txt \133chm-docs: $(DOC_DEPENDENCIES)
133 doc/developers/revert.txt \134 cd doc/en && make htmlhelp
134 doc/developers/status.txt \135 cd doc/es && make htmlhelp
135 doc/developers/uncommit.txt136 cd doc/ru && make htmlhelp
136137 cd doc/developers && make htmlhelp
137dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
138dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
139dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
140
141doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide))
142 $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
143
144# Set the paper size for PDF files.
145# Options: 'a4' (ISO A4 size), 'letter' (US Letter size)
146PAPERSIZE = a4
147# TODO: Add generation for Russian PDF
148PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
149
150# Copy and modify the RST sources, and convert SVG images to PDF
151# files for use a images in the LaTeX-generated PDF.
152# Then generate the PDF output from the modified RST sources.
153doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
154 mkdir -p doc/en/user-guide/latex_prepared
155 $(PYTHON) tools/prepare_for_latex.py \
156 --out-dir=doc/en/user-guide/latex_prepared \
157 --in-dir=doc/en/user-guide
158 cd doc/en/user-guide/latex_prepared && \
159 $(PYTHON) ../../../../tools/rst2pdf.py \
160 --documentoptions=10pt,$(PAPERSIZE)paper \
161 --input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
162 --strict --title="Bazaar User Guide" \
163 index.txt ../user-guide.$(PAPERSIZE).pdf
164
165doc/developers/%.html: doc/developers/%.txt
166 $(rst2html) --stylesheet=../default.css $< $@
167
168doc/index.html: doc/index.txt
169 $(rst2html) --stylesheet=default.css $< $@
170
171doc/index.%.html: doc/index.%.txt
172 $(rst2html) --stylesheet=default.css $< $@
173
174%.html: %.txt
175 $(rst2html) --stylesheet=../../default.css $< $@
176138
177MAN_DEPENDENCIES = bzrlib/builtins.py \139MAN_DEPENDENCIES = bzrlib/builtins.py \
178 $(wildcard bzrlib/*.py) \140 $(wildcard bzrlib/*.py) \
@@ -183,46 +145,31 @@
183doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)145doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
184 $(PYTHON) tools/generate_docs.py -o $@ rstx146 $(PYTHON) tools/generate_docs.py -o $@ rstx
185147
186doc/en/release-notes/NEWS.txt: NEWS148doc/en/release-notes/NEWS.txt: NEWS tools/generate_release_notes.py
187 $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"149 $(PYTHON) tools/generate_release_notes.py NEWS $@
188150
189MAN_PAGES = man1/bzr.1151MAN_PAGES = man1/bzr.1
190man1/bzr.1: $(MAN_DEPENDENCIES)152man1/bzr.1: $(MAN_DEPENDENCIES)
191 $(PYTHON) tools/generate_docs.py -o $@ man153 $(PYTHON) tools/generate_docs.py -o $@ man
192154
193upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
194
195doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
196 $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
197
198# build a png of our performance task list155# build a png of our performance task list
199#
200# this is no longer built by default; you can build it if you want to look at it156# this is no longer built by default; you can build it if you want to look at it
201doc/developers/performance.png: doc/developers/performance.dot157doc/developers/performance.png: doc/developers/performance.dot
202 @echo Generating $@158 @echo Generating $@
203 @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"159 @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
204160
205derived_web_docs = $(htm_files) $(dev_htm_files) 161
206WEB_DOCS = $(derived_web_docs) $(non_txt_files)162### Documentation Website ###
207ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)163
208164# Where to build the website
209# the main target to build all the docs165DOC_WEBSITE_BUILD := html_docs
210docs: $(ALL_DOCS)166
211167# Build and package docs into a website, complete with downloads.
212# produce a tree containing just the final docs, ready for uploading to the web168doc-website: html-docs pdf-docs
213HTMLDIR := html_docs169 $(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
214html-docs: docs170 $(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
215 $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)171 $(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
216172 $(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
217# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
218pdf-docs: $(PDF_DOCS)
219
220# clean produced docs
221clean-docs:
222 $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
223 $(HTMLDIR) $(derived_txt_files)
224 rm -f doc/*/user-guide/*.pdf
225 rm -rf doc/*/user-guide/latex_prepared
226173
227174
228### Windows Support ###175### Windows Support ###
229176
=== modified file 'NEWS'
--- NEWS 2009-09-07 23:47:14 +0000
+++ NEWS 2009-09-08 01:46:53 +0000
@@ -3,9 +3,6 @@
3####################3####################
44
55
6.. contents:: List of Releases
7 :depth: 1
8
9bzr 2.0rc2 (not released yet)6bzr 2.0rc2 (not released yet)
10#############################7#############################
118
@@ -86,6 +83,14 @@
86* Help on hooks no longer says 'Not deprecated' for hooks that are83* Help on hooks no longer says 'Not deprecated' for hooks that are
87 currently supported. (Ian Clatworthy, #422415)84 currently supported. (Ian Clatworthy, #422415)
8885
86* PDF and CHM (Windows HtmlHelp) formats are now supported for the
87 user documentation. The HTML documentation is better broken up into
88 topics. (Ian Clatworthy)
89
90* The developer and foreign language documents are now separated
91 out so that searching in the HTML and CHM files produces more
92 useful results. (Ian Clatworthy)
93
89* The main table of contents now provides links to the new Migration Docs94* The main table of contents now provides links to the new Migration Docs
90 and Plugins Guide. (Ian Clatworthy)95 and Plugins Guide. (Ian Clatworthy)
9196
@@ -93,7 +98,6 @@
93bzr 2.0rc198bzr 2.0rc1
94##########99##########
95100
96
97:Codename: no worries101:Codename: no worries
98:2.0rc1: 2009-08-26102:2.0rc1: 2009-08-26
99103
@@ -558,8 +562,8 @@
558 ``countTestsCases``. (Robert Collins)562 ``countTestsCases``. (Robert Collins)
559563
560564
561bzr 1.17 "So late it's brunch" 2009-07-20565bzr 1.17
562#########################################566########
563:Codename: so-late-its-brunch567:Codename: so-late-its-brunch
564:1.17rc1: 2009-07-13568:1.17rc1: 2009-07-13
565:1.17: 2009-07-20569:1.17: 2009-07-20
@@ -808,8 +812,10 @@
808 this class and the UI. (Martin Pool)812 this class and the UI. (Martin Pool)
809813
810814
811bzr 1.16.1 2009-06-26815bzr 1.16.1
812#####################816##########
817
818:Released: 2009-06-26
813819
814End user testing of the 2a format revealed two serious bugs. The first,820End user testing of the 2a format revealed two serious bugs. The first,
815#365615, caused bzr to raise AbsentContentFactory errors when autopacking.821#365615, caused bzr to raise AbsentContentFactory errors when autopacking.
@@ -864,8 +870,8 @@
864 (Robert Collins, #376748)870 (Robert Collins, #376748)
865871
866872
867bzr 1.16 "It's yesterday in California" 2009-06-18873bzr 1.16
868##################################################874########
869:Codename: yesterday-in-california875:Codename: yesterday-in-california
870:1.16rc1: 2009-06-11876:1.16rc1: 2009-06-11
871:1.16: 2009-06-18877:1.16: 2009-06-18
@@ -2339,8 +2345,11 @@
2339 (Vincent Ladeuil)2345 (Vincent Ladeuil)
23402346
23412347
2342bzr 1.11 "Eyes up!" 2009-01-192348bzr 1.11
2343##############################2349########
2350
2351:Codename: "Eyes up!"
2352:Released: 2009-01-19
23442353
2345This first monthly release of Bazaar for 2009 improves Bazaar's operation2354This first monthly release of Bazaar for 2009 improves Bazaar's operation
2346in Windows, Mac OS X, and other situations where file names are matched2355in Windows, Mac OS X, and other situations where file names are matched
@@ -2366,8 +2375,11 @@
23662375
23672376
23682377
2369bzr 1.11rc1 "Eyes up!" 2009-01-092378bzr 1.11rc1
2370#################################2379###########
2380
2381:Codename: "Eyes up!"
2382:Released: 2009-01-09
23712383
2372Changes2384Changes
2373*******2385*******
@@ -2603,8 +2615,10 @@
26032615
26042616
26052617
2606bzr 1.10 2008-12-052618bzr 1.10
2607###################2619########
2620
2621:Released: 2008-12-05
26082622
2609Bazaar 1.10 has several performance improvements for copying revisions2623Bazaar 1.10 has several performance improvements for copying revisions
2610(especially for small updates to large projects). There has also been a2624(especially for small updates to large projects). There has also been a
@@ -2629,8 +2643,10 @@
2629 topologically. (John Arbash Meinel, #304841)2643 topologically. (John Arbash Meinel, #304841)
26302644
26312645
2632bzr 1.10rc1 2008-11-282646bzr 1.10rc1
2633######################2647###########
2648
2649:Released: 2008-11-28
26342650
2635This release of Bazaar focuses on performance improvements when pushing2651This release of Bazaar focuses on performance improvements when pushing
2636and pulling revisions, both locally and to remote networks. The popular2652and pulling revisions, both locally and to remote networks. The popular
@@ -2750,8 +2766,10 @@
2750* Doctests now only report the first failure. (Martin Pool)2766* Doctests now only report the first failure. (Martin Pool)
27512767
27522768
2753bzr 1.9 2008-11-072769bzr 1.9
2754##################2770#######
2771
2772:Released: 2008-11-07
27552773
2756This release of Bazaar adds a new repository format, ``1.9``, with smaller2774This release of Bazaar adds a new repository format, ``1.9``, with smaller
2757and more efficient index files. This format can be specified when2775and more efficient index files. This format can be specified when
@@ -2773,8 +2791,10 @@
2773 (John Arbash Meinel, #293746)2791 (John Arbash Meinel, #293746)
27742792
27752793
2776bzr 1.9rc1 2008-10-312794bzr 1.9rc1
2777#####################2795##########
2796
2797:Released: 2008-10-31
27782798
2779New Features2799New Features
2780************2800************
@@ -2891,8 +2911,10 @@
2891 configuration of authetication credentials.2911 configuration of authetication credentials.
28922912
28932913
2894bzr 1.8 2008-10-162914bzr 1.8
2895##################2915#######
2916
2917:Released: 2008-10-16
28962918
2897Bazaar 1.8 includes several fixes that improve working tree performance,2919Bazaar 1.8 includes several fixes that improve working tree performance,
2898display of revision logs, and merges. The bzr testsuite now passes on OS2920display of revision logs, and merges. The bzr testsuite now passes on OS
@@ -2913,8 +2935,10 @@
2913 that platform. (Alexander Belchenko, Martin Pool, #277481)2935 that platform. (Alexander Belchenko, Martin Pool, #277481)
29142936
29152937
2916bzr 1.8rc1 2008-10-072938bzr 1.8rc1
2917#####################2939##########
2940
2941:Released: 2008-10-07
29182942
2919Changes2943Changes
2920*******2944*******
@@ -3112,14 +3136,18 @@
3112 (Vincent Ladeuil)3136 (Vincent Ladeuil)
31133137
31143138
3115bzr 1.7.1 2008-10-013139bzr 1.7.1
3116####################3140#########
3141
3142:Released: 2008-10-01
31173143
3118No changes from 1.7.1rc1.3144No changes from 1.7.1rc1.
31193145
31203146
3121bzr 1.7.1rc1 2008-09-243147bzr 1.7.1rc1
3122#######################3148############
3149
3150:Released: 2008-09-24
31233151
3124This release just includes an update to how the merge algorithm handles3152This release just includes an update to how the merge algorithm handles
3125file paths when we encounter complex history.3153file paths when we encounter complex history.
@@ -3134,8 +3162,10 @@
3134 (John Arbash Meinel)3162 (John Arbash Meinel)
31353163
31363164
3137bzr 1.7 2008-09-233165bzr 1.7
3138##################3166#######
3167
3168:Released: 2008-09-23
31393169
3140This release includes many bug fixes and a few performance and feature3170This release includes many bug fixes and a few performance and feature
3141improvements. ``bzr rm`` will now scan for missing files and remove them,3171improvements. ``bzr rm`` will now scan for missing files and remove them,
@@ -3152,8 +3182,10 @@
3152 packaging qbzr. (Mark Hammond)3182 packaging qbzr. (Mark Hammond)
31533183
31543184
3155bzr 1.7rc2 2008-09-173185bzr 1.7rc2
3156#####################3186##########
3187
3188:Released: 2008-09-17
31573189
3158A few bug fixes from 1.7rc1. The biggest change is a new3190A few bug fixes from 1.7rc1. The biggest change is a new
3159``RemoteBranch.get_stacked_on_url`` rpc. This allows clients that are3191``RemoteBranch.get_stacked_on_url`` rpc. This allows clients that are
@@ -3177,8 +3209,10 @@
3177 (Andrew Bennetts)3209 (Andrew Bennetts)
31783210
31793211
3180bzr 1.7rc1 2008-09-093212bzr 1.7rc1
3181#####################3213##########
3214
3215:Released: 2008-09-09
31823216
3183This release candidate for bzr 1.7 has several bug fixes and a few3217This release candidate for bzr 1.7 has several bug fixes and a few
3184performance and feature improvements. ``bzr rm`` will now scan for3218performance and feature improvements. ``bzr rm`` will now scan for
@@ -3375,16 +3409,20 @@
3375 clients now use this mechanism. (Neil Martinsen-Burrell)3409 clients now use this mechanism. (Neil Martinsen-Burrell)
33763410
33773411
3378bzr 1.6.1 2008-09-053412bzr 1.6.1
3379####################3413#########
3414
3415:Released: 2008-09-05
33803416
3381A couple regressions were found in the 1.6 release. There was a3417A couple regressions were found in the 1.6 release. There was a
3382performance issue when using ``bzr+ssh`` to branch large repositories,3418performance issue when using ``bzr+ssh`` to branch large repositories,
3383and some problems with stacking and ``rich-root`` capable repositories.3419and some problems with stacking and ``rich-root`` capable repositories.
33843420
33853421
3386bzr 1.6.1rc2 2008-09-033422bzr 1.6.1rc2
3387#######################3423############
3424
3425:Released: 2008-09-03
33883426
3389Bug Fixes3427Bug Fixes
3390*********3428*********
@@ -3395,8 +3433,10 @@
3395 (John Arbash Meinel, #264321)3433 (John Arbash Meinel, #264321)
33963434
33973435
3398bzr 1.6.1rc1 2008-08-293436bzr 1.6.1rc1
3399#######################3437############
3438
3439:Released: 2008-08-29
34003440
3401This release fixes a few regressions found in the 1.6 client. Fetching3441This release fixes a few regressions found in the 1.6 client. Fetching
3402changes was using an O(N^2) buffering algorithm, so for large projects it3442changes was using an O(N^2) buffering algorithm, so for large projects it
@@ -3436,8 +3476,10 @@
3436 (John Arbash Meinel, #262333)3476 (John Arbash Meinel, #262333)
34373477
34383478
3439bzr 1.6 2008-08-253479bzr 1.6
3440##################3480#######
3481
3482:Released: 2008-08-25
34413483
3442Finally, the long awaited bzr 1.6 has been released. This release includes3484Finally, the long awaited bzr 1.6 has been released. This release includes
3443new features like Stacked Branches, improved weave merge, and an updated3485new features like Stacked Branches, improved weave merge, and an updated
@@ -3450,8 +3492,10 @@
3450TortoiseBzr in the standalone Windows installer.3492TortoiseBzr in the standalone Windows installer.
34513493
34523494
3453bzr 1.6rc5 2008-08-193495bzr 1.6rc5
3454#####################3496##########
3497
3498:Released: 2008-08-19
34553499
3456Bug Fixes3500Bug Fixes
3457*********3501*********
@@ -3463,8 +3507,10 @@
3463 (This change was reverted when merged to bzr.dev)3507 (This change was reverted when merged to bzr.dev)
34643508
34653509
3466bzr 1.6rc4 2008-08-183510bzr 1.6rc4
3467#####################3511##########
3512
3513:Released: 2008-08-18
34683514
3469Bug Fixes3515Bug Fixes
3470*********3516*********
@@ -3474,8 +3520,10 @@
3474 rather than preserving deltas. (John Arbash Meinel, #256757)3520 rather than preserving deltas. (John Arbash Meinel, #256757)
34753521
34763522
3477bzr 1.6rc3 2008-08-143523bzr 1.6rc3
3478#####################3524##########
3525
3526:Released: 2008-08-14
34793527
3480Changes3528Changes
3481*******3529*******
@@ -3508,8 +3556,10 @@
3508 development which is substantially faster. (Robert Collins)3556 development which is substantially faster. (Robert Collins)
35093557
35103558
3511bzr 1.6rc2 2008-08-133559bzr 1.6rc2
3512#####################3560##########
3561
3562:Released: 2008-08-13
35133563
3514This release candidate has a few minor bug fixes, and some regression3564This release candidate has a few minor bug fixes, and some regression
3515fixes for Windows.3565fixes for Windows.
@@ -3547,8 +3597,10 @@
3547 will get the same results. (John Arbash Meinel, #232188)3597 will get the same results. (John Arbash Meinel, #232188)
35483598
35493599
3550bzr 1.6rc1 2008-08-063600bzr 1.6rc1
3551#####################3601##########
3602
3603:Released: 2008-08-06
35523604
3553This release candidate for bzr 1.6 solidifies the new branch stacking3605This release candidate for bzr 1.6 solidifies the new branch stacking
3554feature. Bazaar now recommends that users upgrade all knit repositories,3606feature. Bazaar now recommends that users upgrade all knit repositories,
@@ -3684,8 +3736,10 @@
3684 (Ian Clatworthy)3736 (Ian Clatworthy)
36853737
36863738
3687bzr 1.6beta3 2008-07-173739bzr 1.6beta3
3688#######################3740############
3741
3742:Released: 2008-07-17
36893743
3690This release adds a new 'stacked branches' feature allowing branches to3744This release adds a new 'stacked branches' feature allowing branches to
3691share storage without being in the same repository or on the same machine.3745share storage without being in the same repository or on the same machine.
@@ -3857,8 +3911,10 @@
3857 (Robert Collins)3911 (Robert Collins)
38583912
38593913
3860bzr 1.6beta2 2008-06-103914bzr 1.6beta2
3861#######################3915############
3916
3917:Released: 2008-06-10
38623918
3863This release contains further progress towards our 1.6 goals of shallow3919This release contains further progress towards our 1.6 goals of shallow
3864repositories, and contains a fix for some user-affecting bugs in the3920repositories, and contains a fix for some user-affecting bugs in the
@@ -3941,9 +3997,10 @@
3941* Knit record serialisation is now stricter on what it will accept, to3997* Knit record serialisation is now stricter on what it will accept, to
3942 guard against potential internal bugs, or broken input. (Robert Collins)3998 guard against potential internal bugs, or broken input. (Robert Collins)
39433999
3944bzr 1.6beta1 2008-06-024000bzr 1.6beta1
3945#######################4001############
39464002
4003:Released: 2008-06-02
39474004
3948Commands that work on the revision history such as push, pull, missing,4005Commands that work on the revision history such as push, pull, missing,
3949uncommit and log are now substantially faster. This release adds a4006uncommit and log are now substantially faster. This release adds a
@@ -4161,8 +4218,10 @@
4161 (Martin Pool)4218 (Martin Pool)
41624219
41634220
4164bzr 1.5 2008-05-164221bzr 1.5
4165##################4222#######
4223
4224:Released: 2008-05-16
41664225
4167This release of Bazaar includes several updates to the documentation, and fixes4226This release of Bazaar includes several updates to the documentation, and fixes
4168to prepare for making rich root support the default format. Many bugs have been4227to prepare for making rich root support the default format. Many bugs have been
@@ -4183,8 +4242,10 @@
4183 (Ian Clatworthy)4242 (Ian Clatworthy)
41844243
41854244
4186bzr 1.5rc1 2008-05-094245bzr 1.5rc1
4187#####################4246##########
4247
4248:Released: 2008-05-09
41884249
4189Changes4250Changes
4190*******4251*******
@@ -4354,8 +4415,10 @@
4354 (Martin Pool)4415 (Martin Pool)
43554416
43564417
4357bzr 1.4 2008-04-284418bzr 1.4
4358##################4419#######
4420
4421:Released: 2008-04-28
43594422
4360This release of Bazaar includes handy improvements to the speed of log and4423This release of Bazaar includes handy improvements to the speed of log and
4361status, new options for several commands, improved documentation, and better4424status, new options for several commands, improved documentation, and better
@@ -4374,8 +4437,10 @@
4374 (John Arbash Meinel, Andrew Bennetts, #214894)4437 (John Arbash Meinel, Andrew Bennetts, #214894)
43754438
43764439
4377bzr 1.4rc2 2008-04-214440bzr 1.4rc2
4378#####################4441##########
4442
4443:Released: 2008-04-21
43794444
4380Bug Fixes4445Bug Fixes
4381*********4446*********
@@ -4398,8 +4463,10 @@
4398 (Robert Collins, John Arbash Meinel)4463 (Robert Collins, John Arbash Meinel)
43994464
44004465
4401bzr 1.4rc1 2008-04-114466bzr 1.4rc1
4402#####################4467##########
4468
4469:Released: 2008-04-11
44034470
4404Changes4471Changes
4405*******4472*******
@@ -4686,14 +4753,18 @@
4686 ``Graph.get_parent_map`` returns a dict of key:parents. (Robert Collins)4753 ``Graph.get_parent_map`` returns a dict of key:parents. (Robert Collins)
46874754
46884755
4689bzr 1.3.1 2008-04-094756bzr 1.3.1
4690####################4757#########
4758
4759:Released: 2008-04-09
46914760
4692No changes from 1.3.1rc1.4761No changes from 1.3.1rc1.
46934762
46944763
4695bzr 1.3.1rc1 2008-04-044764bzr 1.3.1rc1
4696#######################4765############
4766
4767:Released: 2008-04-04
46974768
4698Bug Fixes4769Bug Fixes
4699*********4770*********
@@ -4704,8 +4775,10 @@
4704 (#208418, Andrew Bennetts, Martin Pool, Robert Collins)4775 (#208418, Andrew Bennetts, Martin Pool, Robert Collins)
47054776
47064777
4707bzr 1.3 2008-03-204778bzr 1.3
4708##################4779#######
4780
4781:Released: 2008-03-20
47094782
4710Bazaar has become part of the GNU project <http://www.gnu.org>4783Bazaar has become part of the GNU project <http://www.gnu.org>
47114784
@@ -4721,8 +4794,10 @@
4721 (#202778, Martin Pool)4794 (#202778, Martin Pool)
47224795
47234796
4724bzr 1.3rc1 2008-03-164797bzr 1.3rc1
4725#####################4798##########
4799
4800:Released: 2008-03-16
47264801
4727Notes When Upgrading4802Notes When Upgrading
4728********************4803********************
@@ -4908,8 +4983,10 @@
4908 format. (Robert Collins)4983 format. (Robert Collins)
49094984
49104985
4911bzr 1.2 2008-02-154986bzr 1.2
4912##################4987#######
4988
4989:Released: 2008-02-15
49134990
4914Bug Fixes4991Bug Fixes
4915*********4992*********
@@ -4917,8 +4994,10 @@
4917* Fix failing test in Launchpad plugin. (Martin Pool)4994* Fix failing test in Launchpad plugin. (Martin Pool)
49184995
49194996
4920bzr 1.2rc1 2008-02-134997bzr 1.2rc1
4921#####################4998##########
4999
5000:Released: 2008-02-13
49225001
4923Notes When Upgrading5002Notes When Upgrading
4924********************5003********************
@@ -5119,13 +5198,17 @@
5119 revision names etc. (Robert Collins)5198 revision names etc. (Robert Collins)
51205199
51215200
5122bzr 1.1 2008-01-155201bzr 1.1
5123##################5202#######
5203
5204:Released: 2008-01-15
51245205
5125(no changes from 1.1rc1)5206(no changes from 1.1rc1)
51265207
5127bzr 1.1rc1 2008-01-055208bzr 1.1rc1
5128#####################5209##########
5210
5211:Released: 2008-01-05
51295212
5130Changes5213Changes
5131*******5214*******
@@ -5335,8 +5418,10 @@
5335 replaced by the new helper methods added in this release. (Robert Collins)5418 replaced by the new helper methods added in this release. (Robert Collins)
53365419
53375420
5338bzr 1.0 2007-12-145421bzr 1.0
5339##################5422#######
5423
5424:Released: 2007-12-14
53405425
5341Documentation5426Documentation
5342*************5427*************
@@ -5353,8 +5438,10 @@
5353 (Ian Clatworthy)5438 (Ian Clatworthy)
53545439
53555440
5356bzr 1.0rc3 2007-12-115441bzr 1.0rc3
5357#####################5442##########
5443
5444:Released: 2007-12-11
53585445
5359Changes5446Changes
5360*******5447*******
@@ -5395,8 +5482,10 @@
5395 (Vincent Ladeuil)5482 (Vincent Ladeuil)
53965483
53975484
5398bzr 1.0rc2 2007-12-075485bzr 1.0rc2
5399#####################5486##########
5487
5488:Released: 2007-12-07
54005489
5401Improvements5490Improvements
5402************5491************
@@ -5470,8 +5559,10 @@
5470 ``started`` methods. (Matt Nordhoff)5559 ``started`` methods. (Matt Nordhoff)
54715560
54725561
5473bzr 1.0rc1 2007-11-305562bzr 1.0rc1
5474#####################5563##########
5564
5565:Released: 2007-11-30
54755566
5476Notes When Upgrading5567Notes When Upgrading
5477********************5568********************
@@ -5747,8 +5838,10 @@
5747* InventoryEntry.diff is now deprecated. Please use diff.DiffTree instead.5838* InventoryEntry.diff is now deprecated. Please use diff.DiffTree instead.
57485839
57495840
5750bzr 0.92 2007-11-055841bzr 0.92
5751###################5842########
5843
5844:Released: 2007-11-05
57525845
5753Changes5846Changes
5754*******5847*******
@@ -5756,8 +5849,10 @@
5756 * New uninstaller on Win32. (Alexander Belchenko)5849 * New uninstaller on Win32. (Alexander Belchenko)
57575850
57585851
5759bzr 0.92rc1 2007-10-295852bzr 0.92rc1
5760######################5853###########
5854
5855:Released: 2007-10-29
57615856
5762Changes5857Changes
5763*******5858*******
@@ -6076,8 +6171,10 @@
6076 raises a Python warning. (Martin Pool)6171 raises a Python warning. (Martin Pool)
60776172
60786173
6079bzr 0.91 2007-09-266174bzr 0.91
6080###################6175########
6176
6177:Released: 2007-09-26
60816178
6082Bug Fixes6179Bug Fixes
6083*********6180*********
@@ -6098,15 +6195,19 @@
6098 (Andrew Bennetts)6195 (Andrew Bennetts)
60996196
61006197
6101bzr 0.91rc2 2007-09-116198bzr 0.91rc2
6102######################6199###########
6200
6201:Released: 2007-09-11
61036202
6104* Replaced incorrect tarball for previous release; a debug statement was left6203* Replaced incorrect tarball for previous release; a debug statement was left
6105 in bzrlib/remote.py.6204 in bzrlib/remote.py.
61066205
61076206
6108bzr 0.91rc1 2007-09-116207bzr 0.91rc1
6109######################6208###########
6209
6210:Released: 2007-09-11
61106211
6111Changes6212Changes
6112*******6213*******
@@ -6433,8 +6534,10 @@
6433 [] to revert all files is deprecated. (Aaron Bentley)6534 [] to revert all files is deprecated. (Aaron Bentley)
64346535
64356536
6436bzr 0.90 2007-08-286537bzr 0.90
6437###################6538########
6539
6540:Released: 2007-08-28
64386541
6439Improvements6542Improvements
6440************6543************
@@ -6457,8 +6560,10 @@
6457 and call ``create_repository`` on that. (Martin Pool)6560 and call ``create_repository`` on that. (Martin Pool)
64586561
64596562
6460bzr 0.90rc1 2007-08-146563bzr 0.90rc1
6461######################6564###########
6565
6566:Released: 2007-08-14
64626567
6463Bugfixes6568Bugfixes
6464********6569********
@@ -6730,8 +6835,10 @@
6730 parameter. Varargs-style parameters are deprecated. (Aaron Bentley)6835 parameter. Varargs-style parameters are deprecated. (Aaron Bentley)
67316836
67326837
6733bzr 0.18 2007-07-176838bzr 0.18
6734####################6839########
6840
6841:Released: 2007-07-17
67356842
6736Bugfixes6843Bugfixes
6737********6844********
@@ -6739,8 +6846,10 @@
6739* Fix 'bzr add' crash under Win32 (Kuno Meyer)6846* Fix 'bzr add' crash under Win32 (Kuno Meyer)
67406847
67416848
6742bzr 0.18rc1 2007-07-106849bzr 0.18rc1
6743#######################6850###########
6851
6852:Released: 2007-07-10
67446853
6745Bugfixes6854Bugfixes
6746********6855********
@@ -6991,8 +7100,10 @@
6991 (Vincent Ladeuil, #110448)7100 (Vincent Ladeuil, #110448)
69927101
69937102
6994bzr 0.17 2007-06-187103bzr 0.17
6995####################7104########
7105
7106:Released: 2007-06-18
69967107
6997Bugfixes7108Bugfixes
6998********7109********
@@ -7004,8 +7115,10 @@
7004 (Aaron Bentley, Ian Clatworthy, #120930)7115 (Aaron Bentley, Ian Clatworthy, #120930)
70057116
70067117
7007bzr 0.17rc1 2007-06-127118bzr 0.17rc1
7008#######################7119###########
7120
7121:Released: 2007-06-12
70097122
7010Notes When Upgrading7123Notes When Upgrading
7011********************7124********************
@@ -7106,8 +7219,10 @@
7106 your repository. (Previously Branch6 only supported revisions in your7219 your repository. (Previously Branch6 only supported revisions in your
7107 mainline). (John Arbash Meinel, #115343)7220 mainline). (John Arbash Meinel, #115343)
71087221
7109bzr 0.16 2007-05-077222bzr 0.16
7110####################7223########
7224
7225:Released: 2007-05-07
71117226
7112Bugfixes7227Bugfixes
7113********7228********
@@ -7137,8 +7252,10 @@
7137 diff`` and ``bzr status`` significantly improving the speed of7252 diff`` and ``bzr status`` significantly improving the speed of
7138 both. (John Arbash Meinel)7253 both. (John Arbash Meinel)
71397254
7140bzr 0.16rc2 2007-04-307255bzr 0.16rc2
7141#######################7256###########
7257
7258:Released: 2007-04-30
71427259
7143Bugfixes7260Bugfixes
7144********7261********
@@ -7161,8 +7278,10 @@
7161* ``WorkingTree4._iter_changes`` should not descend into unversioned7278* ``WorkingTree4._iter_changes`` should not descend into unversioned
7162 directories. (John Arbash Meinel, #110399)7279 directories. (John Arbash Meinel, #110399)
71637280
7164bzr 0.16rc1 2007-04-267281bzr 0.16rc1
7165#######################7282###########
7283
7284:Released: 2007-04-26
71667285
7167Notes When Upgrading7286Notes When Upgrading
7168********************7287********************
@@ -7469,8 +7588,10 @@
7469 implementation of new auth schemes for both http and proxy.7588 implementation of new auth schemes for both http and proxy.
7470 (Vincent Ladeuil)7589 (Vincent Ladeuil)
74717590
7472bzr 0.15 2007-04-017591bzr 0.15
7473###################7592########
7593
7594:Released: 2007-04-01
74747595
7475Bugfixes7596Bugfixes
7476********7597********
@@ -7482,8 +7603,10 @@
7482 checking out a branch that contains an old-format working tree.7603 checking out a branch that contains an old-format working tree.
7483 (Martin Pool)7604 (Martin Pool)
74847605
7485bzr 0.15rc3 2007-03-267606bzr 0.15rc3
7486#######################7607###########
7608
7609:Released: 2007-03-26
74877610
7488Changes7611Changes
7489*******7612*******
@@ -7558,8 +7681,10 @@
7558* Correctly handles mutiple permanent http redirections.7681* Correctly handles mutiple permanent http redirections.
7559 (vila, #88780)7682 (vila, #88780)
75607683
7561bzr 0.15rc2 2007-03-147684bzr 0.15rc2
7562#######################7685###########
7686
7687:Released: 2007-03-14
75637688
7564Notes When Upgrading7689Notes When Upgrading
7565********************7690********************
@@ -7612,8 +7737,10 @@
7612 (Wouter van Heyst, #53483)7737 (Wouter van Heyst, #53483)
76137738
76147739
7615bzr 0.15rc1 2007-03-077740bzr 0.15rc1
7616#######################7741###########
7742
7743:Released: 2007-03-07
76177744
7618Surprises7745Surprises
7619*********7746*********
@@ -7843,8 +7970,10 @@
7843 before the rest of the suite. (Martin Pool)7970 before the rest of the suite. (Martin Pool)
78447971
78457972
7846bzr 0.14 2007-01-237973bzr 0.14
7847####################7974########
7975
7976:Released: 2007-01-23
78487977
7849Improvements7978Improvements
7850************7979************
@@ -7863,8 +7992,10 @@
7863 it is in is below a repository. (James Westby, #77306)7992 it is in is below a repository. (James Westby, #77306)
78647993
78657994
7866bzr 0.14rc1 2007-01-167995bzr 0.14rc1
7867#######################7996###########
7997
7998:Released: 2007-01-16
78687999
7869Improvements8000Improvements
7870************8001************
@@ -7998,14 +8129,18 @@
7998 (Alexander Belchenko, #68124)8129 (Alexander Belchenko, #68124)
79998130
80008131
8001bzr 0.13 2006-12-058132bzr 0.13
8002####################8133########
8134
8135:Released: 2006-12-05
80038136
8004No changes from 0.13rc8137No changes from 0.13rc
80058138
80068139
8007bzr 0.13rc1 2006-11-278140bzr 0.13rc1
8008#######################8141###########
8142
8143:Released: 2006-11-27
80098144
8010Improvements8145Improvements
8011************8146************
@@ -8130,8 +8265,10 @@
8130* TestingHTTPRequestHandler really handles the Range header8265* TestingHTTPRequestHandler really handles the Range header
8131 (previously it was ignoring it and returning the whole file,).8266 (previously it was ignoring it and returning the whole file,).
81328267
8133bzr 0.12 2006-10-308268bzr 0.12
8134####################8269########
8270
8271:Released: 2006-10-30
81358272
8136Internals8273Internals
8137*********8274*********
@@ -8140,8 +8277,10 @@
8140 and remove benchmarks that take longer than 10min to run.8277 and remove benchmarks that take longer than 10min to run.
8141 (John Arbash Meinel)8278 (John Arbash Meinel)
81428279
8143bzr 0.12rc1 2006-10-238280bzr 0.12rc1
8144#######################8281###########
8282
8283:Released: 2006-10-23
81458284
8146Improvements8285Improvements
8147************8286************
@@ -8262,13 +8401,17 @@
8262 option to set the BzrDir, Repository and Branch formats of the8401 option to set the BzrDir, Repository and Branch formats of the
8263 created objects. (Robert Collins, John Arbash Meinel)8402 created objects. (Robert Collins, John Arbash Meinel)
82648403
8265bzr 0.11 2006-10-028404bzr 0.11
8266####################8405########
8406
8407:Released: 2006-10-02
82678408
8268* Smart server transport test failures on windows fixed. (Lukáš Lalinský).8409* Smart server transport test failures on windows fixed. (Lukáš Lalinský).
82698410
8270bzr 0.11rc2 2006-09-278411bzr 0.11rc2
8271#######################8412###########
8413
8414:Released: 2006-09-27
82728415
8273Bug Fixes8416Bug Fixes
8274*********8417*********
@@ -8278,8 +8421,10 @@
8278* Commit performance regression fixed. (Aaron Bentley, Robert Collins, John8421* Commit performance regression fixed. (Aaron Bentley, Robert Collins, John
8279 Arbash Meinel).8422 Arbash Meinel).
82808423
8281bzr 0.11rc1 2006-09-258424bzr 0.11rc1
8282#######################8425###########
8426
8427:Released: 2006-09-25
82838428
8284Improvements8429Improvements
8285************8430************
@@ -8472,8 +8617,10 @@
8472 allow upgrades to a richer interface than the VFS one provided by8617 allow upgrades to a richer interface than the VFS one provided by
8473 Transport. (Andrew Bennetts, Martin Pool)8618 Transport. (Andrew Bennetts, Martin Pool)
84748619
8475bzr 0.10 2006-08-298620bzr 0.10
8476####################8621########
8622
8623:Released: 2006-08-29
84778624
8478Improvements8625Improvements
8479************8626************
@@ -8550,8 +8697,10 @@
8550 need to be installed. This should help make the life of packagers8697 need to be installed. This should help make the life of packagers
8551 easier. (John Arbash Meinel)8698 easier. (John Arbash Meinel)
85528699
8553bzr 0.9.0 2006-08-118700bzr 0.9.0
8554#####################8701#########
8702
8703:Released: 2006-08-11
85558704
8556Surprises8705Surprises
8557*********8706*********
@@ -8818,16 +8967,20 @@
88188967
8819* "RevisionTree" is now in bzrlib/revisiontree.py. (Robert Collins)8968* "RevisionTree" is now in bzrlib/revisiontree.py. (Robert Collins)
88208969
8821bzr 0.8.2 2006-05-178970bzr 0.8.2
8822#####################8971#########
8972
8973:Released: 2006-05-17
88238974
8824Bug Fixes8975Bug Fixes
8825*********8976*********
88268977
8827* setup.py failed to install launchpad plugin. (Martin Pool)8978* setup.py failed to install launchpad plugin. (Martin Pool)
88288979
8829bzr 0.8.1 2006-05-168980bzr 0.8.1
8830#####################8981#########
8982
8983:Released: 2006-05-16
88318984
8832Bug Fixes8985Bug Fixes
8833*********8986*********
@@ -8880,8 +9033,10 @@
8880* Fix test case for bzr info in upgrading a standalone branch to metadir,9033* Fix test case for bzr info in upgrading a standalone branch to metadir,
8881 uses bzrlib api now. (Olaf Conradi)9034 uses bzrlib api now. (Olaf Conradi)
88829035
8883bzr 0.8 2006-05-089036bzr 0.8
8884###################9037#######
9038
9039:Released: 2006-05-08
88859040
8886Notes When Upgrading9041Notes When Upgrading
8887********************9042********************
@@ -9142,8 +9297,10 @@
9142* ``run_bzr`` and ``run_bzr_captured`` now accept a 'stdin="foo"'9297* ``run_bzr`` and ``run_bzr_captured`` now accept a 'stdin="foo"'
9143 parameter which will provide String("foo") to the command as its stdin.9298 parameter which will provide String("foo") to the command as its stdin.
91449299
9145bzr 0.7 2006-01-099300bzr 0.7
9146##################9301#######
9302
9303:Released: 2006-01-09
91479304
9148Changes9305Changes
9149*******9306*******
@@ -9438,8 +9595,10 @@
9438* ``bzrlib.osutils.safe_unicode`` now exists to provide parameter coercion9595* ``bzrlib.osutils.safe_unicode`` now exists to provide parameter coercion
9439 for functions that need unicode strings. (Robert Collins)9596 for functions that need unicode strings. (Robert Collins)
94409597
9441bzr 0.6 2005-10-289598bzr 0.6
9442##################9599#######
9600
9601:Released: 2005-10-28
94439602
9444Improvements9603Improvements
9445************9604************
@@ -9654,8 +9813,10 @@
9654 [-1] in the revision-history. (Andres Salomon)9813 [-1] in the revision-history. (Andres Salomon)
96559814
96569815
9657bzr 0.1.1 2005-10-129816bzr 0.1.1
9658####################9817#########
9818
9819:Released: 2005-10-12
96599820
9660Bug Fixes9821Bug Fixes
9661*********9822*********
@@ -9672,8 +9833,10 @@
9672* Avoid some unnecessary http operations in branch and pull.9833* Avoid some unnecessary http operations in branch and pull.
96739834
96749835
9675bzr 0.1 2005-10-119836bzr 0.1
9676##################9837#######
9838
9839:Released: 2005-10-11
96779840
9678Notes9841Notes
9679*****9842*****
@@ -9802,8 +9965,10 @@
9802 of tests to run, e.g. ``bzr selftest test_weave``9965 of tests to run, e.g. ``bzr selftest test_weave``
98039966
98049967
9805bzr 0.0.9 2005-09-239968bzr 0.0.9
9806####################9969#########
9970
9971:Released: 2005-09-23
98079972
9808Bug Fixes9973Bug Fixes
9809*********9974*********
@@ -9844,8 +10009,11 @@
9844 another (used by pull, merged, etc.)10009 another (used by pull, merged, etc.)
984510010
984610011
9847bzr 0.0.8 2005-09-2010012bzr 0.0.8
9848####################10013#########
10014
10015:Released: 2005-09-20
10016
984910017
9850Improvements10018Improvements
9851************10019************
@@ -9895,8 +10063,10 @@
9895* Quieten warnings about locking; patch from Matt Lavin.10063* Quieten warnings about locking; patch from Matt Lavin.
989610064
989710065
9898bzr-0.0.7 2005-09-0210066bzr-0.0.7
9899####################10067#########
10068
10069:Released: 2005-09-02
990010070
9901New Features10071New Features
9902************10072************
@@ -9950,8 +10120,10 @@
995010120
995110121
995210122
9953bzr-0.0.6 2005-08-1810123bzr-0.0.6
9954####################10124#########
10125
10126:Released: 2005-08-18
995510127
9956New Features10128New Features
9957************10129************
@@ -10036,8 +10208,10 @@
10036* Fix bugs in committing only selected files or within a subdirectory.10208* Fix bugs in committing only selected files or within a subdirectory.
1003710209
1003810210
10039bzr-0.0.5 2005-06-1510211bzr-0.0.5
10040#####################10212#########
10213
10214:Released: 2005-06-15
1004110215
10042Changes10216Changes
10043*******10217*******
@@ -10178,8 +10352,10 @@
10178 2.4 is now only recommended.10352 2.4 is now only recommended.
1017910353
1018010354
10181bzr-0.0.4 2005-04-2210355bzr-0.0.4
10182#####################10356#########
10357
10358:Released: 2005-04-22
1018310359
10184Enhancements10360Enhancements
10185************10361************
@@ -10247,8 +10423,10 @@
10247 from QuantumG.10423 from QuantumG.
1024810424
1024910425
10250bzr-0.0.3 2005-04-0610426bzr-0.0.3
10251#####################10427#########
10428
10429:Released: 2005-04-06
1025210430
10253Enhancements10431Enhancements
10254************10432************
@@ -10302,8 +10480,11 @@
10302* Win32 fixes from Steve Brown.10480* Win32 fixes from Steve Brown.
1030310481
1030410482
10305bzr-0.0.2 "black cube" 2005-03-3110483bzr-0.0.2
10306###################################10484#########
10485
10486:Codename: "black cube"
10487:Released: 2005-03-31
1030710488
10308Enhancements10489Enhancements
10309************10490************
@@ -10331,8 +10512,10 @@
10331 the root directory only.10512 the root directory only.
1033210513
1033310514
10334bzr-0.0.1 2005-03-2610515bzr-0.0.1
10335#####################10516#########
10517
10518:Released: 2005-03-26
1033610519
10337Enhancements10520Enhancements
10338************10521************
@@ -10361,8 +10544,10 @@
10361 supported).10544 supported).
1036210545
1036310546
10364bzr-0.0.0.69 2005-03-2210547bzr-0.0.0.69
10365########################10548############
10549
10550:Released: 2005-03-22
1036610551
10367Enhancements10552Enhancements
10368************10553************
1036910554
=== added file 'bzrlib/doc_generate/sphinx_conf.py'
--- bzrlib/doc_generate/sphinx_conf.py 1970-01-01 00:00:00 +0000
+++ bzrlib/doc_generate/sphinx_conf.py 2009-09-08 16:37:05 +0000
@@ -0,0 +1,214 @@
1# -*- coding: utf-8 -*-
2#
3# Bazaar documentation build configuration file, created by
4# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
5#
6# All configuration values have a default; values that are commented out
7# serve to show the default.
8
9import sys, os
10
11# If extensions (or modules to document with autodoc) are in another directory,
12# add these directories to sys.path here. If the directory is relative to the
13# documentation root, use os.path.abspath to make it absolute, like shown here.
14#sys.path.append(os.path.abspath('.'))
15
16
17# -- General configuration -----------------------------------------------------
18
19# Add any Sphinx extension module names here, as strings. They can be extensions
20# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
21extensions = ['sphinx.ext.ifconfig']
22
23# Add any paths that contain templates here, relative to this directory.
24templates_path = ['_templates']
25
26# The suffix of source filenames.
27source_suffix = '.txt'
28
29# The encoding of source files.
30#source_encoding = 'utf-8'
31
32# The master toctree document.
33master_doc = 'index'
34
35# General information about the project.
36project = u'Bazaar'
37copyright = u'2009, Canonical Ltd'
38
39# The version info for the project you're documenting, acts as replacement for
40# |version| and |release|, also used in various other places throughout the
41# built documents.
42#
43# The short X.Y version.
44import bzrlib
45version = '.'.join(str(p) for p in bzrlib.version_info[:2])
46# The full version, including alpha/beta/rc tags.
47release = bzrlib.version_string
48
49# The language for content autogenerated by Sphinx. Refer to documentation
50# for a list of supported languages.
51#language = None
52
53# There are two options for replacing |today|: either, you set today to some
54# non-false value, then it is used:
55#today = ''
56# Else, today_fmt is used as the format for a strftime call.
57#today_fmt = '%B %d, %Y'
58
59# List of documents that shouldn't be included in the build.
60#unused_docs = []
61
62# List of directories, relative to source directory, that shouldn't be searched
63# for source files.
64exclude_trees = ['_build']
65
66# The reST default role (used for this markup: `text`) to use for all documents.
67#default_role = None
68
69# If true, '()' will be appended to :func: etc. cross-reference text.
70#add_function_parentheses = True
71
72# If true, the current module name will be prepended to all description
73# unit titles (such as .. function::).
74#add_module_names = True
75
76# If true, sectionauthor and moduleauthor directives will be shown in the
77# output. They are ignored by default.
78#show_authors = False
79
80# The name of the Pygments (syntax highlighting) style to use.
81pygments_style = 'sphinx'
82
83# A list of ignored prefixes for module index sorting.
84#modindex_common_prefix = []
85
86
87# -- Options for HTML output ---------------------------------------------------
88
89# The theme to use for HTML and HTML Help pages. Major themes that come with
90# Sphinx are currently 'default' and 'sphinxdoc'.
91html_theme = 'default'
92
93# Theme options are theme-specific and customize the look and feel of a theme
94# further. For a list of options available for each theme, see the
95# documentation.
96html_theme_options = {
97 # Unfortunately, the right sidebar breaks under IE6 and maybe IE7.
98 # So we stick with the default left placement to cater for users stuck
99 # on those browsers.
100 #'rightsidebar': True,
101
102 # Non-document areas: header (relbar), footer, sidebar, etc.
103 # Some useful colours here:
104 # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
105 # midnightblue
106 # * gray: dimgray, slategray, lightslategray
107 'sidebarbgcolor': "cornflowerblue",
108 'sidebarlinkcolor': "midnightblue",
109 'relbarbgcolor': "darkblue",
110 'footerbgcolor': "lightslategray",
111
112 # Text, heading and code colouring
113 'codebgcolor': "lightyellow",
114 'codetextcolor': "firebrick",
115 'linkcolor': "mediumblue",
116 }
117
118# Add any paths that contain custom themes here, relative to this directory.
119#html_theme_path = []
120
121# The name for this set of Sphinx documents. If None, it defaults to
122# "<project> v<release> documentation".
123#html_title = None
124
125# A shorter title for the navigation bar. Default is the same as html_title.
126#html_short_title = None
127
128# The name of an image file (relative to this directory) to place at the top
129# of the sidebar.
130#html_logo = None
131
132# The name of an image file (within the static path) to use as favicon of the
133# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
134# pixels large.
135html_favicon = "bzr.ico"
136
137# Add any paths that contain custom static files (such as style sheets) here,
138# relative to this directory. They are copied after the builtin static files,
139# so a file named "default.css" will overwrite the builtin "default.css".
140html_static_path = ['_static']
141
142# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143# using the given strftime format.
144#html_last_updated_fmt = '%b %d, %Y'
145
146# If true, SmartyPants will be used to convert quotes and dashes to
147# typographically correct entities.
148#html_use_smartypants = True
149
150# Custom sidebar templates, maps document names to template names.
151#html_sidebars = {}
152
153# Additional templates that should be rendered to pages, maps page names to
154# template names.
155#html_additional_pages = {}
156
157# If false, no module index is generated.
158html_use_modindex = False
159
160# If false, no index is generated.
161html_use_index = False
162
163# If true, the index is split into individual pages for each letter.
164#html_split_index = False
165
166# If true, links to the reST sources are added to the pages.
167html_show_sourcelink = True
168
169# If true, an OpenSearch description file will be output, and all pages will
170# contain a <link> tag referring to it. The value of this option must be the
171# base URL from which the finished HTML is served.
172#html_use_opensearch = ''
173
174# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
175#html_file_suffix = ''
176
177# Output file base name for HTML help builder.
178htmlhelp_basename = 'bzr-docs'
179
180
181# -- Options for LaTeX output --------------------------------------------------
182
183# The paper size ('letter' or 'a4').
184#latex_paper_size = 'letter'
185
186# The font size ('10pt', '11pt' or '12pt').
187#latex_font_size = '10pt'
188
189# Grouping the document tree into LaTeX files. List of tuples
190# (source start file, target name, title, author, documentclass [howto/manual]).
191latex_documents = []
192
193# The name of an image file (relative to this directory) to place at the top of
194# the title page.
195latex_logo = '../Bazaar-Logo-For-Manuals.png'
196
197# For "manual" documents, if this is true, then toplevel headings are parts,
198# not chapters.
199#latex_use_parts = False
200
201# Additional stuff for the LaTeX preamble.
202#latex_preamble = ''
203
204# Documents to append as an appendix to all manuals.
205#latex_appendices = []
206
207# If false, no module index is generated.
208#latex_use_modindex = True
209
210
211# -- Bazaar-specific configuration ---------------------------------------------
212
213# Authors of the documents
214bzr_team = u'Bazaar Developers'
0215
=== removed file 'doc/BUILD-NOTES'
--- doc/BUILD-NOTES 2009-07-26 15:58:33 +0000
+++ doc/BUILD-NOTES 1970-01-01 00:00:00 +0000
@@ -1,35 +0,0 @@
1To build Bazaar's documentation using Sphinx, follow the
2steps below.
3
40. Install Sphinx. You'll need Sphinx 0.6 or later. If that
5 version isn't available in your package manager repositories
6 yet, install python-easyinstall and use it to install Sphinx.
7 See http://sphinx.pocoo.org/ for details.
8
91. Build the Bazaar docs normally, i.e. in the project root, run:
10
11 make docs
12
132. Tweak the User Guide index page used:
14
15 cd doc/en/user-guide
16 bzr mv index.txt index-for-1x.txt
17 bzr mv index-for-2x.txt index.txt
18
193. Tweak the Release Notes TOC depth:
20
21 cd ../release-notes
22 vi NEWS.txt (change depth to 2)
23
244. Change to the docs directory and build the site:
25
26 cd ../..
27 make html
28
29The generated output site can be found in _build/html.
30
31Note: All of the above will Just Work soon. For now, we don't
32want to break the existing doc generation until a few issues
33with the Sphinx-generated site are ironed out, e.g. links from
34the User Reference to ../user-guide/index.html#foo no longer
35work when the User Guide is nicely split into topic pages.
360
=== added file 'doc/Bazaar-Logo-For-Manuals.png'
37Binary 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 differ1Binary 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
=== removed directory 'doc/_static/en/quick-reference'
=== removed file 'doc/bazaar-vcs.org.kid'
--- doc/bazaar-vcs.org.kid 2007-08-14 03:59:22 +0000
+++ doc/bazaar-vcs.org.kid 1970-01-01 00:00:00 +0000
@@ -1,482 +0,0 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<?python
4 def update_attrib(attrib, **kwargs):
5 attrib = dict(attrib)
6 attrib.update(kwargs)
7 return attrib
8?>
9<html xmlns="http://www.w3.org/1999/xhtml" xmlns:py="http://purl.org/kid/ns#">
10<head>
11<script type="text/javascript" src=
12"/htdocs/bazaarNew/js/opacity.js">
13</script>
14<link rel="shortcut icon" href=
15"http://bazaar-vcs.org/Welcome?action=AttachFile&amp;do=get&amp;target=favicon.ico"
16type="image/x-icon" />
17<meta http-equiv="Content-Type" content=
18"text/html; charset=us-ascii" />
19<meta name="robots" content="index,follow" />
20<title>Welcome - Bazaar Version Control</title>
21
22<script type="text/javascript" src="http://bazaar-vcs.org/htdocs/common/js/common.js">
23</script>
24<script type="text/javascript">
25//<![CDATA[
26<!--// common functions
27
28// We keep here the state of the search box
29searchIsDisabled = false;
30
31function searchChange(e) {
32 // Update search buttons status according to search box content.
33 // Ignore empty or whitespace search term.
34 var value = e.value.replace(/\s+/, '');
35 if (value == '' || searchIsDisabled) {
36 searchSetDisabled(true);
37 } else {
38 searchSetDisabled(false);
39 }
40}
41
42function searchSetDisabled(flag) {
43 // Enable or disable search
44 document.getElementById('fullsearch').disabled = flag;
45 document.getElementById('titlesearch').disabled = flag;
46}
47
48function searchFocus(e) {
49 // Update search input content on focus
50 if (e.value == 'Search') {
51 e.value = '';
52 e.className = '';
53 searchIsDisabled = false;
54 }
55}
56
57function searchBlur(e) {
58 // Update search input content on blur
59 if (e.value == '') {
60 e.value = 'Search';
61 e.className = 'disabled';
62 searchIsDisabled = true;
63 }
64}
65
66function actionsMenuInit(title) {
67 // Initialize action menu
68 for (i = 0; i < document.forms.length; i++) {
69 var form = document.forms[i];
70 if (form.className == 'actionsmenu') {
71 // Check if this form needs update
72 var div = form.getElementsByTagName('div')[0];
73 var label = div.getElementsByTagName('label')[0];
74 if (label) {
75 // This is the first time: remove label and do buton.
76 div.removeChild(label);
77 var dobutton = div.getElementsByTagName('input')[0];
78 div.removeChild(dobutton);
79 // and add menu title
80 var select = div.getElementsByTagName('select')[0];
81 var item = document.createElement('option');
82 item.appendChild(document.createTextNode(title));
83 item.value = 'show';
84 select.insertBefore(item, select.options[0]);
85 select.selectedIndex = 0;
86 }
87 }
88 }
89}
90//-->
91//]]>
92</script>
93<link rel="stylesheet" type="text/css" charset="utf-8" media="all"
94href="http://bazaar-vcs.org/htdocs/bazaarNew/css/common.css" />
95<link rel="stylesheet" type="text/css" charset="utf-8" media=
96"screen" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/screen.css" />
97<link rel="stylesheet" type="text/css" charset="utf-8" media=
98"print" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/print.css" />
99<link rel="stylesheet" type="text/css" charset="utf-8" media=
100"projection" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/projection.css" />
101<link rel="stylesheet" type="text/css" charset="utf-8" media=
102"screen" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/v4.css" />
103<link rel="stylesheet" type="text/css" charset="utf-8" media=
104"screen" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/screen2.css" />
105<link rel="stylesheet" type="text/css" charset="utf-8" media=
106"screen" href="http://bazaar-vcs.org/htdocs/bazaarNew/css/twoColumnsRight.css" />
107<style type="text/css">
108a.toc-backref
109{
110 color: black;
111 text-decoration: none;
112}
113</style>
114<link rel="alternate" title="Bazaar Version Control Recent Changes"
115href="http://bazaar-vcs.org/RecentChanges?action=rss_rc&amp;ddiffs=1&amp;unique=1" type=
116"application/rss+xml" />
117<link rel="Start" href="http://bazaar-vcs.org/Welcome" />
118<link rel="Alternate" title="Wiki Markup" href=
119"http://bazaar-vcs.org/Welcome?action=raw" />
120<link rel="Alternate" media="print" title="Print View" href=
121"http://bazaar-vcs.org/Welcome?action=print" />
122<link rel="Appendix" title="favicon.ico" href=
123"http://bazaar-vcs.org/Welcome?action=AttachFile&amp;do=view&amp;target=favicon.ico" />
124<link rel="Search" href="http://bazaar-vcs.org/FindPage" />
125<link rel="Index" href="http://bazaar-vcs.org/TitleIndex" />
126<link rel="Glossary" href="http://bazaar-vcs.org/WordIndex" />
127<link rel="Help" href="http://bazaar-vcs.org/HelpOnFormatting" />
128</head>
129<body lang="en" dir="ltr" xml:lang="en">
130<div id="page_header1_div"><script type="text/javascript">
131//<![CDATA[
132gui_editor_link_text = gui_editor_link_href = null;
133//]]>
134</script></div>
135<div id="pageWrapper">
136<hr class="hide" />
137<div id="masthead" class="inside">
138<div id="logoimage"><a href="http://bazaar-vcs.org/"><img src=
139"http://bazaar-vcs.org/htdocs/bazaarNew/css/logo.png" width="144" height="149" alt=
140"Bazaar" /></a></div>
141<h1><a href="http://bazaar-vcs.org/">Bazaar</a></h1>
142<p>GPL Distributed Version Control Software</p>
143</div>
144<hr class="hide" />
145<div class="hnav">
146<ul>
147<li class="hide"><a class="hide" href="#skipToContent"><em>Skip
148Navigation</em></a> <span class="divider">:</span></li>
149<li><a href="http://bazaar-vcs.org/Documentation" id="hnav_learn" name=
150"hnav_learn">Learn</a> <span class="divider">:</span></li>
151<li><a href="http://bazaar-vcs.org/Download" id="hnav_get" name="hnav_get">Get</a>
152<span class="divider">:</span></li>
153<li><a href="http://bazaar-vcs.org/BzrSupport" id="hnav_community" name=
154"hnav_community">Community</a> <span class="divider">:</span></li>
155<li><a href="http://bazaar-vcs.org/BzrPlugins" id="hnav_plugins" name=
156"hnav_plugins">Plugins</a></li>
157</ul>
158</div>
159<div id="outerColumnContainer">
160<div id="innerColumnContainer">
161<hr class="hide" />
162<div id="leftColumn">
163<div class="inside"></div>
164</div>
165<hr class="hide" />
166<div id="rightColumn">
167<div class="inside">
168<div id="searchbox">
169<form name="search" method="get" action="http://bazaar-vcs.org/" id="search">
170<div><input type="hidden" name="action" value="fullsearch" id=
171"fullsearch" /> <input type="hidden" name="context" value="180" />
172<input type="hidden" name="fullsearch" value="Text" /> <label for=
173"search_q" py:content="'Search Wiki'">Search Bazaar</label> <input type="text" name="value"
174id="search_q" value="" onfocus="searchFocus(this)" onblur=
175"searchBlur(this)" onkeyup="searchChange(this)" onchange=
176"searchChange(this)" alt="Search" /> <input type="submit" value=
177"go" name="go" id="search_go" /></div>
178</form>
179</div>
180<div id="searchform"></div>
181<div id="username" class="vnav">
182<h4>Website Links</h4>
183<ul>
184<li><a href="http://doc.bazaar-vcs.org">Documentation</a></li>
185<li><a href="http://bazaar-vcs.org">Wiki</a></li>
186</ul>
187</div>
188</div>
189</div>
190<div id="contentColumn" class="page_Welcome">
191<hr class="hide" />
192<div id="msg" class="vnav"></div>
193<a name="skipToContent" id="skipToContent"></a>
194<div class="inside" >
195<!--<img id="navProtection" width="1" height="1" border="0" src="/htdocs/bazaarNew/css/spacer.gif" alt="" style="height: 1px"/>-->
196<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')"/>
197<div dir="ltr" id="content" lang="en" xml:lang="en" py:content="body[:]"><span
198class="anchor" id="top"></span> <span class="anchor" id="line-8"></span>
199<h1 id="head-31592baed255c2a5cdfdaafb9521b837ea61021f">Performance
200Drive Under Way</h1>
201<span class="anchor" id="line-9"></span>
202<p class="line879">There was substantial progress on performance
203since 0.8. See <a href="/Performance/0.9">Performance/0.9</a>,
204<a href="/Performance/0.10">Performance/0.10</a> and <a href=
205"/Performance/0.11">Performance/0.11</a>. Thanks to everyone who
206has contributed patches and ideas! The focus from here to 1.0 will
207continue to be performance and documentation. Already there is work
208in progress to: <span class="anchor" id="line-10"></span></p>
209<span class="anchor" id="line-11"></span>
210<ul>
211<li>
212<p class="line879">write a <a href="/SmartServer">SmartServer</a>
213for high speed network operations (first look in 0.11).
214<span class="anchor" id="line-12"></span></p>
215</li>
216<li>
217<p class="line886">optimise file system access (tune our code and
218data structures to minimise probable disk io and disk seeking)
219<span class="anchor" id="line-13"></span></p>
220</li>
221<li>
222<p class="line886">optimise file formats for performance without
223sacrificing proven correctness and completeness <span class=
224"anchor" id="line-14"></span></p>
225</li>
226<li>
227<p class="line886">tune the codepaths that are most heavily used
228<span class="anchor" id="line-15"></span></p>
229</li>
230<li>
231<p class="line886">ensure that large imports are only done when
232needed, and use lightweight imports where possible <span class=
233"anchor" id="line-16"></span></p>
234<span class="anchor" id="line-17"></span></li>
235</ul>
236<h1 id="head-ceb9b8e0146b0ce087048f495b2ff2964c5d57ec">News</h1>
237<span class="anchor" id="line-18"></span>
238<h2 id="head-39a1524e97c9a6ba89ecee7856cb1a2e68134373">27th
239September 2006 - 0.11rc2 released</h2>
240<span class="anchor" id="line-19"></span>
241<p class="line879">bzr 0.11rc2 has been released. This release
242candidate corrects two regressions that occured from 0.10. Windows
243developers and users with very large source trees should upgrade
244immediately. Release <a class="https" href=
245"https://lists.canonical.com/archives/bazaar-ng/2006q3/017581.html">
246announcement</a> or <a class="http" href=
247"http://bazaar-vcs.org/releases/src/bzr-0.11rc2.tar.gz">download
248now</a>. For details of the original 0.11 release candidate, see
249the <a class="https" href=
250"https://lists.canonical.com/archives/bazaar-ng/2006q3/017502.html">
251announcement</a>. <span class="anchor" id="line-20"></span></p>
252<span class="anchor" id="line-21"></span>
253<h2 id="head-9940b3014f81c7b8ca65aa3235341588859d09dd">4th
254September 2006 - 0.10 released</h2>
255<span class="anchor" id="line-22"></span>
256<p class="line879">bzr 0.10 has been released after a smooth beta
257period. <a class="http" href=
258"http://bazaar-vcs.org/releases/src/bzr-0.10.tar.gz">download it
259now</a>! <span class="anchor" id="line-23"></span></p>
260<span class="anchor" id="line-24"></span>
261<h1 id="head-c2a87bc7d0bc411d33e18585154e534201115501">What is
262Bazaar?</h1>
263<span class="anchor" id="line-25"></span>
264<p class="line879">Bazaar is a decentralized revision control
265system designed to be easy for developers and end users alike.
266Decentralized revision control systems give people the ability to
267work over the internet using the <a class="http" href=
268"http://en.wikipedia.org/wiki/The_Cathedral_and_the_Bazaar">bazaar
269development model</a>. When you use Bazaar, you can commit to your
270own branches of your favorite free software projects without
271needing special permission. For more information, see: <span class=
272"anchor" id="line-26"></span></p>
273<span class="anchor" id="line-27"></span>
274<ul>
275<li>
276<p class="line903"><a href="/Bzr">What Is Bazaar?</a> <span class=
277"anchor" id="line-28"></span></p>
278</li>
279<li>
280<p class="line903"><a href="/WhoUsesBzr">Who Uses Bazaar?</a>
281<span class="anchor" id="line-29"></span></p>
282</li>
283<li>
284<p class="line903"><a href="/BzrFeatures">Bazaar Features</a>
285<span class="anchor" id="line-30"></span></p>
286</li>
287<li>
288<p class="line903"><a href="/FAQ">FAQ</a> (Frequently Asked
289Questions) <span class="anchor" id="line-31"></span></p>
290</li>
291<li>
292<p class="line903"><a href="/BzrGlossary">Bazaar Glossary</a>
293<span class="anchor" id="line-32"></span></p>
294</li>
295<li>
296<p class="line903"><a href="/ReleaseRoadmap">What's Coming</a> (the
297release roadmap) <span class="anchor" id="line-33"></span></p>
298<span class="anchor" id="line-34"></span></li>
299</ul>
300<h1 id="head-54a84f21f8314a452aecfb4e2da59fcb246fee7b">Where do I
301get it?</h1>
302<span class="anchor" id="line-35"></span>
303<p class="line886">The easiest place to get Bazaar is with your
304distribution. Do not despair if your distribution does not have
305Bazaar, as plain installation is still easy. <span class="anchor"
306id="line-36"></span></p>
307<span class="anchor" id="line-37"></span>
308<ul>
309<li>
310<p class="line903"><a href="/DistroDownloads">Packages</a> -
311Downloads for various distributions <span class="anchor" id=
312"line-38"></span></p>
313</li>
314<li>
315<p class="line903"><a href="/OfficialDownloads">Source</a> - Source
316downloads <span class="anchor" id="line-39"></span></p>
317</li>
318<li>
319<p class="line903"><a href="/WindowsDownloads">Windows</a> -
320Downloads for windows <span class="anchor" id="line-40"></span></p>
321<span class="anchor" id="line-41"></span></li>
322</ul>
323<h1 id="head-400b61668c5f3ab729ffbfeed0f9fc93e853044e">How do I
324install it?</h1>
325<span class="anchor" id="line-42"></span>
326<p class="line879">Installation for Bazaar is a snap. Supported
327operating systems include Linux, FreeBSD, Windows (Native &amp;
328Cygwin) and Solaris. If you can run Python 2.4, then you can run
329Bazaar. <span class="anchor" id="line-43"></span></p>
330<span class="anchor" id="line-44"></span>
331<ul>
332<li>
333<p class="line903"><a href="/DistroDownloads">Packages</a> -
334Downloads for various distributions <span class="anchor" id=
335"line-45"></span></p>
336</li>
337<li>
338<p class="line903"><a href="/Installation">Generic</a> - Generic
339Installation Instructions. <span class="anchor" id=
340"line-46"></span></p>
341</li>
342<li>
343<p class="line903"><a href="/BzrOnPureWindows">Native Windows</a> -
344Installation of Bazaar on Native windows. <span class="anchor" id=
345"line-47"></span></p>
346<span class="anchor" id="line-48"></span></li>
347</ul>
348<h1 id="head-6350ee8bfd03b56b430e775595af1eb29ac7bdb4">How do I use
349it?</h1>
350<span class="anchor" id="line-49"></span>
351<p class="line886">Included are the pearls of wisdom from people
352that have already branched off into a new world of development.
353<span class="anchor" id="line-50"></span></p>
354<span class="anchor" id="line-51"></span>
355<ul>
356<li>
357<p class="line903"><a href="/Documentation">Documents</a> - The
358main documentation page for Bazaar. <span class="anchor" id=
359"line-52"></span></p>
360</li>
361<li>
362<p class="line903"><a href="/IntroductionToBzr">Introduction</a> -
363Introduction to Bazaar gives a walkthough of the simpler commands.
364<span class="anchor" id="line-53"></span></p>
365</li>
366<li>
367<p class="line903"><a href="/QuickHackingWithBzr">Mini Tutorial</a>
368- The five minutes Bazaar Tutorial. <span class="anchor" id=
369"line-54"></span></p>
370</li>
371<li>
372<p class="line903"><a href="/BzrRevisionSpec">Revision Specs</a> -
373Arguments for -r that can be given with "bzr log", "bzr merge" and
374such. <span class="anchor" id="line-55"></span></p>
375<span class="anchor" id="line-56"></span></li>
376</ul>
377<h1 id="head-148c5debbd034308b67411c490e69555ee5a03a3">How does it
378compare?</h1>
379<span class="anchor" id="line-57"></span>
380<p class="line886">If you're familiar with other version control
381systems, you might like to see a quick comparison to them, or read
382guidelines to help you understand how to use bzr most effectively
383given your current experience. <span class="anchor" id=
384"line-58"></span></p>
385<span class="anchor" id="line-59"></span>
386<ul>
387<li>
388<p class="line903"><a href="/BzrForCVSUsers">BzrForCVSUsers</a> -
389Learning Bazaar for CVS users. <span class="anchor" id=
390"line-60"></span></p>
391</li>
392<li>
393<p class="line903"><a href="/BzrForGITUsers">BzrForGITUsers</a> -
394(In progress) Learning Bazaar for GIT users <span class="anchor"
395id="line-61"></span></p>
396</li>
397<li>
398<p class="line903"><a href="/RcsComparisons">RcsComparisons</a> -
399Comparison table of functionality and performance with Bazaar, GIT,
400Mercurial, SVN and other VCS systems. <span class="anchor" id=
401"line-62"></span></p>
402<span class="anchor" id="line-63"></span></li>
403</ul>
404<h1 id="head-e966f9f6520262482dc713218b2a916600636f14">How can I
405get Help?</h1>
406<span class="anchor" id="line-64"></span>
407<p class="line879">Our primary page for getting help is the
408<a href="/BzrSupport">BzrSupport</a> page. <span class="anchor" id=
409"line-65"></span></p>
410<span class="anchor" id="line-66"></span>
411<ul>
412<li>
413<p class="line903"><a class="https" href=
414"https://launchpad.net/products/bzr/+bugs">Bug Tracker</a> - You
415can check here to see if someone else is experiencing the same
416problem that you are. <span class="anchor" id="line-67"></span></p>
417</li>
418<li>
419<p class="line903"><a class="http" href=
420"http://lists.canonical.com/mailman/listinfo/bazaar-ng">Mailing
421List</a> - A high volume list focused upon Bazaar development and
422support. <span class="anchor" id="line-68"></span></p>
423</li>
424<li>
425<p class="line886">IRC - #bzr on irc.freenode.net <span class=
426"anchor" id="line-69"></span></p>
427<span class="anchor" id="line-70"></span></li>
428</ul>
429<h1 id="head-45d36005ff61e184525081c9c40ed26ded3c8f02">How can I
430contribute?</h1>
431<span class="anchor" id="line-71"></span>
432<p class="line879">Our primary development doc page is <a href=
433"/BzrDevelopment">BzrDevelopment</a>. <span class="anchor" id=
434"line-72"></span></p>
435<span class="anchor" id="line-73"></span>
436<ul>
437<li>
438<p class="line903"><a href="/BzrDevelopment">Development
439Instructions</a> - We keep our main development instructions here.
440<span class="anchor" id="line-74"></span></p>
441</li>
442<li>
443<p class="line903"><a href="/OfficialDownloads">Source Code</a> -
444Source code to get hacking with. <span class="anchor" id=
445"line-75"></span></p>
446</li>
447<li>
448<p class="line903"><a class="https" href=
449"https://launchpad.net/products/bzr/+specs">Specifications</a> -
450Specifications list which things are being worked on today and are
451likely to be worked on next. <span class="anchor" id=
452"line-76"></span></p>
453</li>
454<li>
455<p class="line903"><a class="https" href=
456"https://launchpad.net/products/bzr/+bugs">BugTracker</a> - Open
457bugs that you can work on. <span class="anchor" id=
458"line-77"></span></p>
459<span class="anchor" id="line-78"></span></li>
460</ul>
461<p class="line879">You are also welcome to improve this wiki site.
462To edit pages, please <a href="/UserPreferences">register</a>.
463Anonymous editing is disabled to prevent spammer attacks.
464<span class="anchor" id="line-79"></span></p>
465<span class="anchor" id="bottom"></span></div>
466</div>
467<div class="clear mozclear"></div>
468</div>
469</div>
470<div class="hide" id="nsFooterClear"><!-- for NS4's sake --></div>
471<hr class="hide" />
472<div id="footer" class="inside">
473<p style="margin:0;">&copy; 2006 - <a href=
474"http://canonical.com/">Canonical Ltd.</a></p>
475<div id="endofpage"></div>
476<div id="footer_custom_html"></div>
477<div id="footer_links"></div>
478</div>
479<hr class="hide" /></div>
480</div>
481</body>
482</html>
4830
=== removed file 'doc/default.css'
--- doc/default.css 2008-02-07 07:05:13 +0000
+++ doc/default.css 1970-01-01 00:00:00 +0000
@@ -1,164 +0,0 @@
1/* from John Arbash Meinel's `Short tutorial' */
2
3body {
4 background-color: #ffffff;
5 color: #303030;
6 margin-top: 50px;
7 margin-left: 50px;
8 margin-right: 50px;
9 margin-bottom: 70px;
10 font-family: Verdana, Geneva, Arial, sans-serif;
11 font-size: small;
12 line-height: 140%
13 }
14
15/* p {
16 text-indent: 3em
17} */
18
19h1, h2, h3 {
20 font-family: Georgia, "Times New Roman", Times, serif;
21}
22
23h1.title {
24 text-align: center;
25 color: #000000;
26 font-size: 1.8em;
27 }
28
29
30div.contents p {
31 font-weight: bold;
32 }
33
34div.contents p a:hover {
35 color: inherit;
36 }
37
38/* Format ".. note:" sections nicely */
39div.note {
40 margin-left: 5em;
41 margin-right: 5em;
42 color: #000000;
43 background-color: #c1d1ff;
44 border: 1px solid #888888;
45 padding-left: 1em;
46 padding-right: 1em;
47 }
48
49div.note .first {
50 font-weight: bold;
51 }
52
53h1 {
54 color: #b52b2b;
55 /* DKREDcolor: #966b72; */
56 /* GREY color: #444444; */
57 font-size: 1.5em;
58 }
59
60h1 a:link {
61 color: inherit;
62 }
63
64h1 a:hover {
65 color: inherit;
66 }
67
68h1 a:visited {
69 color: inherit;
70 }
71
72h2 {
73 color: #222;
74 /* RED color: #966b72; */
75 text-decoration: underline;
76 font-size: 1.4em;
77 }
78
79h2 a:link {
80 color: inherit;
81 }
82
83h2 a:hover {
84 color: inherit;
85 }
86
87h2 a:visited {
88 color: inherit;
89 }
90
91h3 {
92 color: #966b72;
93 /* color: #966b72; */
94 }
95
96h3 a:link {
97 color: inherit;
98 }
99
100h3 a:hover {
101 color: inherit;
102 }
103
104h3 a:visited {
105 color: inherit;
106 }
107
108dt {
109 color: #000000;
110 font-weight: bold;
111 }
112/*
113 border: 4px solid blue;
114 padding: 1ex;
115 background: #7777FF;
116 }
117dt:hover
118 {
119 background-color: black;
120 }
121dt:active
122 {
123 background-color: red;
124 }
125*/
126
127tt, .literal-block {
128 font-family: monospace;
129 line-height: 100%
130 }
131
132tt {
133 color: #000000;
134 font-weight: normal;
135 }
136
137.literal-block {
138 margin-left: 5em;
139 margin-right: 5em;
140 color: #000000;
141 font-weight: normal;
142 background-color: #e5ecf9;
143 border: 1px solid #888888;
144 padding: 1em;
145 }
146
147a:link {
148 color: #4c52ff;
149 text-decoration: none;
150 }
151
152a:visited {
153 color: #4c53ff;
154 text-decoration: none;
155 }
156
157a:hover {
158 color: #b52727;
159 text-decoration: none;
160 }
161
162span, th.field-name {
163 white-space: nowrap;
164}
1650
=== renamed file 'doc/en/developer-guide/HACKING.txt' => 'doc/developers/HACKING.txt'
--- doc/en/developer-guide/HACKING.txt 2009-08-13 17:16:31 +0000
+++ doc/developers/HACKING.txt 2009-09-08 01:11:40 +0000
@@ -11,14 +11,8 @@
11the Bazaar mailing list. To propose a correction or addition to this11the Bazaar mailing list. To propose a correction or addition to this
12document, send a merge request or new text to the mailing list.12document, send a merge request or new text to the mailing list.
1313
14The current version of this document is available in the file 14The latest developer documentation can be found online at
15``doc/en/developer-guide/HACKING.txt`` in the source tree, or at15http://doc.bazaar-vcs.org/developers/.
16http://doc.bazaar-vcs.org/bzr.dev/en/developer-guide/HACKING.html
17
18See also:
19`Bazaar Developer Documentation Catalog <../../developers/index.html>`_.
20
21.. contents::
2216
2317
24Getting Started18Getting Started
@@ -266,7 +260,7 @@
266Automatically-generated API reference information is available at 260Automatically-generated API reference information is available at
267<http://starship.python.net/crew/mwh/bzrlibapi/>. 261<http://starship.python.net/crew/mwh/bzrlibapi/>.
268262
269See also the `Bazaar Architectural Overview <../../developers/overview.html>`_.263See also the :doc:`Bazaar Architectural Overview <overview>`.
270264
271265
272The Code Review Process266The Code Review Process
@@ -841,8 +835,8 @@
841Test coverage835Test coverage
842=============836=============
843837
844All code should be exercised by the test suite. See `Guide to Testing838All code should be exercised by the test suite. See :doc:`Guide to Testing
845Bazaar <../../developers/testing.html>`_ for detailed information about writing tests.839Bazaar <testing>` for detailed information about writing tests.
846840
847841
848Core Topics842Core Topics
@@ -1403,7 +1397,7 @@
1403* reviewing changes1397* reviewing changes
1404* reviewing blueprints1398* reviewing blueprints
1405* planning releases1399* planning releases
1406* managing releases (see the `Releasing Bazaar <../../developers/releasing.html>`_)1400* managing releases (see :doc:`Releasing Bazaar <releasing>`)
14071401
1408.. note::1402.. note::
1409 Removing barriers to community participation is a key reason for adopting1403 Removing barriers to community participation is a key reason for adopting
14101404
=== added directory 'doc/developers/_static'
=== added file 'doc/developers/_static/bzr icon 16.png'
1411Binary 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 differ1405Binary 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
=== added file 'doc/developers/_static/bzr.ico'
1412Binary 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 differ1406Binary 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
=== added directory 'doc/developers/_templates'
=== added file 'doc/developers/_templates/layout.html'
--- doc/developers/_templates/layout.html 1970-01-01 00:00:00 +0000
+++ doc/developers/_templates/layout.html 2009-09-07 07:44:36 +0000
@@ -0,0 +1,8 @@
1{% extends "!layout.html" %}
2
3{% block rootrellink %}
4<li><a href="http://bazaar-vcs.org/">
5 <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Home</a>&nbsp;|&nbsp;</li>
6<a href="http://doc.bazaar-vcs.org/en/">Documentation</a>&nbsp;|&nbsp;</li>
7{{ super() }}
8{% endblock %}
09
=== added file 'doc/developers/conf.py'
--- doc/developers/conf.py 1970-01-01 00:00:00 +0000
+++ doc/developers/conf.py 2009-09-09 00:34:29 +0000
@@ -0,0 +1,45 @@
1# -*- coding: utf-8 -*-
2#
3# Bazaar documentation build configuration file, created by
4# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
5#
6# This file is execfile()d with the current directory set to its containing dir.
7
8import sys, os
9
10# If extensions (or modules to document with autodoc) are in another directory,
11# add these directories to sys.path here. If the directory is relative to the
12# documentation root, use os.path.abspath to make it absolute, like shown here.
13sys.path = [os.path.abspath('../..')] + sys.path
14
15# Most of the configuration for Bazaar docs is defined here ...
16from bzrlib.doc_generate.sphinx_conf import *
17
18
19## Configuration specific to this site ##
20
21# The locale code for this documentation set
22bzr_locale = 'en'
23
24# A shorter title for the navigation bar. Default is the same as html_title.
25html_short_title = u"Developer Document Catalog (%s)" % (release,)
26
27# Additional templates that should be rendered to pages, maps page names to
28# template names.
29#html_additional_pages = {'index': 'index.html'}
30
31# Output file base name for HTML help builder.
32htmlhelp_basename = 'bzr-developers'
33
34# Grouping the document tree into LaTeX files. List of tuples
35# (source start file, target name, title, author, documentclass [howto/manual]).
36latex_documents = [
37 ('HACKING', 'bzr-en-developer-guide.tex', u'Bazaar Developer Guide',
38 u'Bazaar Developers', 'manual'),
39 ('testing', 'bzr-en-testing-guide.tex', u'Bazaar Testing Guide',
40 u'Bazaar Developers', 'manual'),
41 ('overview', 'bzr-en-architecture-overview.tex', u'Bazaar Architecture Overview',
42 u'Bazaar Developers', 'howto'),
43 ('integration', 'bzr-en-integration-guide.tex', u'Bazaar Integration Guide',
44 u'Bazaar Developers', 'howto'),
45]
046
=== added file 'doc/developers/implementation-notes.txt'
--- doc/developers/implementation-notes.txt 1970-01-01 00:00:00 +0000
+++ doc/developers/implementation-notes.txt 2009-09-07 07:44:36 +0000
@@ -0,0 +1,28 @@
1Implementation notes
2====================
3
4.. toctree::
5 :hidden:
6
7 btree_index_prefetch
8 last-modified
9 content-filtering
10 lca_tree_merging
11
12
13* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
14 to pre-read extra nodes in the btree index.
15
16* `Computing last_modified values <last-modified.html>`_ for inventory
17 entries
18
19* `Content filtering <content-filtering.html>`_
20
21* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
22 there is not a single unique ancestor (criss-cross merge).
23
24
25.. |--| unicode:: U+2014
26
27..
28 vim: ft=rst tw=74 ai
029
=== modified file 'doc/developers/index.txt'
--- doc/developers/index.txt 2009-08-26 03:20:32 +0000
+++ doc/developers/index.txt 2009-09-09 02:21:47 +0000
@@ -2,142 +2,44 @@
2Bazaar Developer Document Catalog2Bazaar Developer Document Catalog
3=================================3=================================
44
55Enhancing Bazaar
6Overall developer documentation6================
7===============================7
88.. toctree::
9* `Developer Guide <../en/developer-guide/HACKING.html>`_9 :maxdepth: 1
1010
11* `Architectural Overview <overview.html>`_ |--| describes some of the11 process
12 most important classes and concepts.12 HACKING
13 testing
14
15* `Bazaar Writer Guide <http://bazaar-vcs.org/ContributingToTheDocs>`_ (web link)
16
17
18Developing using bzrlib
19=======================
20
21.. toctree::
22 :maxdepth: 1
23
24 overview
25 integration
26
27* `Writing plugins for Bazaar <http://bazaar-vcs.org/WritingPlugins>`_ (web link)
1328
14* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_ 29* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_
15 (external link)30 (web link)
16 |--| automatically generated API reference information31
1732
18* `Integrating with Bazaar <http://bazaar-vcs.org/Integrating_with_Bazaar>`_33Other documents
19 (wiki) |--| a guide for writing Python programs that work with Bazaar.34===============
2035
21* `Revision Properties <revision-properties.html>`_ |--| An application36.. toctree::
22 can set arbitrary per-revision key/value pairs to store app-specific37 :maxdepth: 1
23 data.38
2439 plans
25* `Testing <testing.html>`_ |--| Guide to writing tests for Bazaar.40 specifications
2641 implementation-notes
27* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki) 42 miscellaneous-notes
28 |--| specific advice on writing Bazaar plugins.
29
30Process
31=======
32
33* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
34 development cycle and how to run it.
35
36* `Releasing Bazaar <releasing.html>`_ |--|
37 Checklist to make a release of Bazaar.
38
39* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
40
41* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
42 your changes to Bazaar integrated into a release.
43
44* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
45 bzr code and visualize the results.
46
47* `EC2 resources <ec2.html>`_ |--| A team resource for
48 Windows packaging and testing, and Ubuntu testing.
49
50* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug
51 tracker.
52
53Plans
54=====
55
56* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
57 for fixing performance in bzr over the next few releases.
58
59* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
60 for storing multiple branches in one file-system directory.
61
62* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
63 Implmentation strategy for Bazaar Windows Shell Extensions, aka
64 TortoiseBzr.
65
66* `CHK Optimized index <improved_chk_index.html>`_
67
68Specifications
69==============
70
71* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
72
73* `Apport error reporting <apport.html>`_ |--| Capture data to report
74 bugs.
75
76* `Authentication ring <authentication-ring.html>`_ |--| Configuring
77 authentication.
78
79* `Bundles <bundles.html>`_ |--| All about bzr bundles.
80
81* `Container format <container-format.html>`_ |--| Notes on a container format
82 for streaming and storing Bazaar data.
83
84* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
85 technology used in CHK repositories.
86
87* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
88
89* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
90
91* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
92
93* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
94
95* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
96
97* `Repositories <repository.html>`_ |--| What repositories do and are used for.
98
99* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
100 for repositories (a layer above the container format).
101
102* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
103 any python application.
104
105* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
106 |--| How Bazaar operates on case-insensitive file systems such as commonly
107 found on Windows, USB sticks, etc.
108
109* `Development repository formats <development-repo.html>`_ |--| How to
110 work with repository formats that are still under development.
111 Contains instructions for those implementing new formats, of course,
112 but also for (bleeding-edge) end users of those formats.
113
114Data formats
115============
116
117* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories
118 (new in Bazaar 0.92).
119
120Implementation notes
121====================
122
123* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
124 to pre-read extra nodes in the btree index.
125
126* `Computing last_modified values <last-modified.html>`_ for inventory
127 entries
128
129* `Content filtering <content-filtering.html>`_
130
131* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
132 there is not a single unique ancestor (criss-cross merge).
133
134Miscellaneous
135=============
136
137* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
138
139* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
140 performance analysis
14143
14244
143.. |--| unicode:: U+201445.. |--| unicode:: U+2014
14446
=== modified file 'doc/developers/integration.txt'
--- doc/developers/integration.txt 2008-04-08 10:55:41 +0000
+++ doc/developers/integration.txt 2009-09-09 02:21:47 +0000
@@ -244,12 +244,12 @@
244244
245 source.create_checkout('/tmp/newBzrCheckout', None, False, accelerator_tree245 source.create_checkout('/tmp/newBzrCheckout', None, False, accelerator_tree
246246
247==================247
248History Operations248History Operations
249==================249==================
250250
251Finding the last revision number or id251Finding the last revision number or id
252======================================252--------------------------------------
253253
254To get the last revision number and id of a branch use::254To get the last revision number and id of a branch use::
255255
@@ -263,7 +263,7 @@
263263
264264
265Getting the list of revision ids that make up a branch265Getting the list of revision ids that make up a branch
266======================================================266------------------------------------------------------
267267
268IMPORTANT: This should be avoided wherever possible, as it scales with the268IMPORTANT: This should be avoided wherever possible, as it scales with the
269length of history::269length of history::
@@ -277,7 +277,7 @@
277277
278278
279Getting a Revision object from a revision id279Getting a Revision object from a revision id
280============================================280--------------------------------------------
281281
282The Revision object has attributes like "message" to get the information282The Revision object has attributes like "message" to get the information
283about the revision::283about the revision::
@@ -287,7 +287,7 @@
287287
288288
289Accessing the files from a revision289Accessing the files from a revision
290===================================290-----------------------------------
291291
292To get the file contents and tree shape for a specific revision you need292To get the file contents and tree shape for a specific revision you need
293a RevisionTree. These are supplied by the repository for a specific293a RevisionTree. These are supplied by the repository for a specific
294294
=== added file 'doc/developers/miscellaneous-notes.txt'
--- doc/developers/miscellaneous-notes.txt 1970-01-01 00:00:00 +0000
+++ doc/developers/miscellaneous-notes.txt 2009-09-07 07:44:36 +0000
@@ -0,0 +1,20 @@
1Miscellaneous notes
2===================
3
4.. toctree::
5 :hidden:
6
7 dirstate
8 update
9
10
11* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
12
13* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
14 performance analysis
15
16
17.. |--| unicode:: U+2014
18
19..
20 vim: ft=rst tw=74 ai
021
=== modified file 'doc/developers/overview.txt'
--- doc/developers/overview.txt 2009-03-20 02:08:23 +0000
+++ doc/developers/overview.txt 2009-09-08 01:11:40 +0000
@@ -12,16 +12,9 @@
12document, send a merge request or new text to the mailing list.12document, send a merge request or new text to the mailing list.
1313
14The current version of this document is available in the file14The current version of this document is available in the file
15``doc/developers/overview.txt`` in the source tree, and from 15``doc/developers/overview.txt`` in the source tree, and available online
16<http://doc.bazaar-vcs.org/bzr.dev/>.16within the developer documentation, <http://doc.bazaar-vcs.org/developers/>.
1717
18See also:
19
20 * `Bazaar Developer Documentation Catalog <index.html>`_.
21 * `Bazaar Developer Guide <../en/developer-guide/HACKING.html>`_
22 (particularly the *Coding Style Guidelines* section.)
23
24.. contents::
2518
26Essential Domain Classes19Essential Domain Classes
27########################20########################
2821
=== added file 'doc/developers/plans.txt'
--- doc/developers/plans.txt 1970-01-01 00:00:00 +0000
+++ doc/developers/plans.txt 2009-09-07 07:44:36 +0000
@@ -0,0 +1,29 @@
1Plans
2=====
3
4.. toctree::
5 :hidden:
6
7 performance-roadmap
8 colocated-branches
9 tortoise-strategy
10 improved_chk_index
11
12
13* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
14 for fixing performance in bzr over the next few releases.
15
16* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
17 for storing multiple branches in one file-system directory.
18
19* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
20 Implmentation strategy for Bazaar Windows Shell Extensions, aka
21 TortoiseBzr.
22
23* `CHK Optimized index <improved_chk_index.html>`_
24
25
26.. |--| unicode:: U+2014
27
28..
29 vim: ft=rst tw=74 ai
030
=== added file 'doc/developers/process.txt'
--- doc/developers/process.txt 1970-01-01 00:00:00 +0000
+++ doc/developers/process.txt 2009-09-09 02:21:47 +0000
@@ -0,0 +1,39 @@
1Bazaar Development Processes
2============================
3
4.. toctree::
5 :hidden:
6
7 cycle
8 releasing
9 ppa
10 profiling
11 ec2
12 bug-handling
13
14
15* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
16 development cycle and how to run it.
17
18* `Releasing Bazaar <releasing.html>`_ |--|
19 Checklist to make a release of Bazaar.
20
21* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
22
23* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
24 your changes to Bazaar integrated into a release.
25
26* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
27 bzr code and visualize the results.
28
29* `EC2 resources <ec2.html>`_ |--| A team resource for
30 Windows packaging and testing, and Ubuntu testing.
31
32* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug
33 tracker.
34
35
36.. |--| unicode:: U+2014
37
38..
39 vim: ft=rst tw=74 ai
040
=== modified file 'doc/developers/releasing.txt'
--- doc/developers/releasing.txt 2009-08-28 14:35:26 +0000
+++ doc/developers/releasing.txt 2009-09-08 01:11:40 +0000
@@ -3,7 +3,7 @@
33
4This document describes the processes for making and announcing a Bazaar4This document describes the processes for making and announcing a Bazaar
5release, and managing the release process. This is just one phase of the 5release, and managing the release process. This is just one phase of the
6`overall development cycle <cycle.html>`_, but it's the most complex part.6:doc:`overall development cycle <cycle>`, but it's the most complex part.
7This document gives a checklist you can follow from start to end in one7This document gives a checklist you can follow from start to end in one
8go.8go.
99
@@ -81,7 +81,7 @@
81 submit_to = bazaar@lists.canonical.com81 submit_to = bazaar@lists.canonical.com
82 smtp_server = mail.example.com:2582 smtp_server = mail.example.com:25
8383
84 Please see <http://doc.bazaar-vcs.org/latest/developers/HACKING.html#an-overview-of-pqm>84 Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
85 for more details on PQM85 for more details on PQM
8686
87#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.87#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
8888
=== added file 'doc/developers/specifications.txt'
--- doc/developers/specifications.txt 1970-01-01 00:00:00 +0000
+++ doc/developers/specifications.txt 2009-09-07 07:44:36 +0000
@@ -0,0 +1,77 @@
1Specifications
2==============
3
4.. toctree::
5 :hidden:
6
7 revision-properties
8 api-versioning
9 apport
10 authentication-ring
11 bundles
12 container-format
13 groupcompress-design
14 indices
15 inventory
16 lca-merge
17 network-protocol
18 plugin-api
19 repository
20 repository-stream
21 case-insensitive-file-systems
22 development-repo
23 packrepo
24
25
26* `Revision Properties <revision-properties.html>`_ |--| An application
27 can set arbitrary per-revision key/value pairs to store app-specific
28 data.
29
30* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
31
32* `Apport error reporting <apport.html>`_ |--| Capture data to report
33 bugs.
34
35* `Authentication ring <authentication-ring.html>`_ |--| Configuring
36 authentication.
37
38* `Bundles <bundles.html>`_ |--| All about bzr bundles.
39
40* `Container format <container-format.html>`_ |--| Notes on a container format
41 for streaming and storing Bazaar data.
42
43* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
44 technology used in CHK repositories.
45
46* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
47
48* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
49
50* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
51
52* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
53
54* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
55
56* `Repositories <repository.html>`_ |--| What repositories do and are used for.
57
58* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
59 for repositories (a layer above the container format).
60
61* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
62 |--| How Bazaar operates on case-insensitive file systems such as commonly
63 found on Windows, USB sticks, etc.
64
65* `Development repository formats <development-repo.html>`_ |--| How to
66 work with repository formats that are still under development.
67 Contains instructions for those implementing new formats, of course,
68 but also for (bleeding-edge) end users of those formats.
69
70* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories
71 (new in Bazaar 0.92).
72
73
74.. |--| unicode:: U+2014
75
76..
77 vim: ft=rst tw=74 ai
078
=== modified file 'doc/developers/testing.txt'
--- doc/developers/testing.txt 2009-03-03 01:45:32 +0000
+++ doc/developers/testing.txt 2009-09-09 02:21:47 +0000
@@ -1,11 +1,7 @@
1=======================1====================
2Guide to Testing Bazaar2Bazaar Testing Guide
3=======================3====================
44
5.. contents::
6
7Testing Bazaar
8##############
95
10The Importance of Testing6The Importance of Testing
11=========================7=========================
128
=== renamed file 'doc/Makefile' => 'doc/en/Makefile'
=== renamed directory 'doc/_static' => 'doc/en/_static'
=== renamed file 'doc/_static/en/quick-reference/Makefile' => 'doc/en/_static/en/Makefile'
--- doc/_static/en/quick-reference/Makefile 2009-07-22 14:07:56 +0000
+++ doc/en/_static/en/Makefile 2009-09-09 00:49:50 +0000
@@ -2,8 +2,8 @@
2# doc/*/quick-reference/Makefile and update TARGETS and OBJECTS usages in2# doc/*/quick-reference/Makefile and update TARGETS and OBJECTS usages in
3# doc/Makefile3# doc/Makefile
44
5TARGETS=bzr-quick-reference.png bzr-quick-reference.pdf5TARGETS=bzr-en-quick-reference.png bzr-en-quick-reference.pdf
6OBJECTS=bzr-quick-reference.svg Makefile6OBJECTS=bzr-en-quick-reference.svg Makefile
77
8all: $(TARGETS)8all: $(TARGETS)
99
@@ -15,9 +15,9 @@
15.svg.png:15.svg.png:
16 rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $<16 rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $<
1717
18bzr-quickref.png: $(OBJECTS)18bzr-en-quick-reference.png: $(OBJECTS)
1919
20bzr-quickref.pdf: $(OBJECTS)20bzr-en-quick-reference.pdf: $(OBJECTS)
2121
22clean:22clean:
23 rm -f $(TARGETS)23 rm -f $(TARGETS)
2424
=== renamed file 'doc/_static/en/quick-reference/bzr-quick-reference.pdf' => 'doc/en/_static/en/bzr-en-quick-reference.pdf'
=== renamed file 'doc/_static/en/quick-reference/bzr-quick-reference.png' => 'doc/en/_static/en/bzr-en-quick-reference.png'
=== renamed file 'doc/_static/en/quick-reference/bzr-quick-reference.svg' => 'doc/en/_static/en/bzr-en-quick-reference.svg'
=== renamed directory 'doc/_templates' => 'doc/en/_templates'
=== modified file 'doc/en/_templates/index.html'
--- doc/_templates/index.html 2009-08-18 00:10:19 +0000
+++ doc/en/_templates/index.html 2009-09-08 12:33:30 +0000
@@ -7,25 +7,39 @@
77
8 <table class="contentstable" align="center" style="margin-left: 30px"><tr>8 <table class="contentstable" align="center" style="margin-left: 30px"><tr>
9 <td width="50%">9 <td width="50%">
10 <p class="biglink"><a class="biglink" href="{{ pathto("en/user-guide/index") }}">User Guide</a><br/>10 <p class="biglink"><a class="biglink" href="{{ pathto("user-guide/index") }}">User Guide</a><br/>
11 <span class="linkdescr">how to use Bazaar effectively</span>11 <span class="linkdescr">how to use Bazaar effectively</span>
12 </p>12 </p>
13 <p class="biglink"><a class="biglink" href="{{ pathto("en/tutorials/index") }}">Tutorials</a><br/>13 <p class="biglink"><a class="biglink" href="{{ pathto("tutorials/index") }}">Tutorials</a><br/>
14 <span class="linkdescr">brief introductions</span>14 <span class="linkdescr">brief introductions</span>
15 </p>15 </p>
16 <p class="biglink"><a class="biglink" href="{{ pathto("en/quick-reference/index") }}">Quick Reference</a><br/>16 <p class="biglink"><a class="biglink" href="{{ pathto("quick-reference/index") }}">Quick Reference</a><br/>
17 <span class="linkdescr">for your wall</span>17 <span class="linkdescr">for your wall</span>
18 </p>18 </p>
19 <p class="biglink"><a class="biglink" href="{{ pathto("en/user-reference/bzr_man") }}">User Reference</a><br/>
20 <span class="linkdescr">all the gory details</span>
21 </p>
22 </td><td width="50%">19 </td><td width="50%">
23 <p class="biglink"><a class="biglink" href="{{ pathto("en/release-notes/NEWS") }}">Release Notes</a><br/>20 <p class="biglink"><a class="biglink" href="{{ pathto("release-notes/NEWS") }}">Release Notes</a><br/>
24 <span class="linkdescr">what's new</span>21 <span class="linkdescr">what's new</span>
25 </p>22 </p>
26 <p class="biglink"><a class="biglink" href="{{ pathto("en/upgrade-guide/index") }}">Upgrade Guide</a><br/>23 <p class="biglink"><a class="biglink" href="{{ pathto("upgrade-guide/index") }}">Upgrade Guide</a><br/>
27 <span class="linkdescr">moving to Bazaar 2.x</span>24 <span class="linkdescr">moving to Bazaar 2.x</span>
28 </p>25 </p>
26 <p class="biglink"><a class="biglink" href="{{ pathto("user-reference/bzr_man") }}">User Reference</a><br/>
27 <span class="linkdescr">all the gory details</span>
28 </p>
29 </td></tr>
30 </table>
31
32 <h2>Related links</h2>
33
34 <table class="contentstable" align="center" style="margin-left: 30px"><tr>
35 <td width="50%">
36 <p class="biglink"><a class="biglink" href="https://answers.launchpad.net/bzr">FAQ</a><br/>
37 <span class="linkdescr">frequently asked questions</span>
38 </p>
39 <p class="biglink"><a class="biglink" href="http://bazaar-vcs.org/BzrGlossary/">Glossary</a><br/>
40 <span class="linkdescr">help with terminology</span>
41 </p>
42 </td><td width="50%">
29 <p class="biglink"><a class="biglink" href="http://doc.bazaar-vcs.org/migration/en/">Migration Docs</a><br/>43 <p class="biglink"><a class="biglink" href="http://doc.bazaar-vcs.org/migration/en/">Migration Docs</a><br/>
30 <span class="linkdescr">for refugees of other tools</span>44 <span class="linkdescr">for refugees of other tools</span>
31 </p>45 </p>
@@ -35,31 +49,7 @@
35 </td></tr>49 </td></tr>
36 </table>50 </table>
3751
38 <p>Keen to help? See the <a href="{{ pathto("developers/index") }}">Developer Docs</a>52 <p>Keen to help? See the <a href="http://doc.bazaar-vcs.org/developers/">Developer Docs</a>
39 for policies and tools on contributing code, tests and documentation.</p>53 for policies and tools on contributing code, tests and documentation.</p>
4054
41
42 <h2>Related Links</h2>
43
44 <table class="contentstable" align="center" style="margin-left: 30px"><tr>
45 <td width="25%">
46 <p><a href="https://answers.launchpad.net/bzr">FAQ</a>
47 </p>
48 </td><td width="25%">
49 <p><a href="http://bazaar-vcs.org/BzrGlossary/">Glossary</a>
50 </p>
51 </td><td width="25%">
52 <p><a href="{{ pathto("genindex") }}">Index</a>
53 </p>
54 </td><td width="25%">
55 <p><a href="{{ pathto("search") }}">Search</a>
56 </p>
57 </td></tr>
58 </table>
59
60 <hr>
61 <p>Other languages:
62 <a href="{{ pathto("index.es") }}">Spanish</a>,
63 <a href="{{ pathto("index.ru") }}">Russian</a>
64 </p>
65{% endblock %}55{% endblock %}
6656
=== modified file 'doc/en/_templates/layout.html'
--- doc/_templates/layout.html 2009-07-22 13:41:01 +0000
+++ doc/en/_templates/layout.html 2009-09-03 00:21:59 +0000
@@ -3,5 +3,6 @@
3{% block rootrellink %}3{% block rootrellink %}
4<li><a href="http://bazaar-vcs.org/">4<li><a href="http://bazaar-vcs.org/">
5 <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Home</a>&nbsp;|&nbsp;</li>5 <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Home</a>&nbsp;|&nbsp;</li>
6<a href="http://doc.bazaar-vcs.org/en/">Documentation</a>&nbsp;|&nbsp;</li>
6{{ super() }}7{{ super() }}
7{% endblock %}8{% endblock %}
89
=== renamed file 'doc/conf.py' => 'doc/en/conf.py'
--- doc/conf.py 2009-07-22 13:41:01 +0000
+++ doc/en/conf.py 2009-09-09 00:34:29 +0000
@@ -4,208 +4,69 @@
4# sphinx-quickstart on Tue Jul 21 17:04:52 2009.4# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
5#5#
6# This file is execfile()d with the current directory set to its containing dir.6# This file is execfile()d with the current directory set to its containing dir.
7#
8# Note that not all possible configuration values are present in this
9# autogenerated file.
10#
11# All configuration values have a default; values that are commented out
12# serve to show the default.
137
14import sys, os8import sys, os
159
16# If extensions (or modules to document with autodoc) are in another directory,10# If extensions (or modules to document with autodoc) are in another directory,
17# add these directories to sys.path here. If the directory is relative to the11# add these directories to sys.path here. If the directory is relative to the
18# documentation root, use os.path.abspath to make it absolute, like shown here.12# documentation root, use os.path.abspath to make it absolute, like shown here.
19#sys.path.append(os.path.abspath('.'))13sys.path = [os.path.abspath('../..')] + sys.path
2014
21# -- General configuration -----------------------------------------------------15# Most of the configuration for Bazaar docs is defined here ...
2216from bzrlib.doc_generate.sphinx_conf import *
23# Add any Sphinx extension module names here, as strings. They can be extensions17
24# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.18
25extensions = ['sphinx.ext.ifconfig']19## Configuration specific to this site ##
2620
27# Add any paths that contain templates here, relative to this directory.21# The locale code for this documentation set
28templates_path = ['_templates']22bzr_locale = 'en'
2923
30# The suffix of source filenames.24# Translations & supporting helper function
31source_suffix = '.txt'25bzr_titles = {
3226 u'Table of Contents (%s)': None,
33# The encoding of source files.27 u'Bazaar User Guide': None,
34#source_encoding = 'utf-8'28 u'Bazaar User Reference': None,
3529 u'Bazaar Release Notes': None,
36# The master toctree document.30 u'Bazaar Upgrade Guide': None,
37master_doc = 'contents'31 u'Bazaar in five minutes': None,
3832 u'Bazaar Tutorial': None,
39# General information about the project.33 u'Using Bazaar With Launchpad': None,
40project = u'Bazaar'34 u'Centralized Workflow Tutorial': None,
41copyright = u'2009, Canonical Ltd'
42
43# The version info for the project you're documenting, acts as replacement for
44# |version| and |release|, also used in various other places throughout the
45# built documents.
46#
47# The short X.Y version.
48version = '1.18'
49# The full version, including alpha/beta/rc tags.
50release = '1.18dev'
51
52# The language for content autogenerated by Sphinx. Refer to documentation
53# for a list of supported languages.
54#language = None
55
56# There are two options for replacing |today|: either, you set today to some
57# non-false value, then it is used:
58#today = ''
59# Else, today_fmt is used as the format for a strftime call.
60#today_fmt = '%B %d, %Y'
61
62# List of documents that shouldn't be included in the build.
63#unused_docs = []
64
65# List of directories, relative to source directory, that shouldn't be searched
66# for source files.
67exclude_trees = ['_build']
68
69# The reST default role (used for this markup: `text`) to use for all documents.
70#default_role = None
71
72# If true, '()' will be appended to :func: etc. cross-reference text.
73#add_function_parentheses = True
74
75# If true, the current module name will be prepended to all description
76# unit titles (such as .. function::).
77#add_module_names = True
78
79# If true, sectionauthor and moduleauthor directives will be shown in the
80# output. They are ignored by default.
81#show_authors = False
82
83# The name of the Pygments (syntax highlighting) style to use.
84pygments_style = 'sphinx'
85
86# A list of ignored prefixes for module index sorting.
87#modindex_common_prefix = []
88
89
90# -- Options for HTML output ---------------------------------------------------
91
92# The theme to use for HTML and HTML Help pages. Major themes that come with
93# Sphinx are currently 'default' and 'sphinxdoc'.
94html_theme = 'default'
95
96# Theme options are theme-specific and customize the look and feel of a theme
97# further. For a list of options available for each theme, see the
98# documentation.
99html_theme_options = {
100 'rightsidebar': True,
101
102 # Non-document areas: header (relbar), footer, sidebar, etc.
103 # Some useful colours here:
104 # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
105 # midnightblue
106 # * gray: dimgray, slategray, lightslategray
107 'sidebarbgcolor': "cornflowerblue",
108 'sidebarlinkcolor': "midnightblue",
109 'relbarbgcolor': "darkblue",
110 'footerbgcolor': "lightslategray",
111
112 # Text, heading and code colouring
113 'codebgcolor': "lightyellow",
114 'codetextcolor': "firebrick",
115 'linkcolor': "mediumblue",
116 }35 }
11736def bzr_title(s):
118# Add any paths that contain custom themes here, relative to this directory.37 return bzr_titles.get(s) or s
119#html_theme_path = []
120
121# The name for this set of Sphinx documents. If None, it defaults to
122# "<project> v<release> documentation".
123#html_title = None
12438
125# A shorter title for the navigation bar. Default is the same as html_title.39# A shorter title for the navigation bar. Default is the same as html_title.
126#html_short_title = None40html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
127
128# The name of an image file (relative to this directory) to place at the top
129# of the sidebar.
130#html_logo = None
131
132# The name of an image file (within the static path) to use as favicon of the
133# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
134# pixels large.
135html_favicon = "bzr.ico"
136
137# Add any paths that contain custom static files (such as style sheets) here,
138# relative to this directory. They are copied after the builtin static files,
139# so a file named "default.css" will overwrite the builtin "default.css".
140html_static_path = ['_static']
141
142# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143# using the given strftime format.
144#html_last_updated_fmt = '%b %d, %Y'
145
146# If true, SmartyPants will be used to convert quotes and dashes to
147# typographically correct entities.
148#html_use_smartypants = True
149
150# Custom sidebar templates, maps document names to template names.
151#html_sidebars = {}
15241
153# Additional templates that should be rendered to pages, maps page names to42# Additional templates that should be rendered to pages, maps page names to
154# template names.43# template names.
155html_additional_pages = {'contents': 'index.html'}44html_additional_pages = {'index': 'index.html'}
156
157# If false, no module index is generated.
158#html_use_modindex = True
159
160# If false, no index is generated.
161#html_use_index = True
162
163# If true, the index is split into individual pages for each letter.
164#html_split_index = False
165
166# If true, links to the reST sources are added to the pages.
167html_show_sourcelink = True
168
169# If true, an OpenSearch description file will be output, and all pages will
170# contain a <link> tag referring to it. The value of this option must be the
171# base URL from which the finished HTML is served.
172#html_use_opensearch = ''
173
174# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
175#html_file_suffix = ''
17645
177# Output file base name for HTML help builder.46# Output file base name for HTML help builder.
178htmlhelp_basename = 'Bazaardoc'47htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
179
180
181# -- Options for LaTeX output --------------------------------------------------
182
183# The paper size ('letter' or 'a4').
184#latex_paper_size = 'letter'
185
186# The font size ('10pt', '11pt' or '12pt').
187#latex_font_size = '10pt'
18848
189# Grouping the document tree into LaTeX files. List of tuples49# Grouping the document tree into LaTeX files. List of tuples
190# (source start file, target name, title, author, documentclass [howto/manual]).50# (source start file, target name, title, author, documentclass [howto/manual]).
191latex_documents = [51latex_documents = [
192 ('contents', 'Bazaar.tex', u'Bazaar Documentation',52 # Manuals
193 u'Bazaar Developers', 'manual'),53 ('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
54 bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
55 ('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
56 bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
57 ('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
58 bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
59 ('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
60 bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
61 # Tutorials
62 ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
63 bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
64 ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
65 bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
66 ('tutorials/using_bazaar_with_launchpad',
67 'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
68 bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
69 ('tutorials/centralized_workflow',
70 'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
71 bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
194]72]
195
196# The name of an image file (relative to this directory) to place at the top of
197# the title page.
198#latex_logo = None
199
200# For "manual" documents, if this is true, then toplevel headings are parts,
201# not chapters.
202#latex_use_parts = False
203
204# Additional stuff for the LaTeX preamble.
205#latex_preamble = ''
206
207# Documents to append as an appendix to all manuals.
208#latex_appendices = []
209
210# If false, no module index is generated.
211#latex_use_modindex = True
21273
=== removed directory 'doc/en/developer-guide'
=== renamed file 'doc/contents.txt' => 'doc/en/index.txt'
--- doc/contents.txt 2009-08-18 00:10:19 +0000
+++ doc/en/index.txt 2009-09-08 12:33:30 +0000
@@ -4,39 +4,15 @@
4 contain the root `toctree` directive.4 contain the root `toctree` directive.
55
66
7Core documentation7Table of Contents
8==================8=================
99
10.. toctree::10.. toctree::
11 :maxdepth: 111 :maxdepth: 1
1212
13 en/user-guide/index13 user-guide/index
14 en/tutorials/index14 tutorials/index
15 en/quick-reference/index15 quick-reference/index
16 en/user-reference/index16 release-notes/NEWS
1717 upgrade-guide/index
18.. toctree::18 user-reference/bzr_man
19 :maxdepth: 1
20
21 en/release-notes/index
22 en/upgrade-guide/index
23 developers/index
24
25
26Other languages:
27
28.. toctree::
29 :maxdepth: 1
30
31 index.es
32 index.ru
33
34
35Related links
36=============
37
38* `Frequently Asked Questions <http://bazaar-vcs.org/FAQ>`_
39* `Glossary <http://bazaar-vcs.org/BzrGlossary>`_
40* :ref:`genindex`
41* :ref:`search`
42
4319
=== renamed file 'doc/make.bat' => 'doc/en/make.bat'
=== modified file 'doc/en/mini-tutorial/index.txt'
--- doc/en/mini-tutorial/index.txt 2009-04-04 02:50:01 +0000
+++ doc/en/mini-tutorial/index.txt 2009-09-02 16:03:51 +0000
@@ -2,8 +2,6 @@
2Bazaar in five minutes2Bazaar in five minutes
3======================3======================
44
5.. contents::
6
7Introduction5Introduction
8============6============
97
108
=== modified file 'doc/en/quick-reference/index.txt'
--- doc/en/quick-reference/index.txt 2009-07-22 14:07:56 +0000
+++ doc/en/quick-reference/index.txt 2009-09-09 02:32:10 +0000
@@ -1,6 +1,6 @@
1Quick Reference1Quick Reference
2===============2===============
33
4* `SVG format <../../_static/en/quick-reference/bzr-quick-reference.svg>`_4* `PDF format <../_static/en/bzr-en-quick-reference.pdf>`_
5* `PDF format <../../_static/en/quick-reference/bzr-quick-reference.pdf>`_5* `PNG format <../_static/en/bzr-en-quick-reference.png>`_
6* `PNG format <../../_static/en/quick-reference/bzr-quick-reference.png>`_6* `SVG format <../_static/en/bzr-en-quick-reference.svg>`_
77
=== modified file 'doc/en/tutorials/centralized_workflow.txt'
--- doc/en/tutorials/centralized_workflow.txt 2009-07-22 13:41:01 +0000
+++ doc/en/tutorials/centralized_workflow.txt 2009-09-02 16:03:51 +0000
@@ -1,6 +1,6 @@
1====================1=============================
2Centralized Workflow2Centralized Workflow Tutorial
3====================3=============================
44
55
6Overview6Overview
@@ -23,8 +23,6 @@
2323
24.. _Bazaar: http://bazaar-vcs.org24.. _Bazaar: http://bazaar-vcs.org
2525
26.. contents::
27
2826
29Initial Setup27Initial Setup
30=============28=============
3129
=== modified file 'doc/en/tutorials/tutorial.txt'
--- doc/en/tutorials/tutorial.txt 2009-06-27 08:10:13 +0000
+++ doc/en/tutorials/tutorial.txt 2009-09-02 16:03:51 +0000
@@ -11,8 +11,6 @@
11Bazaar Tutorial11Bazaar Tutorial
12===============12===============
1313
14Current for bzr-0.91, 2007-08
15
1614
17Introduction15Introduction
18============16============
@@ -24,8 +22,8 @@
24different." Otherwise, get some coffee or tea, get comfortable and get22different." Otherwise, get some coffee or tea, get comfortable and get
25ready to catch up. 23ready to catch up.
2624
27The Purposes of Revision Control25The purpose of revision control
28================================26===============================
2927
30Odds are that you have worked on some sort of textual data -- the sources28Odds are that you have worked on some sort of textual data -- the sources
31to a program, web sites or the config files that Unix system29to a program, web sites or the config files that Unix system
@@ -57,8 +55,8 @@
57We keep these logs so that if later there is some sort of problem with55We keep these logs so that if later there is some sort of problem with
58sftp, we can figure out when the problem probably happened. 56sftp, we can figure out when the problem probably happened.
5957
60How DRCS is Different58How DRCS is different
61---------------------59=====================
6260
63Many Revision Control Systems (RCS) are stored on servers. If one wants to61Many Revision Control Systems (RCS) are stored on servers. If one wants to
64work on the code stored within an RCS, then one needs to connect to the62work on the code stored within an RCS, then one needs to connect to the
@@ -282,6 +280,7 @@
282As a shortcut, ``bzr diff -p1`` produces a form that works with the 280As a shortcut, ``bzr diff -p1`` produces a form that works with the
283command ``patch -p1``.281command ``patch -p1``.
284282
283
285Committing changes284Committing changes
286==================285==================
287286
@@ -308,7 +307,7 @@
308can also be useful when you pick up your work after a break.)307can also be useful when you pick up your work after a break.)
309308
310Message from an editor309Message from an editor
311======================310----------------------
312311
313If you use neither the ``-m`` nor the ``-F`` option then bzr will open an312If you use neither the ``-m`` nor the ``-F`` option then bzr will open an
314editor for you to enter a message. The editor to run is controlled by313editor for you to enter a message. The editor to run is controlled by
@@ -355,9 +354,13 @@
355given then only those ones will be affected. ``bzr revert`` also clears the354given then only those ones will be affected. ``bzr revert`` also clears the
356list of pending merges revisions.355list of pending merges revisions.
357356
357
358Ignoring files358Ignoring files
359==============359==============
360360
361The .bzrignore file
362-------------------
363
361Many source trees contain some files that do not need to be versioned,364Many source trees contain some files that do not need to be versioned,
362such as editor backups, object or bytecode files, and built programs. You365such as editor backups, object or bytecode files, and built programs. You
363can simply not add them, but then they'll always crop up as unknown files.366can simply not add them, but then they'll always crop up as unknown files.
@@ -400,7 +403,7 @@
400 % bzr commit -m "Add ignore patterns"403 % bzr commit -m "Add ignore patterns"
401404
402405
403Global Ignores406Global ignores
404--------------407--------------
405408
406There are some ignored files which are not project specific, but more user409There are some ignored files which are not project specific, but more user
@@ -574,6 +577,7 @@
574 rsync, or other related file transfer methods. This is usually less safe577 rsync, or other related file transfer methods. This is usually less safe
575 than using ``push``, but may be faster or easier in some situations.578 than using ``push``, but may be faster or easier in some situations.
576579
580
577Moving changes between trees 581Moving changes between trees
578============================582============================
579583
580584
=== modified file 'doc/en/tutorials/using_bazaar_with_launchpad.txt'
--- doc/en/tutorials/using_bazaar_with_launchpad.txt 2009-07-22 13:41:01 +0000
+++ doc/en/tutorials/using_bazaar_with_launchpad.txt 2009-09-02 16:03:51 +0000
@@ -2,8 +2,6 @@
2Using Bazaar with Launchpad2Using Bazaar with Launchpad
3===========================3===========================
44
5.. contents::
6
75
8Motivation6Motivation
9==========7==========
108
=== modified file 'doc/en/upgrade-guide/index.txt'
--- doc/en/upgrade-guide/index.txt 2009-07-22 13:41:01 +0000
+++ doc/en/upgrade-guide/index.txt 2009-09-02 16:03:51 +0000
@@ -8,8 +8,6 @@
8.. level 3 ~~~~~~~~8.. level 3 ~~~~~~~~
9.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)9.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
1010
11.. contents::
12
13.. include:: overview.txt11.. include:: overview.txt
14.. include:: data_migration.txt12.. include:: data_migration.txt
15.. include:: tips_and_tricks.txt13.. include:: tips_and_tricks.txt
1614
=== removed file 'doc/en/user-guide/index.txt'
--- doc/en/user-guide/index.txt 2009-07-26 15:58:33 +0000
+++ doc/en/user-guide/index.txt 1970-01-01 00:00:00 +0000
@@ -1,118 +0,0 @@
1#################
2Bazaar User Guide
3#################
4
5.. Please mark sections in included files as following:
6.. level 1 ========
7.. level 2 --------
8.. level 3 ~~~~~~~~
9.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
10
11.. contents:: :depth: 3
12
13
14Introduction
15############
16
17.. include:: introducing_bazaar.txt
18.. include:: core_concepts.txt
19.. include:: bazaar_workflows.txt
20
21
22Getting started
23###############
24
25.. include:: installing_bazaar.txt
26.. include:: entering_commands.txt
27.. include:: getting_help.txt
28.. include:: configuring_bazaar.txt
29.. include:: using_aliases.txt
30.. include:: plugins.txt
31.. include:: zen.txt
32
33
34Personal version control
35########################
36
37.. include:: solo_intro.txt
38.. include:: starting_a_project.txt
39.. include:: controlling_registration.txt
40.. include:: reviewing_changes.txt
41.. include:: recording_changes.txt
42.. include:: browsing_history.txt
43.. include:: releasing_a_project.txt
44.. include:: undoing_mistakes.txt
45
46
47Sharing with peers
48##################
49
50.. include:: partner_intro.txt
51.. include:: branching_a_project.txt
52.. include:: merging_changes.txt
53.. include:: resolving_conflicts.txt
54.. include:: annotating_changes.txt
55
56
57Team collaboration, central style
58#################################
59
60.. include:: central_intro.txt
61.. include:: publishing_a_branch.txt
62.. include:: using_checkouts.txt
63.. include:: working_offline_central.txt
64.. include:: reusing_a_checkout.txt
65
66
67Team collaboration, distributed style
68#####################################
69
70.. include:: distributed_intro.txt
71.. include:: organizing_branches.txt
72.. include:: using_gatekeepers.txt
73.. include:: sending_changes.txt
74
75
76Miscellaneous topics
77####################
78
79.. include:: part2_intro.txt
80.. include:: adv_merging.txt
81.. include:: shelving_changes.txt
82.. include:: filtered_views.txt
83.. include:: stacked.txt
84.. include:: server.txt
85.. include:: hooks.txt
86.. include:: version_info.txt
87
88
89A brief tour of some popular plugins
90####################################
91
92.. include:: bzrtools_plugin.txt
93.. include:: svn_plugin.txt
94.. include later looms_plugin.txt
95
96
97Integrating Bazaar into your environment
98########################################
99
100.. include:: web_browsing.txt
101.. include later - file_explorers.txt
102.. include later - desktop_integration.txt
103.. include later - editors_and_ides.txt
104.. include later - email.txt
105.. include:: bug_trackers.txt
106
107
108Appendices
109##########
110
111.. include:: specifying_revisions.txt
112.. include:: organizing_your_workspace.txt
113.. include:: shared_repository_layouts.txt
114.. include:: setting_up_email.txt
115.. include:: http_smart_server.txt
116.. include:: writing_a_plugin.txt
117
118.. |--| unicode:: U+2014
1190
=== renamed file 'doc/en/user-guide/index-for-2x.txt' => 'doc/en/user-guide/index.txt'
=== added directory 'doc/es/_static'
=== added file 'doc/es/_static/bzr icon 16.png'
120Binary 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 differ1Binary 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
=== added file 'doc/es/_static/bzr.ico'
121Binary 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 differ2Binary 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
=== added directory 'doc/es/_static/es'
=== renamed file 'doc/es/quick-reference/Makefile' => 'doc/es/_static/es/Makefile'
--- doc/es/quick-reference/Makefile 2009-06-29 11:02:31 +0000
+++ doc/es/_static/es/Makefile 2009-09-09 00:49:50 +0000
@@ -1,5 +1,5 @@
1TARGETS=quick-start-summary.png quick-start-summary.pdf1TARGETS=bzr-es-quick-reference.png bzr-es-quick-reference.pdf
2OBJECTS=quick-start-summary.svg Makefile2OBJECTS=bzr-es-quick-reference.svg Makefile
33
4all: $(TARGETS)4all: $(TARGETS)
55
@@ -11,9 +11,9 @@
11.svg.png:11.svg.png:
12 rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $<12 rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $<
1313
14bzr-quickref.png: $(OBJECTS)14bzr-es-quick-reference.png: $(OBJECTS)
1515
16bzr-quickref.pdf: $(OBJECTS)16bzr-es-quick-reference.pdf: $(OBJECTS)
1717
18clean:18clean:
19 rm -f $(TARGETS)19 rm -f $(TARGETS)
2020
=== renamed file 'doc/es/quick-reference/quick-start-summary.pdf' => 'doc/es/_static/es/bzr-es-quick-reference.pdf'
=== renamed file 'doc/es/quick-reference/quick-start-summary.png' => 'doc/es/_static/es/bzr-es-quick-reference.png'
=== renamed file 'doc/es/quick-reference/quick-start-summary.svg' => 'doc/es/_static/es/bzr-es-quick-reference.svg'
=== added directory 'doc/es/_templates'
=== added file 'doc/es/_templates/layout.html'
--- doc/es/_templates/layout.html 1970-01-01 00:00:00 +0000
+++ doc/es/_templates/layout.html 2009-09-07 06:12:15 +0000
@@ -0,0 +1,8 @@
1{% extends "!layout.html" %}
2
3{% block rootrellink %}
4<li><a href="http://bazaar-vcs.org/">
5 <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Inicio</a>&nbsp;|&nbsp;</li>
6<a href="http://doc.bazaar-vcs.org/en/">Documentación</a>&nbsp;|&nbsp;</li>
7{{ super() }}
8{% endblock %}
09
=== added file 'doc/es/conf.py'
--- doc/es/conf.py 1970-01-01 00:00:00 +0000
+++ doc/es/conf.py 2009-09-09 00:34:29 +0000
@@ -0,0 +1,76 @@
1# -*- coding: utf-8 -*-
2#
3# Bazaar documentation build configuration file, created by
4# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
5#
6# This file is execfile()d with the current directory set to its containing dir.
7
8import sys, os
9
10# If extensions (or modules to document with autodoc) are in another directory,
11# add these directories to sys.path here. If the directory is relative to the
12# documentation root, use os.path.abspath to make it absolute, like shown here.
13sys.path = [os.path.abspath('../..')] + sys.path
14
15# Most of the configuration for Bazaar docs is defined here ...
16from bzrlib.doc_generate.sphinx_conf import *
17
18
19## Configuration specific to this site ##
20
21# The locale code for this documentation set
22bzr_locale = 'es'
23
24# Translations & supporting helper function
25bzr_titles = {
26 u'Table of Contents (%s)': u'Contenidos (%s)',
27 u'Bazaar User Guide': u'Guia de Usuario',
28 u'Bazaar User Reference': None,
29 u'Bazaar Release Notes': None,
30 u'Bazaar Upgrade Guide': None,
31 u'Bazaar in five minutes': u'Bazaar en cinco minutos',
32 u'Bazaar Tutorial': None,
33 u'Using Bazaar With Launchpad': None,
34 u'Centralized Workflow Tutorial': None,
35 }
36def bzr_title(s):
37 return bzr_titles.get(s) or s
38
39# The language for content autogenerated by Sphinx. Refer to documentation
40# for a list of supported languages.
41language = bzr_locale
42
43# A shorter title for the navigation bar. Default is the same as html_title.
44html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
45
46# Additional templates that should be rendered to pages, maps page names to
47# template names.
48#html_additional_pages = {'index': 'index.html'}
49
50# Output file base name for HTML help builder.
51htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
52
53# Grouping the document tree into LaTeX files. List of tuples
54# (source start file, target name, title, author, documentclass [howto/manual]).
55latex_documents = [
56 # Manuals
57 ('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
58 bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
59 #('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
60 # bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
61 #('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
62 # bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
63 #('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
64 # bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
65 # Tutorials
66 ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
67 bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
68 #('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
69 # bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
70 #('tutorials/using_bazaar_with_launchpad',
71 # 'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
72 # bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
73 #('tutorials/centralized_workflow',
74 # 'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
75 # bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
76]
077
=== removed directory 'doc/es/developer-guide'
=== renamed file 'doc/index.es.txt' => 'doc/es/index.txt'
--- doc/index.es.txt 2009-06-29 11:02:31 +0000
+++ doc/es/index.txt 2009-09-09 02:30:32 +0000
@@ -1,46 +1,40 @@
1==================================1=================================
2Indice de Documentacion de Bazaar2Indice de Documentacion de Bazaar
3==================================3=================================
44
5Las ultimas versiones de estos documentos se encuentran disponibles5Las ultimas versiones de estos documentos se encuentran disponibles
6en la pagina de Bazaar, http://doc.bazaar-vcs.org.6en la pagina de Bazaar, http://doc.bazaar-vcs.org/en/.
77
8Documentacion Principal8Documentacion Principal
9=======================9=======================
1010
11* `Mini Tutorial <es/mini-tutorial/index.html>`_ 11.. toctree::
1212 :maxdepth: 1
13* `Referencia Rapida <es/quick-reference/quick-start-summary.svg>`_13
1414 mini-tutorial/index
15* `Guia de Usuario <es/user-guide/index.html>`_ 15 quick-reference/index
1616 user-guide/index
17* `Referencia <es/user-reference/bzr_man.html>`_
18
19* `Notas sobre la Version <es/release-notes/NEWS.html>`_
20
21* `Guia del Desarrollador <es/developer-guide/HACKING.html>`_
2217
2318
24Otra Documentacion19Otra Documentacion
25===================20==================
2621
27Mudandose a Bazaar (enlances web):22Mudandose a Bazaar (enlances web):
2823
29* `Guias de Mudanzas <http://bazaar-vcs.org/BzrSwitching>`_ 24* `Guias de Migracion <http://doc.bazaar-vcs.org/migration/en/>`_
30 - para los usuarios que se mudan de otros SCV
31
32* `Guias de Migracion <http://bazaar-vcs.org/BzrMigration>`_
33 - para equipos que mudan el historial de otros SCV25 - para equipos que mudan el historial de otros SCV
3426
27* `Guias de Plugins <http://doc.bazaar-vcs.org/plugins/en/>`_
28
35Otros Documentos (enlances web):29Otros Documentos (enlances web):
3630
37* `Glosario <http://bazaar-vcs.org/BzrGlossary>`_31* `Glosario <http://bazaar-vcs.org/BzrGlossary>`_
3832
39* `Preguntas Frecuentes <http://bazaar-vcs.org/FAQ>`_33* `Preguntas Frecuentes <https://answers.launchpad.net/bzr>`_
4034
41* `Referencia del API bzrlib <http://bazaar-vcs.org/BzrLib>`_35* `Referencia del API bzrlib <http://bazaar-vcs.org/BzrLib>`_
4236
43Especificaciones tecnicas, planes a futuro y varias37Especificaciones tecnicas, planes a futuro y varias
44notas tecnicas varias en Ingles:38notas tecnicas varias en Ingles:
4539
46* `Catalogo de Documentos para Desarrolladores <developers/index.html>`_40* `Catalogo de Documentos para Desarrolladores <http://doc.bazaar-vcs.org/latest/developers/>`_
4741
=== modified file 'doc/es/mini-tutorial/index.txt'
--- doc/es/mini-tutorial/index.txt 2009-06-29 11:02:31 +0000
+++ doc/es/mini-tutorial/index.txt 2009-09-08 01:19:48 +0000
@@ -2,8 +2,6 @@
2Bazaar en cinco minutos2Bazaar en cinco minutos
3=======================3=======================
44
5.. contents:: Contenidos
6
7Introducción5Introducción
8============6============
97
108
=== added file 'doc/es/quick-reference/index.txt'
--- doc/es/quick-reference/index.txt 1970-01-01 00:00:00 +0000
+++ doc/es/quick-reference/index.txt 2009-09-09 02:32:10 +0000
@@ -0,0 +1,6 @@
1Referencia Rapida
2=================
3
4* `PDF format <../_static/es/bzr-es-quick-reference.pdf>`_
5* `PNG format <../_static/es/bzr-es-quick-reference.png>`_
6* `SVG format <../_static/es/bzr-es-quick-reference.svg>`_
07
=== removed directory 'doc/es/release-notes'
=== modified file 'doc/es/user-guide/index.txt'
--- doc/es/user-guide/index.txt 2008-05-12 00:59:13 +0000
+++ doc/es/user-guide/index.txt 2009-09-08 01:19:48 +0000
@@ -10,9 +10,6 @@
10.. level 3 ~~~~~~~~10.. level 3 ~~~~~~~~
11.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)11.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
1212
13.. contents:: :depth: 2
14.. sectnum::
15
1613
17Introducción14Introducción
18############15############
1916
=== removed directory 'doc/es/user-reference'
=== removed file 'doc/index.txt'
--- doc/index.txt 2009-08-10 06:53:44 +0000
+++ doc/index.txt 1970-01-01 00:00:00 +0000
@@ -1,66 +0,0 @@
1============================
2Bazaar Main Document Catalog
3============================
4
5The latest version of these documents are available from Bazaar's
6documentation site, <http://doc.bazaar-vcs.org/>, and more documentation
7may be linked from <http://bazaar-vcs.org/Documentation>.
8
9Core Documentation
10==================
11
12* `User Guide <en/user-guide/index.html>`_
13
14* `User Reference <en/user-reference/bzr_man.html>`_
15
16* `Quick Start Card <_static/en/quick-reference/bzr-quick-reference.svg>`_
17 (`PDF <_static/en/quick-reference/bzr-quick-reference.pdf>`_,
18 `PNG <_static/en/quick-reference/bzr-quick-reference.png>`_)
19
20* `Release Notes <en/release-notes/NEWS.html>`_
21
22* `2.0 Upgrade Guide <en/upgrade-guide/index.html>`_
23
24
25Tutorials
26=========
27
28* `Bazaar in five minutes <en/mini-tutorial/index.html>`_
29
30* `A longer tutorial <en/tutorials/tutorial.html>`_
31
32* `Using Bazaar with Launchpad <en/tutorials/using_bazaar_with_launchpad.html>`_
33
34* `Centralized workflow <en/tutorials/centralized_workflow.html>`_
35
36
37Developer Documentation
38=======================
39
40* `Developer Document Catalog <developers/index.html>`_ |--| for developers
41 of Bazaar and plugins
42
43Web links
44=========
45
46* `Switching Guides <http://bazaar-vcs.org/BzrSwitching>`_
47 |--| for users moving from another VCS tool
48
49* `Migration Guide <http://bazaar-vcs.org/BzrMigration>`_
50 |--| for teams migrating history from another VCS tool
51
52* `Glossary <http://bazaar-vcs.org/BzrGlossary>`_
53
54* `Frequently Asked Questions <http://bazaar-vcs.org/FAQ>`_
55
56
57Other Languages
58===============
59
60* `Spanish Documentation <index.es.html>`_
61* `Russian Documentation <index.ru.html>`_ |--| документация на русском
62
63.. |--| unicode:: U+2014
64
65..
66 vim: ft=rst tw=74 ai
670
=== added directory 'doc/ru/_static'
=== added file 'doc/ru/_static/bzr icon 16.png'
68Binary 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 differ1Binary 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
=== added file 'doc/ru/_static/bzr.ico'
69Binary 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 differ2Binary 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
=== added directory 'doc/ru/_static/ru'
=== renamed file 'doc/ru/quick-reference/Makefile' => 'doc/ru/_static/ru/Makefile'
--- doc/ru/quick-reference/Makefile 2008-08-19 06:29:48 +0000
+++ doc/ru/_static/ru/Makefile 2009-09-07 05:26:43 +0000
@@ -1,5 +1,5 @@
1TARGETS=quick-start-summary.png quick-start-summary.pdf1TARGETS=bzr-quick-reference.png bzr-quick-reference.pdf
2OBJECTS=quick-start-summary.svg Makefile2OBJECTS=bzr-quick-reference.svg Makefile
33
4all: $(TARGETS)4all: $(TARGETS)
55
@@ -11,9 +11,9 @@
11.svg.png:11.svg.png:
12 rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $<12 rsvg-convert -d 300 -p 300 -z 3.3346 -f png -o $@ $<
1313
14bzr-quickref.png: $(OBJECTS)14bzr-quick-reference.png: $(OBJECTS)
1515
16bzr-quickref.pdf: $(OBJECTS)16bzr-quick-reference.pdf: $(OBJECTS)
1717
18clean:18clean:
19 rm -f $(TARGETS)19 rm -f $(TARGETS)
2020
=== renamed file 'doc/ru/quick-reference/quick-start-summary.pdf' => 'doc/ru/_static/ru/bzr-ru-quick-reference.pdf'
=== renamed file 'doc/ru/quick-reference/quick-start-summary.png' => 'doc/ru/_static/ru/bzr-ru-quick-reference.png'
=== renamed file 'doc/ru/quick-reference/quick-start-summary.svg' => 'doc/ru/_static/ru/bzr-ru-quick-reference.svg'
=== added directory 'doc/ru/_templates'
=== added file 'doc/ru/_templates/layout.html'
--- doc/ru/_templates/layout.html 1970-01-01 00:00:00 +0000
+++ doc/ru/_templates/layout.html 2009-09-08 15:06:56 +0000
@@ -0,0 +1,8 @@
1{% extends "!layout.html" %}
2
3{% block rootrellink %}
4<li><a href="http://bazaar-vcs.org/">
5 <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Главная</a>&nbsp;|&nbsp;</li>
6<a href="http://doc.bazaar-vcs.org/ru/">Документация</a>&nbsp;|&nbsp;</li>
7{{ super() }}
8{% endblock %}
09
=== added file 'doc/ru/conf.py'
--- doc/ru/conf.py 1970-01-01 00:00:00 +0000
+++ doc/ru/conf.py 2009-09-09 02:30:32 +0000
@@ -0,0 +1,76 @@
1# -*- coding: utf-8 -*-
2#
3# Bazaar documentation build configuration file, created by
4# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
5#
6# This file is execfile()d with the current directory set to its containing dir.
7
8import sys, os
9
10# If extensions (or modules to document with autodoc) are in another directory,
11# add these directories to sys.path here. If the directory is relative to the
12# documentation root, use os.path.abspath to make it absolute, like shown here.
13sys.path = [os.path.abspath('../..')] + sys.path
14
15# Most of the configuration for Bazaar docs is defined here ...
16from bzrlib.doc_generate.sphinx_conf import *
17
18
19## Configuration specific to this site ##
20
21# The locale code for this documentation set
22bzr_locale = 'ru'
23
24# Translations & supporting helper function
25bzr_titles = {
26 u'Table of Contents (%s)': u'Содержание (%s)',
27 u'Bazaar User Guide': None,
28 u'Bazaar User Reference': None,
29 u'Bazaar Release Notes': None,
30 u'Bazaar Upgrade Guide': None,
31 u'Bazaar in five minutes': u'Базар за пять минут',
32 u'Bazaar Tutorial': u'Большой учебник',
33 u'Using Bazaar With Launchpad': u'Использование Bazaar с Launchpad',
34 u'Centralized Workflow Tutorial': u'Работа в централизованном стиле',
35 }
36def bzr_title(s):
37 return bzr_titles.get(s) or s
38
39# The language for content autogenerated by Sphinx. Refer to documentation
40# for a list of supported languages.
41language = bzr_locale
42
43# A shorter title for the navigation bar. Default is the same as html_title.
44html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
45
46# Additional templates that should be rendered to pages, maps page names to
47# template names.
48#html_additional_pages = {'index': 'index.html'}
49
50# Output file base name for HTML help builder.
51htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
52
53# Grouping the document tree into LaTeX files. List of tuples
54# (source start file, target name, title, author, documentclass [howto/manual]).
55latex_documents = [
56 # Manuals
57 #('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
58 # bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
59 #('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
60 # bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
61 #('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
62 # bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
63 #('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
64 # bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
65 # Tutorials
66 ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
67 bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
68 ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
69 bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
70 #('tutorials/using_bazaar_with_launchpad',
71 # 'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
72 # bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
73 #('tutorials/centralized_workflow',
74 # 'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
75 # bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
76]
077
=== renamed file 'doc/index.ru.txt' => 'doc/ru/index.txt'
--- doc/index.ru.txt 2009-06-02 18:07:12 +0000
+++ doc/ru/index.txt 2009-09-09 02:30:32 +0000
@@ -3,45 +3,26 @@
3=================================3=================================
44
5Последняя версия этих документов доступа со страницы документации 5Последняя версия этих документов доступа со страницы документации
6на сайте Bazaar, <http://doc.bazaar-vcs.org/>. Еще больше информации 6на сайте Bazaar, <http://doc.bazaar-vcs.org/ru/>.
7можно получить по адресу <http://bazaar-vcs.org/Documentation>.
87
9Основная документация8Основная документация
10=====================9=====================
1110
12* `Руководство пользователя <ru/user-guide/index.html>`_11.. toctree::
1312 :maxdepth: 1
14* `Справочник пользователя <en/user-reference/bzr_man.html>`_ (англ.)13
1514 user-guide/index
16* `Карточка быстрого старта <ru/quick-reference/quick-start-summary.svg>`_15 quick-reference/index
17 (`PDF <ru/quick-reference/quick-start-summary.pdf>`_,16 mini-tutorial/index
18 `PNG <ru/quick-reference/quick-start-summary.png>`_)17 tutorials/tutorial
1918 tutorials/using_bazaar_with_launchpad
20* `Список изменений <en/release-notes/NEWS.html>`_ (англ.)19 tutorials/centralized_workflow
2120
22* `Каталог информации для разработчиков <developers/index.html>`_ (англ.) |--|
23 для разработчиков Bazaar и плагинов
24
25Учебники
26========
27
28* `Базар за пять минут <ru/mini-tutorial/index.html>`_
29
30* `Большой учебник <ru/tutorials/tutorial.html>`_
31
32* `Использование Bazaar с Launchpad
33 <ru/tutorials/using_bazaar_with_launchpad.html>`_
34
35* `Работа в централизованном стиле
36 <ru/tutorials/centralized_workflow.html>`_
3721
38Ссылки в сети22Ссылки в сети
39=============23=============
4024
41* `Руководства по переходу <http://bazaar-vcs.org/BzrSwitching>`_25* `Руководство по миграции <http://doc.bazaar-vcs.org/migration/en/>`_
42 |--| для пользователей переходящих с других систем контроля версий
43
44* `Руководство по миграции <http://bazaar-vcs.org/BzrMigration>`_
45 |--| для команд переносящих историю с других систем контроля версий26 |--| для команд переносящих историю с других систем контроля версий
4627
47* `Словарь терминов <http://bazaar-vcs.org/BzrGlossary>`_ (англ.), 28* `Словарь терминов <http://bazaar-vcs.org/BzrGlossary>`_ (англ.),
@@ -49,13 +30,8 @@
49 30
50__ 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%B931__ 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
5132
52* `Часто задаваемые вопросы <http://bazaar-vcs.org/FAQ>`_ (англ.)33* `Часто задаваемые вопросы <https://answers.launchpad.net/bzr>`_ (англ.)
5334
54Другие языки
55============
56
57* `Документация на английском <index.html>`_ |--| English Documentation
58* `Документация на испанском <index.es.html>`_
5935
60.. |--| unicode:: U+201436.. |--| unicode:: U+2014
6137
6238
=== added file 'doc/ru/quick-reference/index.txt'
--- doc/ru/quick-reference/index.txt 1970-01-01 00:00:00 +0000
+++ doc/ru/quick-reference/index.txt 2009-09-09 02:32:10 +0000
@@ -0,0 +1,6 @@
1Карточка быстрого старта
2========================
3
4* `PDF <../_static/ru/bzr-ru-quick-reference.pdf>`_
5* `PNG <../_static/ru/bzr-ru-quick-reference.png>`_
6* `SVG <../_static/ru/bzr-ru-quick-reference.svg>`_
07
=== added file 'tools/generate_release_notes.py'
--- tools/generate_release_notes.py 1970-01-01 00:00:00 +0000
+++ tools/generate_release_notes.py 2009-09-03 05:09:22 +0000
@@ -0,0 +1,86 @@
1#!/usr/bin/python
2
3# Copyright 2009 Canonical Ltd.
4#
5# This program is free software; you can redistribute it and/or modify
6# it under the terms of the GNU General Public License as published by
7# the Free Software Foundation; either version 2 of the License, or
8# (at your option) any later version.
9#
10# This program is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with this program; if not, write to the Free Software
17# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
19import os
20import sys
21from optparse import OptionParser
22
23sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
24
25
26def split_into_topics(lines, out_file, out_dir):
27 """Split a large NEWS file into topics, one per release.
28
29 Releases are detected by matching headings that look like
30 release names. Topics are created with matching names
31 replacing spaces with dashes.
32 """
33 topic_file = None
34 for index, line in enumerate(lines):
35 maybe_new_topic = line[:4] in ['bzr ', 'bzr-0',]
36 if maybe_new_topic and lines[index + 1].startswith('####'):
37 release = line.strip()
38 if topic_file is None:
39 # First topic found
40 out_file.write(".. toctree::\n :maxdepth: 1\n\n")
41 else:
42 # close the current topic
43 topic_file.close()
44 topic_file = open_topic_file(out_file, out_dir, release)
45 elif topic_file:
46 topic_file.write(line)
47 else:
48 # Still in the header - dump content straight to output
49 out_file.write(line)
50
51
52def open_topic_file(out_file, out_dir, release):
53 topic_name = release.replace(' ', '-')
54 out_file.write(" %s\n" % (topic_name,))
55 topic_path = os.path.join(out_dir, "%s.txt" % (topic_name,))
56 result = open(topic_path, 'w')
57 result.write("%s\n" % (release,))
58 return result
59
60
61def main(argv):
62 # Check usage
63 parser = OptionParser(usage="%prog SOURCE DESTINATION")
64 (options, args) = parser.parse_args(argv)
65 if len(args) != 2:
66 parser.print_help()
67 sys.exit(1)
68
69 # Open the files and do the work
70 infile_name = args[0]
71 outfile_name = args[1]
72 outdir = os.path.dirname(outfile_name)
73 infile = open(infile_name, 'r')
74 try:
75 lines = infile.readlines()
76 finally:
77 infile.close()
78 outfile = open(outfile_name, 'w')
79 try:
80 split_into_topics(lines, outfile, outdir)
81 finally:
82 outfile.close()
83
84
85if __name__ == '__main__':
86 main(sys.argv[1:])
087
=== added file 'tools/package_docs.py'
--- tools/package_docs.py 1970-01-01 00:00:00 +0000
+++ tools/package_docs.py 2009-09-09 00:49:50 +0000
@@ -0,0 +1,109 @@
1#!/usr/bin/python
2
3# Copyright 2009 Canonical Ltd.
4#
5# This program is free software; you can redistribute it and/or modify
6# it under the terms of the GNU General Public License as published by
7# the Free Software Foundation; either version 2 of the License, or
8# (at your option) any later version.
9#
10# This program is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with this program; if not, write to the Free Software
17# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
19import os
20import sys
21import tarfile
22from optparse import OptionParser
23from shutil import copy2, copytree, rmtree
24
25sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
26
27
28def package_docs(section, src_build, dest_html, dest_downloads):
29 """Package docs from a Sphinx _build directory into target directories.
30
31 :param section: section in the website being built
32 :param src_build: the _build directory
33 :param dest_html: the directory where html should go
34 :param downloads: the directory where downloads should go
35 """
36 # Copy across the HTML. Explicitly delete the html destination
37 # directory first though because copytree insists on it not existing.
38 src_html = os.path.join(src_build, 'html')
39 if os.path.exists(dest_html):
40 rmtree(dest_html)
41 copytree(src_html, dest_html)
42
43 # Package the html as a downloadable archive
44 archive_root = "bzr-%s-html" % (section,)
45 archive_basename = "%s.tar.bz2" % (archive_root,)
46 archive_name = os.path.join(dest_downloads, archive_basename)
47 build_archive(src_html, archive_name, archive_root, 'bz2')
48
49 # Copy across the PDF docs, if any, including the quick ref card
50 pdf_files = []
51 quick_ref = os.path.join(src_html,
52 '_static/%s/bzr-%s-quick-reference.pdf' % (section, section))
53 if os.path.exists(quick_ref):
54 pdf_files.append(quick_ref)
55 src_pdf = os.path.join(src_build, 'latex')
56 if os.path.exists(src_pdf):
57 for name in os.listdir(src_pdf):
58 if name.endswith('.pdf'):
59 pdf_files.append(os.path.join(src_pdf, name))
60 if pdf_files:
61 dest_pdf = os.path.join(dest_downloads, 'pdf-%s' % (section,))
62 if not os.path.exists(dest_pdf):
63 os.mkdir(dest_pdf)
64 for pdf in pdf_files:
65 copy2(pdf, dest_pdf)
66
67 # TODO: copy across the CHM files, if any
68
69
70def build_archive(src_dir, archive_name, archive_root, format):
71 print "creating %s ..." % (archive_name,)
72 tar = tarfile.open(archive_name, "w:%s" % (format,))
73 for relpath in os.listdir(src_dir):
74 src_path = os.path.join(src_dir, relpath)
75 archive_path = os.path.join(archive_root, relpath)
76 tar.add(src_path, arcname=archive_path)
77 tar.close()
78
79
80def main(argv):
81 # Check usage. The first argument is the parent directory of
82 # the Sphinx _build directory. It will typically be 'doc/xx'.
83 # The second argument is the website build directory.
84 parser = OptionParser(usage="%prog SOURCE-DIR WEBSITE-BUILD-DIR")
85 (options, args) = parser.parse_args(argv)
86 if len(args) != 2:
87 parser.print_help()
88 sys.exit(1)
89
90 # Get the section - locale code or 'developers'
91 src_dir = args[0]
92 section = os.path.basename(src_dir)
93 src_build = os.path.join(src_dir, '_build')
94
95 # Create the destination directories if they doesn't exist.
96 dest_dir = args[1]
97 dest_html = os.path.join(dest_dir, section)
98 dest_downloads = os.path.join(dest_dir, 'downloads')
99 for d in [dest_dir, dest_downloads]:
100 if not os.path.exists(d):
101 print "creating directory %s ..." % (d,)
102 os.mkdir(d)
103
104 # Package and copy the files across
105 package_docs(section, src_build, dest_html, dest_downloads)
106
107
108if __name__ == '__main__':
109 main(sys.argv[1:])

Subscribers

People subscribed via source and target branches