Merge lp:~jelmer/brz/more-doc-improvements into lp:brz

Proposed by Jelmer Vernooij
Status: Merged
Approved by: Jelmer Vernooij
Approved revision: no longer in the source branch.
Merge reported by: The Breezy Bot
Merged at revision: not available
Proposed branch: lp:~jelmer/brz/more-doc-improvements
Merge into: lp:brz
Prerequisite: lp:~jelmer/brz/byov-flake8
Diff against target: 999 lines (+128/-234)
35 files modified
.bzrignore (+1/-0)
Makefile (+12/-18)
breezy/bzr/smart/medium.py (+6/-2)
breezy/doc_generate/conf.py (+18/-8)
breezy/git/Makefile (+0/-80)
byov.conf (+3/-1)
doc/developers/HACKING.txt (+6/-8)
doc/developers/api-readme.txt (+3/-0)
doc/developers/code-style.txt (+1/-1)
doc/developers/conf.py (+1/-1)
doc/developers/contribution-quickstart.txt (+1/-6)
doc/developers/development-repo.txt (+1/-1)
doc/developers/index-plain.txt (+5/-4)
doc/developers/index.txt (+6/-4)
doc/developers/overview.txt (+1/-1)
doc/developers/packrepo.txt (+1/-1)
doc/developers/ppa.txt (+2/-2)
doc/developers/releasing.txt (+2/-2)
doc/en/Makefile (+3/-16)
doc/en/_templates/index.html (+0/-6)
doc/en/admin-guide/backup.txt (+11/-11)
doc/en/admin-guide/hooks-plugins.txt (+2/-2)
doc/en/admin-guide/licence.txt (+5/-2)
doc/en/admin-guide/migration.txt (+3/-3)
doc/en/admin-guide/simple-setups.txt (+8/-8)
doc/en/tutorials/centralized_workflow.txt (+2/-18)
doc/en/tutorials/licence.txt (+4/-1)
doc/en/tutorials/using_breezy_with_launchpad.txt (+0/-13)
doc/en/upgrade-guide/licence.txt (+4/-1)
doc/en/upgrade-guide/overview.txt (+1/-1)
doc/en/user-guide/installing_breezy.txt (+6/-6)
doc/en/user-guide/introducing_breezy.txt (+2/-2)
doc/en/user-guide/licence.txt (+4/-1)
doc/en/user-reference/readme.txt (+1/-1)
doc/index.txt (+2/-2)
To merge this branch: bzr merge lp:~jelmer/brz/more-doc-improvements
Reviewer Review Type Date Requested Status
Martin Packman Approve
Review via email: mp+358955@code.launchpad.net

Commit message

Update more links, add API documentation.

Description of the change

Update more links, add API documentation.

To post a comment you must log in.
Revision history for this message
Martin Packman (gz) wrote :

Thanks! Makefile changes look reasonable.

review: Approve
Revision history for this message
The Breezy Bot (the-breezy-bot) wrote :

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file '.bzrignore'
2--- .bzrignore 2018-08-26 13:52:48 +0000
3+++ .bzrignore 2018-11-18 17:25:59 +0000
4@@ -73,3 +73,4 @@
5 .testrepository
6 selftest.log
7 .coverage
8+doc/developers/api
9
10=== modified file 'Makefile'
11--- Makefile 2018-11-16 13:07:04 +0000
12+++ Makefile 2018-11-18 17:25:59 +0000
13@@ -105,12 +105,6 @@
14 rm -f breezy/*_pyx.c breezy/bzr/*_pyx.c
15 rm -f breezy/_simple_set_pyx.h breezy/_simple_set_pyx_api.h
16
17-# Build API documentation
18-docfiles = brz breezy
19-api-docs:
20- mkdir -p api/html
21- pydoctor --make-html --docformat='restructuredtext' --html-output=api/html $(docfiles)
22-
23 # build tags for emacs and vim
24 TAGS:
25 ctags -R -e breezy
26@@ -159,8 +153,8 @@
27
28 # Clean out generated documentation
29 clean-sphinx:
30- cd doc/en && make clean
31- cd doc/developers && make clean
32+ $(MAKE) -C doc/en clean
33+ $(MAKE) -C doc/developers clean
34
35 SPHINX_DEPENDENCIES = \
36 doc/en/release-notes/index.txt \
37@@ -184,8 +178,8 @@
38
39 # Build the html docs using Sphinx.
40 html-sphinx: $(SPHINX_DEPENDENCIES)
41- cd doc/en && make html
42- cd doc/developers && make html
43+ $(MAKE) -C doc/en html
44+ $(MAKE) -C doc/developers api html
45
46 # Build the PDF docs using Sphinx. This requires numerous LaTeX
47 # packages. See http://sphinx.pocoo.org/builders.html for details.
48@@ -193,23 +187,23 @@
49 # they require additional packages to be installed (to handle
50 # Russian hyphenation rules, etc.)
51 pdf-sphinx: $(SPHINX_DEPENDENCIES)
52- cd doc/en && make latex
53- cd doc/developers && make latex
54- cd doc/en/_build/latex && make all-pdf
55- cd doc/developers/_build/latex && make all-pdf
56+ $(MAKE) -C doc/en latex
57+ $(MAKE) -C doc/developers latex
58+ $(MAKE) -C doc/en/_build/latex all-pdf
59+ $(MAKE) -C doc/developers/_build/latex all-pdf
60
61 # Build the CHM (Windows Help) docs using Sphinx.
62 # Note: HtmlHelp Workshop needs to be used on the generated hhp files
63 # to generate the final chm files.
64 chm-sphinx: $(SPHINX_DEPENDENCIES)
65- cd doc/en && make htmlhelp
66- cd doc/developers && make htmlhelp
67+ $(MAKE) -C doc/en htmlhelp
68+ $(MAKE) -C doc/developers htmlhelp
69
70
71 # Build the texinfo files using Sphinx.
72 texinfo-sphinx: $(SPHINX_DEPENDENCIES)
73- cd doc/en && make texinfo
74- cd doc/developers && make texinfo
75+ $(MAKE) -C doc/en texinfo
76+ $(MAKE) -C doc/developers texinfo
77
78 ### Documentation Website ###
79
80
81=== modified file 'breezy/bzr/smart/medium.py'
82--- breezy/bzr/smart/medium.py 2018-11-11 04:08:32 +0000
83+++ breezy/bzr/smart/medium.py 2018-11-18 17:25:59 +0000
84@@ -32,12 +32,16 @@
85 import sys
86 import time
87
88+try:
89+ import _thread
90+except ImportError:
91+ import thread as _thread
92+
93 import breezy
94 from ...lazy_import import lazy_import
95 lazy_import(globals(), """
96 import select
97 import socket
98-import thread
99 import weakref
100
101 from breezy import (
102@@ -432,7 +436,7 @@
103 tstart = osutils.timer_func()
104 osutils.send_all(self.socket, bytes, self._report_activity)
105 if 'hpss' in debug.debug_flags:
106- thread_id = thread.get_ident()
107+ thread_id = _thread.get_ident()
108 trace.mutter('%12s: [%s] %d bytes to the socket in %.3fs'
109 % ('wrote', thread_id, len(bytes),
110 osutils.timer_func() - tstart))
111
112=== modified file 'breezy/doc_generate/conf.py'
113--- breezy/doc_generate/conf.py 2018-11-18 02:43:52 +0000
114+++ breezy/doc_generate/conf.py 2018-11-18 17:25:59 +0000
115@@ -21,7 +21,13 @@
116
117 # Add any Sphinx extension module names here, as strings. They can be extensions
118 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
119-extensions = ['sphinx.ext.ifconfig', ]
120+extensions = [
121+ 'sphinx.ext.ifconfig',
122+ 'sphinx.ext.autodoc',
123+ 'sphinx.ext.intersphinx',
124+ 'sphinx_epytext',
125+ # 'sphinxcontrib.napoleon', # TODO: for Google docstrings
126+ ]
127
128 # Add any paths that contain templates here, relative to this directory.
129 templates_path = ['_templates']
130@@ -107,15 +113,15 @@
131 # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
132 # midnightblue
133 # * gray: dimgray, slategray, lightslategray
134- 'sidebarbgcolor': "cornflowerblue",
135- 'sidebarlinkcolor': "midnightblue",
136- 'relbarbgcolor': "darkblue",
137- 'footerbgcolor': "lightslategray",
138+ #'sidebarbgcolor': "cornflowerblue",
139+ #'sidebarlinkcolor': "midnightblue",
140+ #'relbarbgcolor': "darkblue",
141+ #'footerbgcolor': "lightslategray",
142
143 # Text, heading and code colouring
144- 'codebgcolor': "lightyellow",
145- 'codetextcolor': "firebrick",
146- 'linkcolor': "mediumblue",
147+ #'codebgcolor': "lightyellow",
148+ #'codetextcolor': "firebrick",
149+ #'linkcolor': "mediumblue",
150 }
151
152 # Add any paths that contain custom themes here, relative to this directory.
153@@ -216,3 +222,7 @@
154
155 # Authors of the documents
156 brz_team = u'Breezy Developers'
157+
158+intersphinx_mapping = {
159+ 'python': ('https://docs.python.org/3', None),
160+}
161
162=== removed file 'breezy/git/Makefile'
163--- breezy/git/Makefile 2018-03-26 22:28:24 +0000
164+++ breezy/git/Makefile 1970-01-01 00:00:00 +0000
165@@ -1,80 +0,0 @@
166-DEBUGGER ?=
167-BRZ_OPTIONS ?=
168-BRZ ?= $(shell which brz)
169-PYTHON ?= $(shell which python)
170-SETUP ?= ./setup.py
171-PYDOCTOR ?= pydoctor
172-CTAGS ?= ctags
173-PYLINT ?= pylint
174-RST2HTML ?= rst2html
175-TESTS ?= ^breezy.plugins.git. Git breezy.tests.test_info.TestInfo.test_describe_tree_format breezy.tests.test_errors.TestErrors.test_no_arg_named_message breezy.tests.test_info.TestInfo.test_describe_checkout_format
176-SUBUNIT_FILTER ?= subunit-filter --fixup-expected-failures=xfail --success --xfail
177-SUBUNIT_FORMATTER = subunit2pyunit
178-
179-all:: build
180-
181-build::
182- $(SETUP) build
183-
184-build-inplace::
185-
186-install::
187- $(SETUP) install
188-
189-clean::
190- $(SETUP) clean
191- rm -f *.so
192-
193-check:: build-inplace
194- BRZ_PLUGINS_AT=git@$(shell pwd) BRZ_PLUGIN_PATH=-site:-user $(DEBUGGER) $(PYTHON) $(PYTHON_OPTIONS) $(BRZ) $(BRZ_OPTIONS) selftest --subunit2 $(TEST_OPTIONS) $(TESTS) | $(SUBUNIT_FILTER) | $(SUBUNIT_FORMATTER)
195-
196-list-failing-tests:
197- $(MAKE) check SUBUNIT_FILTER="subunit-filter -F" SUBUNIT_FORMATTER=subunit-ls | grep -e "^breezy\\." | sort
198-
199-xfail:
200- $(MAKE) -s list-failing-tests > xfail
201-
202-check-all::
203- $(MAKE) check TESTS="^breezy.plugins.git. Git" SUBUNIT_FILTER=cat
204-
205-check-verbose::
206- $(MAKE) check TEST_OPTIONS=-v
207-
208-check-one::
209- $(MAKE) check TEST_OPTIONS=--one
210-
211-check-random::
212- $(MAKE) check TEST_OPTIONS="--random=now --verbose --one"
213-
214-show-plugins::
215- BRZ_PLUGINS_AT=git@$(shell pwd) $(BRZ) plugins -v
216-
217-lint::
218- $(PYLINT) -f parseable *.py */*.py
219-
220-tags::
221- $(CTAGS) -R .
222-
223-ctags:: tags
224-
225-coverage::
226- $(MAKE) check BRZ_OPTIONS="--coverage coverage"
227-
228-.PHONY: update-pot po/brz-git.pot
229-update-pot: po/brz-git.pot
230-
231-TRANSLATABLE_PYFILES:=$(shell find . -name '*.py' \
232- | grep -v 'tests/' \
233- )
234-
235-po/brz-git.pot: $(PYFILES) $(DOCFILES)
236- BRZ_PLUGINS_AT=git@$(shell pwd) brz export-pot \
237- --plugin=git > po/brz-git.pot
238- echo $(TRANSLATABLE_PYFILES) | xargs \
239- xgettext --package-name "brz-git" \
240- --msgid-bugs-address "<bazaar@lists.canonical.com>" \
241- --copyright-holder "Canonical Ltd <canonical-bazaar@lists.canonical.com>" \
242- --from-code ISO-8859-1 --sort-by-file --join --add-comments=i18n: \
243- -d brz-git -p po -o brz-git.pot
244-
245-.PHONY: xfail
246
247=== modified file 'byov.conf'
248--- byov.conf 2018-11-18 17:25:59 +0000
249+++ byov.conf 2018-11-18 17:25:59 +0000
250@@ -9,6 +9,8 @@
251 fastimport.clone = (git clone git://jelmer.uk/python-fastimport.git ../fastimport.git)
252 fastimport.install = (cd ../fastimport.git && ./setup.py install --user)
253 fastimport.install3 = (cd ../fastimport.git && python3 ./setup.py install --user)
254+sphinx_epytext.install = (pip install sphinx_epytext)
255+sphinx_epytext.install3 = (pip3 install sphinx_epytext)
256 flake8.install = (pip install flake8)
257 flake8.install3 = (pip3 install flake8)
258
259@@ -28,7 +30,7 @@
260 vm.packages = {brz.build_deps}, {subunit.build_deps}, bzr, git, python-junitxml
261 [brz-xenial]
262 vm.release = xenial
263-byoci.setup.command = ({dulwich.clone} && {dulwich.install} && {dulwich.install3} && {fastimport.clone} && {fastimport.install} && {fastimport.install3} && {subunit.clone} && {flake8.install} && {flake8.install3})
264+byoci.setup.command = ({dulwich.clone} && {dulwich.install} && {dulwich.install3} && {fastimport.clone} && {fastimport.install} && {fastimport.install3} && {subunit.clone} && {flake8.install} && {flake8.install3} && {sphinx_epytext.install} && {sphinx_epytext.install3})
265 # FIXME: bzr log -l2 should be by default -- vila 2018-03-09
266 byoci.tests.command = bash -o pipefail -c "bzr log -l2 && PYTHONPATH=../subunit/python:$PYTHONPATH PATH=../subunit/filters:$PATH make check-ci | subunit2junitxml -o ../results.xml -f | subunit2pyunit"
267 [brz-bionic]
268
269=== modified file 'doc/developers/HACKING.txt'
270--- doc/developers/HACKING.txt 2018-04-01 17:37:15 +0000
271+++ doc/developers/HACKING.txt 2018-11-18 17:25:59 +0000
272@@ -12,7 +12,7 @@
273 document, send a merge request or new text to the mailing list.
274
275 The latest developer documentation can be found online at
276-http://doc.bazaar.canonical.com/developers/.
277+https://www.breezy-vcs.org/developers/.
278
279 Getting Started
280 ###############
281@@ -52,7 +52,7 @@
282
283 There is a very active community around Breezy. Mostly we meet on IRC
284 (#bzr on irc.freenode.net) and on the mailing list. To join the Breezy
285-community, see http://wiki.bazaar.canonical.com/BzrSupport.
286+community, see https://www.breezy-vcs.org/pages/support.html.
287
288 If you are planning to make a change, it's a very good idea to mention it
289 on the IRC channel and/or on the mailing list. There are many advantages
290@@ -205,9 +205,7 @@
291
292 * Patch Queue Manager - https://launchpad.net/pqm/
293
294-For further information, see <http://wiki.bazaar.canonical.com/BzrDevelopment>.
295-
296-
297+For further information, see <https://www.breezy-vcs.org/developers/>.
298
299
300 Preparing a Sandbox for Making Changes to Breezy
301@@ -294,10 +292,10 @@
302
303
304 Automatically-generated API reference information is available at
305-<http://people.canonical.com/~mwh/bzrlibapi/>.
306+<https://www.breezy-vcs.org/developers/api/>.
307
308 See also the `Breezy Architectural Overview
309-<http://doc.bazaar.canonical.com/developers/overview.html>`_.
310+<https://www.breezy-vcs.org/developers/overview.html>`_.
311
312
313 Core Topics
314@@ -533,7 +531,7 @@
315
316 * reviewing changes
317 * planning releases
318-* managing releases (see `Releasing Breezy <http://doc.bazaar.canonical.com/developers/releasing.html>`_)
319+* managing releases (see `Releasing Breezy <https://www.breezy-vcs.org/developers/releasing.html>`_)
320
321 .. note::
322 Removing barriers to community participation is a key reason for adopting
323
324=== added file 'doc/developers/api-readme.txt'
325--- doc/developers/api-readme.txt 1970-01-01 00:00:00 +0000
326+++ doc/developers/api-readme.txt 2018-11-18 17:25:59 +0000
327@@ -0,0 +1,3 @@
328+This is the API documentation for Breezy.
329+
330+It's still a work in progress.
331
332=== modified file 'doc/developers/code-style.txt'
333--- doc/developers/code-style.txt 2017-11-11 12:51:45 +0000
334+++ doc/developers/code-style.txt 2018-11-18 17:25:59 +0000
335@@ -396,7 +396,7 @@
336 =============
337
338 All code should be exercised by the test suite. See the `Bazaar Testing
339-Guide <http://doc.bazaar.canonical.com/developers/testing.html>`_ for detailed
340+Guide <http://www.breezy-vcs.org/developers/testing.html>`_ for detailed
341 information about writing tests.
342
343
344
345=== modified file 'doc/developers/conf.py'
346--- doc/developers/conf.py 2018-11-16 13:05:23 +0000
347+++ doc/developers/conf.py 2018-11-18 17:25:59 +0000
348@@ -10,7 +10,7 @@
349 # If extensions (or modules to document with autodoc) are in another directory,
350 # add these directories to sys.path here. If the directory is relative to the
351 # documentation root, use os.path.abspath to make it absolute, like shown here.
352-sys.path = [os.path.abspath('../..')] + sys.path
353+sys.path = [os.path.abspath('../..'), os.path.abspath('api')] + sys.path
354
355 # Most of the configuration for Breezy docs is defined here ...
356 from breezy.doc_generate.conf import *
357
358=== modified file 'doc/developers/contribution-quickstart.txt'
359--- doc/developers/contribution-quickstart.txt 2017-11-11 12:51:45 +0000
360+++ doc/developers/contribution-quickstart.txt 2018-11-18 17:25:59 +0000
361@@ -8,14 +8,9 @@
362 You can ask at any time for help, on the list, on irc, or through a merge
363 proposal on Launchpad.
364
365-In particular, the rostered
366-`Patch Pilot <http://wiki.bazaar.canonical.com/PatchPilot>`_
367-is an experienced developer who will help you get your changes in, through
368-code review, advice, debugging, writing tests, or whatever it takes.
369-
370 * `Bazaar mailing list <http://lists.ubuntu.com/mailman/listinfo/bazaar>`_
371
372-* IRC in channel ``#bzr`` on ``irc.ubuntu.com``
373+* IRC in channel ``#bzr`` on ``irc.freenode.net``
374
375
376 Starting
377
378=== modified file 'doc/developers/development-repo.txt'
379--- doc/developers/development-repo.txt 2017-11-11 12:51:45 +0000
380+++ doc/developers/development-repo.txt 2018-11-18 17:25:59 +0000
381@@ -171,7 +171,7 @@
382
383 If you need any help or encounter any problems, please contact the developers
384 via the usual ways, i.e. chat to us on IRC or send a message to our mailing
385-list. See http://wiki.bazaar.canonical.com/BzrSupport for contact details.
386+list. See https://www.breezy-vcs.org/pages/support.html for contact details.
387
388
389 Technical notes
390
391=== modified file 'doc/developers/index-plain.txt'
392--- doc/developers/index-plain.txt 2017-11-11 12:51:45 +0000
393+++ doc/developers/index-plain.txt 2018-11-18 17:25:59 +0000
394@@ -11,7 +11,7 @@
395 * `Architectural Overview <overview.html>`_ |--| describes some of the
396 most important classes and concepts.
397
398-* `bzrlib API reference <http://people.canonical.com/~mwh/bzrlibapi/>`_
399+* `breezy API reference <https://www.breezy-vcs.org/developers/api/>`_
400 (external link)
401 |--| automatically generated API reference information
402
403@@ -77,7 +77,7 @@
404 Specifications
405 ==============
406
407-* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
408+* `API versioning <api-versioning.html>`_ |--| breezy API versioning.
409
410 * `Apport error reporting <apport.html>`_ |--| Capture data to report
411 bugs.
412@@ -93,7 +93,8 @@
413 * `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
414 technology used in CHK repositories.
415
416-* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
417+* `Indices <indices.html>`_ |--| The index facilities available within
418+ breezy.
419
420 * `Inventories <inventory.html>`_ |--| Tree shape abstraction.
421
422@@ -108,7 +109,7 @@
423 * `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
424 for repositories (a layer above the container format).
425
426-* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
427+* `Integration Guide <integration.html>`_ |--| A guide to integrate breezy into
428 any python application.
429
430 * `Breezy and case-insensitive file systems <case-insensitive-file-systems.html>`_
431
432=== modified file 'doc/developers/index.txt'
433--- doc/developers/index.txt 2017-11-11 12:51:45 +0000
434+++ doc/developers/index.txt 2018-11-18 17:25:59 +0000
435@@ -51,7 +51,7 @@
436 ec2
437
438
439-Developing using bzrlib
440+Developing using breezy
441 =======================
442
443 .. toctree::
444@@ -62,8 +62,7 @@
445
446 * `Writing plugins for Breezy <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_ (web link)
447
448-* `bzrlib API reference <http://people.canonical.com/~mwh/bzrlibapi/>`_
449- (web link)
450+* `breezy API reference <api/index.txt>`_
451
452
453 Other documents
454@@ -82,7 +81,10 @@
455 Licence
456 ============
457
458-Copyright 2005-2011 Canonical Ltd. Breezy is free software, and you
459+Copyright 2005-2011 Canonical Ltd.
460+Copyright 2018 Breezy Developers
461+
462+Breezy is free software, and you
463 may use, modify and redistribute both Breezy and this document under
464 the terms of the GNU General Public License version 2 or later. See
465 <http://www.gnu.org/licenses/>.
466
467=== modified file 'doc/developers/overview.txt'
468--- doc/developers/overview.txt 2017-11-11 12:51:45 +0000
469+++ doc/developers/overview.txt 2018-11-18 17:25:59 +0000
470@@ -425,7 +425,7 @@
471 Stores cryptographic signatures of revision contents. The keys match
472 those of the revision store.
473
474-.. _Core Concepts: http://doc.bazaar.canonical.com/latest/en/user-guide/core_concepts.html
475+.. _Core Concepts: https://www.breezy-vcs.org/doc/en/user-guide/core_concepts.html
476
477 ..
478 vim: ft=rst tw=74 ai
479
480=== modified file 'doc/developers/packrepo.txt'
481--- doc/developers/packrepo.txt 2017-11-11 12:51:45 +0000
482+++ doc/developers/packrepo.txt 2018-11-18 17:25:59 +0000
483@@ -138,7 +138,7 @@
484
485 If you need any help or encounter any problems, please contact the developers
486 via the usual ways, i.e. chat to us on IRC or send a message to our mailing
487-list. See http://wiki.bazaar.canonical.com/BzrSupport for contact details.
488+list. See https://www.breezy-vcs.org/pages/support.html for contact details.
489
490
491 Technical notes
492
493=== modified file 'doc/developers/ppa.txt'
494--- doc/developers/ppa.txt 2017-11-11 12:51:45 +0000
495+++ doc/developers/ppa.txt 2018-11-18 17:25:59 +0000
496@@ -74,11 +74,11 @@
497 We build packages for every supported Ubuntu release
498 <https://wiki.ubuntu.com/Releases>. Packages need no longer be updated
499 when the release passes end-of-life because all users should
500-have upgraded by then.
501+have upgraded by then.
502
503 As of August 2010, the following releases are supported:
504
505-* Maverick
506+* Maverick
507 * Lucid LTS
508 * Karmic
509 * Jaunty (support ends October 2010)
510
511=== modified file 'doc/developers/releasing.txt'
512--- doc/developers/releasing.txt 2018-11-17 19:23:43 +0000
513+++ doc/developers/releasing.txt 2018-11-18 17:25:59 +0000
514@@ -4,7 +4,7 @@
515 This document describes the processes for making and announcing a Breezy
516 release, and managing the release process. This is just one phase of the
517 `overall development cycle
518-<http://doc.bazaar.canonical.com/developers/cycle.html>`_, (go re-read this
519+<https://www.breezy-vcs.org/developers/cycle.html>`_, (go re-read this
520 document to ensure it hasn't been updated since you last read it) but it's
521 the most complex part.
522
523@@ -518,7 +518,7 @@
524 #. Announce on the Breezy website.
525
526 #. Check that the documentation for this release is available in
527- <http://doc.bazaar.canonical.com>. It should be automatically build when
528+ <https://www.breezy-vcs.org/doc/en/>. It should be automatically build when
529 the branch is created, by a cron script ``update-brz-docs`` on
530 ``escudero``. When the first release is created in a new series, a branch
531 needs to be created on ``escudero``::
532
533=== modified file 'doc/en/Makefile'
534--- doc/en/Makefile 2012-03-09 16:48:55 +0000
535+++ doc/en/Makefile 2018-11-18 17:25:59 +0000
536@@ -11,22 +11,6 @@
537 PAPEROPT_letter = -D latex_paper_size=letter
538 ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
539
540-# Note that this assumes name of the output dir is same as name of the rule.
541-define make_output_dirs
542-# Create output directory (only needed for sphinx < 0.5)
543-[ -d _build ] || mkdir _build
544-[ -d "_build/$@" ] || mkdir "_build/$@"
545-# Workaround for a bug in sphinx < 0.5 where it tries to delete
546-# nonexistent static dirs and does not catch the exception. This was
547-# fixed in svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x
548-# at r65551 and merged as 280b62246342 in hg branch released as 0.5.
549-[ -d "_build/$@/_static" ] || mkdir "_build/$@/_static"
550-for fn in _static/*; do \
551- [ ! -d "$$fn" ] && continue; \
552- [ -d "_build/$@/$$fn" ] || mkdir "_build/$@/$$fn"; \
553-done
554-endef
555-
556 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
557
558 help:
559@@ -45,6 +29,9 @@
560 clean:
561 -rm -rf _build/*
562
563+api:
564+ sphinx-apidoc -feM -s txt -o api ../../breezy
565+
566 html:
567 $(make_output_dirs)
568 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
569
570=== modified file 'doc/en/_templates/index.html'
571--- doc/en/_templates/index.html 2018-09-14 09:31:24 +0000
572+++ doc/en/_templates/index.html 2018-11-18 17:25:59 +0000
573@@ -60,12 +60,6 @@
574 <span class="linkdescr">help on popular plugins</span>
575 </p>
576 </td></tr>
577-
578- <tr><td colspan="2">
579- These documents are also available in <a href="../es/index.html">Spanish</a>,
580- <a href="../ja/index.html">Japanese</a>,
581- and <a href="../ru/index.html">Russian</a>.
582- </td></tr>
583 </table>
584
585 {% endblock %}
586
587=== modified file 'doc/en/admin-guide/backup.txt'
588--- doc/en/admin-guide/backup.txt 2009-12-16 02:03:31 +0000
589+++ doc/en/admin-guide/backup.txt 2018-11-18 17:25:59 +0000
590@@ -57,8 +57,8 @@
591 ::
592
593 $ cd /var/backup
594- $ bzr branch bzr+ssh://server.example.com/srv/bzr/trunk
595- $ bzr branch bzr+ssh://server.example.com/srv/bzr/feature-gui
596+ $ brz branch bzr+ssh://server.example.com/srv/bzr/trunk
597+ $ brz branch bzr+ssh://server.example.com/srv/bzr/feature-gui
598
599 to create the branches on the backup server. Then, we could regularly (for
600 example from ``cron``) do
601@@ -66,9 +66,9 @@
602 ::
603
604 $ cd /var/backup/trunk
605- $ bzr pull # the location to pull from is remembered
606+ $ brz pull # the location to pull from is remembered
607 $ cd ../var/backup/feature-gui
608- $ bzr pull # again, the parent location is remembered
609+ $ brz pull # again, the parent location is remembered
610
611 The action of pulling from the parent for all branches in some directory is
612 common enough that there is a plugin to do it. The `bzrtools`_ plugin
613@@ -82,7 +82,7 @@
614 ::
615
616 $ cd /var/backup
617- $ bzr multi-pull
618+ $ brz multi-pull
619
620 Note that ``multi-pull`` does a pull in *every* branch in the specified
621 directory (the current directory by default) and care should be taken that
622@@ -108,18 +108,18 @@
623 ::
624
625 $ cd /srv/bzr/projectx/trunk
626- $ bzr push bzr+ssh://backup.example.com/var/backup/trunk
627+ $ brz push bzr+ssh://backup.example.com/var/backup/trunk
628 $ cd ../feature-gui
629- $ bzr push bzr+ssh://backup.example.com/var/backup/feature-gui
630+ $ brz push bzr+ssh://backup.example.com/var/backup/feature-gui
631
632 and then we need to bind the main branches to their backups
633
634 ::
635
636 $ cd ../trunk
637- $ bzr bind bzr+ssh://backup.example.com/var/backup/trunk
638+ $ brz bind bzr+ssh://backup.example.com/var/backup/trunk
639 $ cd ../feature-gui
640- $ bzr bind bzr+ssh://backup.example.com/var/backup/feature-gui
641+ $ brz bind bzr+ssh://backup.example.com/var/backup/feature-gui
642
643 A branch can only be bound to a single location, so multiple backups cannot
644 be created using this method.
645@@ -197,8 +197,8 @@
646 $ cd /srv
647 $ mv bzr bzr.old
648 $ cd bzr
649- $ bzr branch bzr+ssh://backup.example.com/var/backup/trunk
650- $ bzr branch bzr+ssh://backup.example.com/var/backup/feature-gui
651+ $ brz branch bzr+ssh://backup.example.com/var/backup/trunk
652+ $ brz branch bzr+ssh://backup.example.com/var/backup/feature-gui
653
654 If there are multiple backups, then change the URL above to restore from the
655 other backups.
656
657=== modified file 'doc/en/admin-guide/hooks-plugins.txt'
658--- doc/en/admin-guide/hooks-plugins.txt 2010-08-13 19:08:57 +0000
659+++ doc/en/admin-guide/hooks-plugins.txt 2018-11-18 17:25:59 +0000
660@@ -96,7 +96,7 @@
661
662 ::
663
664- $ bzr_hookless_email.py --email=projectx-commits@example.com \
665+ $ brz_hookless_email.py --email=projectx-commits@example.com \
666 --recurse /srv/bzr
667
668 email-notifier
669@@ -143,7 +143,7 @@
670
671 ::
672
673- $ bzr-email-notifier.py --config=/srv/bzr/email-notifier.conf /srv/bzr/projectx
674+ $ brz-email-notifier.py --config=/srv/bzr/email-notifier.conf /srv/bzr/projectx
675
676 will watch all branches under the given directory for commits, branch
677 creations and branch deletions.
678
679=== modified file 'doc/en/admin-guide/licence.txt'
680--- doc/en/admin-guide/licence.txt 2011-05-16 10:05:25 +0000
681+++ doc/en/admin-guide/licence.txt 2018-11-18 17:25:59 +0000
682@@ -1,7 +1,10 @@
683 Licence
684 ===============
685
686-Copyright 2008-2011 Canonical Ltd. Bazaar is free software, and you
687-may use, modify and redistribute both Bazaar and this document under
688+Copyright 2008-2011 Canonical Ltd.
689+Copyright 2018 Breezy Developers
690+
691+Breezy is free software, and you
692+may use, modify and redistribute both Breezy and this document under
693 the terms of the GNU General Public License version 2 or later. See
694 <http://www.gnu.org/licenses/>.
695
696=== modified file 'doc/en/admin-guide/migration.txt'
697--- doc/en/admin-guide/migration.txt 2012-01-17 17:22:36 +0000
698+++ doc/en/admin-guide/migration.txt 2018-11-18 17:25:59 +0000
699@@ -35,9 +35,9 @@
700 ::
701
702 $ cd /srv/bzr/projectx
703- $ bzr fast-export-from-hg ../../hg/projectx projectx.fi
704- $ bzr init trunk
705- $ bzr fast-import projectx.fi trunk
706+ $ brz fast-export-from-hg ../../hg/projectx projectx.fi
707+ $ brz init trunk
708+ $ brz fast-import projectx.fi trunk
709
710 Subversion Conversion
711 ---------------------
712
713=== modified file 'doc/en/admin-guide/simple-setups.txt'
714--- doc/en/admin-guide/simple-setups.txt 2011-08-24 09:34:35 +0000
715+++ doc/en/admin-guide/simple-setups.txt 2018-11-18 17:25:59 +0000
716@@ -37,12 +37,12 @@
717 Clients can access the branches using URLs with the ``bzr+ssh://`` prefix. For
718 example, to get a local copy of the ProjectX trunk, a developer could do::
719
720- $ bzr branch bzr+ssh://server.example.com/srv/bzr/projectx/trunk projectx
721+ $ brz branch bzr+ssh://server.example.com/srv/bzr/projectx/trunk projectx
722
723 If the developers have write access to the ``/srv/bzr/projectx`` directory, then
724 they can create new branches themselves using::
725
726- $ bzr branch bzr+ssh://server.example.com/srv/bzr/projectx/trunk \
727+ $ brz branch bzr+ssh://server.example.com/srv/bzr/projectx/trunk \
728 bzr+ssh://server.example.com/srv/bzr/projectx/feature-gui
729
730 Of course, if this isn't desired, then developers should not have write access
731@@ -55,7 +55,7 @@
732 shared repository to hold all of the branches. To set this up, do::
733
734 $ cd /srv/bzr
735- $ bzr init-repo --no-trees projectx
736+ $ brz init-repo --no-trees projectx
737
738 The ``--no-trees`` option saves space by not creating a copy of the working
739 files on the server's filesystem. Then, any branch created under
740@@ -69,7 +69,7 @@
741 ``BZR_REMOTE_PATH`` environment variable. For example, if the Bazaar executable
742 is installed in ``/usr/local/bzr-2.0/bin/bzr``, then a developer could use::
743
744- $ BZR_REMOTE_PATH=/usr/local/bzr-2.0/bin/bzr bzr info \
745+ $ brz_REMOTE_PATH=/usr/local/bzr-2.0/bin/bzr bzr info \
746 bzr+ssh://server.example.com/srv/bzr/proectx/trunk
747
748 to get information about the trunk branch. The remote path can also be
749@@ -81,11 +81,11 @@
750 refer to the home directory of user ``username``. For example, if there are two
751 developers ``alice`` and ``bob``, then Bob could use::
752
753- $ bzr log bzr+ssh://server.example.com/~/fix-1023
754+ $ brz log bzr+ssh://server.example.com/~/fix-1023
755
756 to refer to one of his bug fix branches and::
757
758- $ bzr log bzr+ssh://server.example.com/~alice/fix-2047
759+ $ brz log bzr+ssh://server.example.com/~alice/fix-2047
760
761 to refer to one of Alice's branches. [#]_
762
763@@ -133,10 +133,10 @@
764
765 If Alice logs in she uses the following command for her fix-1023 branch::
766
767- $ bzr log bzr+ssh://bzruser@server.example.com/fix-1023
768+ $ brz log bzr+ssh://bzruser@server.example.com/fix-1023
769
770 If Repo Manager logs in he uses the following command to access Alice's
771 fix-1023::
772
773- $ bzr log bzr+ssh://bzruser@server.example.com/alice/fix-1023
774+ $ brz log bzr+ssh://bzruser@server.example.com/alice/fix-1023
775
776
777=== modified file 'doc/en/tutorials/centralized_workflow.txt'
778--- doc/en/tutorials/centralized_workflow.txt 2017-06-02 21:28:05 +0000
779+++ doc/en/tutorials/centralized_workflow.txt 2018-11-18 17:25:59 +0000
780@@ -215,28 +215,13 @@
781 we have a checkout, any commits made in the ``~/work/sigil/doodle-fixes/``
782 will also show up on ``centralhost``. [#nestedbranches]_ It is also
783 possible to have two developers collaborate on one of these branches, just
784-like they would have collaborated on the ``dev`` branch. [#cbranch]_
785+like they would have collaborated on the ``dev`` branch.
786
787 .. [#nestedbranches] It may look odd to have a branch in a subdirectory of
788 another branch. This is just fine, and you can think of it as a
789 hierarchical namespace where the nested branch is derived from the
790 outer branch.
791
792-.. [#cbranch] When using lots of independent branches, having to retype
793- the full URL all the time takes a lot of typing. We are looking into
794- various methods to help with this, such as branch aliases, etc. For
795- now, though, the brztools_ plugin provides the ``brz cbranch`` command.
796- Which is designed to take a base branch, create a new public branch,
797- and create a checkout of that branch, all with much less typing.
798- Configuring ``cbranch`` is outside the scope of this document, but the
799- final commands are similar to:
800-
801-::
802-
803- % brz cbranch dev my-feature-branch
804-
805-.. _brztools: http://wiki.bazaar.canonical.com/brzTools
806-
807
808 Merging changes back
809 --------------------
810@@ -282,8 +267,7 @@
811 brz+ssh://centralhost/srv/brz/sigil/user-b
812
813 This gives each developer their own branch to work on. And, they can
814-easily create a new feature branch for themselves with just [#cbranch]_
815-::
816+easily create a new feature branch for themselves::
817
818 % brz branch brz+ssh://centralhost/srv/brz/sigil/user-a \
819 brz+ssh://centralhost/srv/brz/sigil/user-a/feature
820
821=== modified file 'doc/en/tutorials/licence.txt'
822--- doc/en/tutorials/licence.txt 2017-05-21 13:35:49 +0000
823+++ doc/en/tutorials/licence.txt 2018-11-18 17:25:59 +0000
824@@ -1,7 +1,10 @@
825 Licence
826 ===============
827
828-Copyright 2005-2011 Canonical Ltd. Breezy is free software, and you
829+Copyright 2005-2011 Canonical Ltd.
830+Copyright 2018 Breezy Developers
831+
832+Breezy is free software, and you
833 may use, modify and redistribute both Breezy and this document under
834 the terms of the GNU General Public License version 2 or later. See
835 <http://www.gnu.org/licenses/>.
836
837=== modified file 'doc/en/tutorials/using_breezy_with_launchpad.txt'
838--- doc/en/tutorials/using_breezy_with_launchpad.txt 2017-05-21 13:35:49 +0000
839+++ doc/en/tutorials/using_breezy_with_launchpad.txt 2018-11-18 17:25:59 +0000
840@@ -88,19 +88,6 @@
841 in a sustainable way is no easy task.
842
843
844-Breezy: Launchpad's VCS client
845-------------------------------
846-
847-This tutorial looks at how Breezy and Launchpad can be used together
848-and how they complement each other. It is important to remember that:
849-
850-1. Breezy can be used without Launchpad
851-2. Launchpad can be used without Breezy.
852-
853-By design though, their sum is greater than the individual
854-parts.
855-
856-
857 Finding and browsing branches using Launchpad
858 =============================================
859
860
861=== modified file 'doc/en/upgrade-guide/licence.txt'
862--- doc/en/upgrade-guide/licence.txt 2011-05-16 10:22:06 +0000
863+++ doc/en/upgrade-guide/licence.txt 2018-11-18 17:25:59 +0000
864@@ -1,7 +1,10 @@
865 Licence
866 ===============
867
868-Copyright 2009-2011 Canonical Ltd. Bazaar is free software, and you
869+Copyright 2009-2011 Canonical Ltd.
870+Copyright 2018 Breezy Developers
871+
872+Bazaar is free software, and you
873 may use, modify and redistribute both Bazaar and this document under
874 the terms of the GNU General Public License version 2 or later. See
875 <http://www.gnu.org/licenses/>.
876
877=== modified file 'doc/en/upgrade-guide/overview.txt'
878--- doc/en/upgrade-guide/overview.txt 2017-05-21 13:35:49 +0000
879+++ doc/en/upgrade-guide/overview.txt 2018-11-18 17:25:59 +0000
880@@ -56,7 +56,7 @@
881 2. Upgrade to the latest version using **sudo port upgrade brz**
882
883 For further information on installing and upgrading, see
884-http://wiki.bazaar.canonical.com/Download.
885+https://www.breezy-vcs.org/pages/download.html
886
887
888 Upgrading required plugins
889
890=== modified file 'doc/en/user-guide/installing_breezy.txt'
891--- doc/en/user-guide/installing_breezy.txt 2017-08-26 15:42:59 +0000
892+++ doc/en/user-guide/installing_breezy.txt 2018-11-18 17:25:59 +0000
893@@ -6,7 +6,7 @@
894
895 Breezy packages are available for most popular GNU/Linux distributions
896 including Ubuntu, Debian, Red Hat and Gentoo.
897-See http://wiki.bazaar.canonical.com/Download for the latest instructions.
898+See https://www.breezy-vcs.org/pages/download.html for the latest instructions.
899
900 Windows
901 -------
902@@ -14,7 +14,7 @@
903 For Windows users, an installer is available that includes
904 the core Breezy package together with necessary pre-requisites
905 and some useful plug-ins.
906-See http://wiki.bazaar.canonical.com/Download for the latest instructions.
907+See https://www.breezy-vcs.org/pages/download.html for the latest instructions.
908
909 Note: If you are running Cygwin on Windows, a Breezy for Cygwin package
910 is available and ought to be used instead of the Windows version.
911@@ -24,7 +24,7 @@
912
913 Beyond Linux and Windows, Breezy packages are available for a large
914 range of other operating systems include Mac OS X, FreeBSD and Solaris.
915-See http://wiki.bazaar.canonical.com/Download for the latest instructions.
916+See https://www.breezy-vcs.org/pages/download.html for the latest instructions.
917
918
919 Installing from scratch
920@@ -33,10 +33,10 @@
921 If you wish to install Breezy from scratch rather than using a
922 pre-built package, the steps are:
923
924- 1. If it is not installed already, install Python 2.6 or later.
925+ 1. If it is not installed already, install Python 2.7 or later.
926
927- 2. Download the ``bazaar-xxx.tar.gz`` file (where xxx is the version
928- number) from http://wiki.bazaar.canonical.com/Download or from Launchpad
929+ 2. Download the ``breezy-xxx.tar.gz`` file (where xxx is the version
930+ number) from https://www.breezy-vcs.org/pages/download.html or from Launchpad
931 (https://launchpad.net/~brz/).
932
933 3. Unpack the archive using tar, WinZip or equivalent.
934
935=== modified file 'doc/en/user-guide/introducing_breezy.txt'
936--- doc/en/user-guide/introducing_breezy.txt 2017-08-26 15:42:59 +0000
937+++ doc/en/user-guide/introducing_breezy.txt 2018-11-18 17:25:59 +0000
938@@ -98,12 +98,12 @@
939 While Breezy is not the only distributed VCS tool around, it does have some
940 notable features that make it an excellent choice for many teams and
941 communities. A summary of these and comparisons with other VCS tools
942-can be found on the Breezy Wiki, http://wiki.bazaar.canonical.com.
943+can be found on the Bazaar Wiki, http://wiki.bazaar.canonical.com.
944
945 Of the many features, one in particular is worth highlighting:
946 Breezy is completely free software written in Python. As a result,
947 it is easy to contribute improvements. If you wish to get involved,
948-please see http://wiki.bazaar.canonical.com/BzrSupport.
949+please see https://www.breezy-vcs.org/pages/support.html.
950
951
952 Learning more
953
954=== modified file 'doc/en/user-guide/licence.txt'
955--- doc/en/user-guide/licence.txt 2017-05-21 13:41:54 +0000
956+++ doc/en/user-guide/licence.txt 2018-11-18 17:25:59 +0000
957@@ -1,7 +1,10 @@
958 Licence
959 ===============
960
961-Copyright 2009-2011 Canonical Ltd. Breezy is free software, and you
962+Copyright 2009-2011 Canonical Ltd.
963+Copyright 2018 Breezy Developers
964+
965+Breezy is free software, and you
966 may use, modify and redistribute both Breezy and this document under
967 the terms of the GNU General Public License version 2 or later. See
968 <http://www.gnu.org/licenses/>.
969
970=== modified file 'doc/en/user-reference/readme.txt'
971--- doc/en/user-reference/readme.txt 2017-05-21 18:10:28 +0000
972+++ doc/en/user-reference/readme.txt 2018-11-18 17:25:59 +0000
973@@ -5,4 +5,4 @@
974 registries, e.g. the set of available file formats. If you're
975 not sure where to find the source content you're looking for,
976 please contact the developers on the mailing list or IRC.
977-See http://wiki.bazaar.canonical.com/BzrSupport for contact details.
978+See https://www.breezy-vcs.org/pages/support.html for contact details.
979
980=== modified file 'doc/index.txt'
981--- doc/index.txt 2018-11-18 02:43:52 +0000
982+++ doc/index.txt 2018-11-18 17:25:59 +0000
983@@ -4,7 +4,7 @@
984
985 The latest version of these documents are available from Breezy's
986 documentation site, <http://doc.breezy.canonical.com/>, and more documentation
987-may be linked from <http://wiki.bazaar.canonical.com/Documentation>.
988+may be linked from <https://www.breezy-vcs.org/doc/>.
989
990 Core Documentation
991 ==================
992@@ -51,7 +51,7 @@
993
994 * `Glossary <http://wiki.bazaar.canonical.com/BzrGlossary>`_
995
996-* `Frequently Asked Questions <http://wiki.bazaar.canonical.com/FAQ>`_
997+* `Frequently Asked Questions <https://answers.launchpad.net/brz/+faqs>`_
998
999 .. |--| unicode:: U+2014
1000

Subscribers

People subscribed via source and target branches