From 5743a32ddf387791889f53e7eafbc3e0de7bfcc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 12:12:27 +0000 Subject: [PATCH 01/16] Install the pip version of flake8, since the version in Ubuntu is too old. --- byov.conf | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/byov.conf b/byov.conf index 2c00813b7f..7adf9c0e53 100644 --- a/byov.conf +++ b/byov.conf @@ -9,6 +9,8 @@ subunit.clone = (git clone https://github.com/testing-cabal/subunit.git ../subun fastimport.clone = (git clone git://jelmer.uk/python-fastimport.git ../fastimport.git) fastimport.install = (cd ../fastimport.git && ./setup.py install --user) fastimport.install3 = (cd ../fastimport.git && python3 ./setup.py install --user) +flake8.install = (pip install flake8) +flake8.install3 = (pip3 install flake8) [brz] # FIXME: we're stuck on xenial @@ -21,7 +23,7 @@ fastimport.install3 = (cd ../fastimport.git && python3 ./setup.py install --user # FIXME: Arguably this should be vm.build_deps=brz but it requires either an # available package or at least a debian/ dir ? -- vila 2018-02-23 -brz.build_deps = gcc, debhelper, python, python-all-dev, python3-all-dev, python-configobj, python3-configobj, python-docutils, python3-docutils, python-paramiko, python3-paramiko, python-subunit, python3-subunit, python-testtools, python3-testtools, subunit, cython, cython3, python-flake8, python3-flake8 +brz.build_deps = gcc, debhelper, python, python-all-dev, python3-all-dev, python-configobj, python3-configobj, python-docutils, python3-docutils, python-paramiko, python3-paramiko, python-subunit, python3-subunit, python-testtools, python3-testtools, subunit, cython, cython3, python-pip, python3-pip subunit.build_deps = python-testscenarios, python3-testscenarios, python-testtools, python3-testtools vm.packages = {brz.build_deps}, {subunit.build_deps}, bzr, git, python-junitxml [brz-xenial] From c0a3caa0f8b0248f949f63f51eb2e2183ae747d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 12:13:52 +0000 Subject: [PATCH 02/16] Actually run pip. --- byov.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/byov.conf b/byov.conf index 7adf9c0e53..7316f59997 100644 --- a/byov.conf +++ b/byov.conf @@ -28,7 +28,7 @@ subunit.build_deps = python-testscenarios, python3-testscenarios, python-testtoo vm.packages = {brz.build_deps}, {subunit.build_deps}, bzr, git, python-junitxml [brz-xenial] vm.release = xenial -byoci.setup.command = ({dulwich.clone} && {dulwich.install} && {dulwich.install3} && {fastimport.clone} && {fastimport.install} && {fastimport.install3} && {subunit.clone}) +byoci.setup.command = ({dulwich.clone} && {dulwich.install} && {dulwich.install3} && {fastimport.clone} && {fastimport.install} && {fastimport.install3} && {subunit.clone} && {flake8.install} && {flake8.install3}) # FIXME: bzr log -l2 should be by default -- vila 2018-03-09 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" [brz-bionic] From 9d8dd9215b53e044806698327a64f517cb617fe7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 12:18:44 +0000 Subject: [PATCH 03/16] Fix an error. --- tools/win32/brz_postinstall.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/win32/brz_postinstall.py b/tools/win32/brz_postinstall.py index 23f9aff082..81785b58f6 100644 --- a/tools/win32/brz_postinstall.py +++ b/tools/win32/brz_postinstall.py @@ -305,7 +305,7 @@ def backup_autoexec_bat(name, backupname, dry_run): 'EnvironmentError', MB_OK | MB_ICONERROR) - if hkey not is None: + if hkey is not None: _winreg.SetValue(hkey, '', _winreg.REG_SZ, 'Brz Here') hkey2 = _winreg.CreateKey(hkey, 'command') _winreg.SetValue(hkey2, '', _winreg.REG_SZ, From 8ea7c900517ddf8da3360be3b61732639448a802 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 12:36:48 +0000 Subject: [PATCH 04/16] Add missing dependency on setuptools. --- byov.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/byov.conf b/byov.conf index 7316f59997..0fd52e08b0 100644 --- a/byov.conf +++ b/byov.conf @@ -23,7 +23,7 @@ flake8.install3 = (pip3 install flake8) # FIXME: Arguably this should be vm.build_deps=brz but it requires either an # available package or at least a debian/ dir ? -- vila 2018-02-23 -brz.build_deps = gcc, debhelper, python, python-all-dev, python3-all-dev, python-configobj, python3-configobj, python-docutils, python3-docutils, python-paramiko, python3-paramiko, python-subunit, python3-subunit, python-testtools, python3-testtools, subunit, cython, cython3, python-pip, python3-pip +brz.build_deps = gcc, debhelper, python, python-all-dev, python3-all-dev, python-configobj, python3-configobj, python-docutils, python3-docutils, python-paramiko, python3-paramiko, python-subunit, python3-subunit, python-testtools, python3-testtools, subunit, cython, cython3, python-pip, python3-pip, python-setuptools, python3-setuptools subunit.build_deps = python-testscenarios, python3-testscenarios, python-testtools, python3-testtools vm.packages = {brz.build_deps}, {subunit.build_deps}, bzr, git, python-junitxml [brz-xenial] From ac380207c96cd822040c90261ccfe492679dea77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 12:41:12 +0000 Subject: [PATCH 05/16] Fix flake8 errors. --- brz | 14 ++++++++------ setup.cfg | 1 + 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/brz b/brz index 70210b74c9..928d25faef 100755 --- a/brz +++ b/brz @@ -47,7 +47,8 @@ if os.name == "posix": try: locale.setlocale(locale.LC_ALL, '') except locale.Error as e: - sys.stderr.write('brz: warning: %s\n' + sys.stderr.write( + 'brz: warning: %s\n' ' bzr could not set the application locale.\n' ' Although this should be no problem for bzr itself, it might\n' ' cause problems with some plugins. To investigate the issue,\n' @@ -61,7 +62,8 @@ if os.name == "posix": try: import breezy except ImportError as e: - sys.stderr.write("brz: ERROR: " + sys.stderr.write( + "brz: ERROR: " "Couldn't import breezy and dependencies.\n" "Please check the directory containing breezy is on your PYTHONPATH.\n" "\n") @@ -73,10 +75,10 @@ if breezy.version_info[:3] != _script_version: "This may indicate an installation problem.\n" "breezy is version %s from %s\n" "brz is version %s from %s\n" % ( - breezy._format_version_tuple(breezy.version_info), - breezy.__path__[0], - breezy._format_version_tuple(_script_version), - __file__)) + breezy._format_version_tuple(breezy.version_info), + breezy.__path__[0], + breezy._format_version_tuple(_script_version), + __file__)) import breezy.breakin diff --git a/setup.cfg b/setup.cfg index 0a1f0e0fa2..925509b96b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -41,6 +41,7 @@ ignore = W504 W601 W605 +filename = *.py,brz [flake8:local-plugins] extension = From 3811be78a932af7cd3dbae11297c16d59ba2dd47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 13:16:09 +0000 Subject: [PATCH 06/16] Remove reference to Breezy being "Launchpad\'s VCS client" --- doc/en/tutorials/using_breezy_with_launchpad.txt | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/doc/en/tutorials/using_breezy_with_launchpad.txt b/doc/en/tutorials/using_breezy_with_launchpad.txt index ec44a6efe6..fd0b7932c3 100644 --- a/doc/en/tutorials/using_breezy_with_launchpad.txt +++ b/doc/en/tutorials/using_breezy_with_launchpad.txt @@ -88,19 +88,6 @@ to the upstream development team. Keeping track of all that over time in a sustainable way is no easy task. -Breezy: Launchpad's VCS client ------------------------------- - -This tutorial looks at how Breezy and Launchpad can be used together -and how they complement each other. It is important to remember that: - -1. Breezy can be used without Launchpad -2. Launchpad can be used without Breezy. - -By design though, their sum is greater than the individual -parts. - - Finding and browsing branches using Launchpad ============================================= From aaa485130109116263e19ee2077e4eda48d4aed0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 13:17:18 +0000 Subject: [PATCH 07/16] Drop translations bits. --- doc/en/_templates/index.html | 6 ------ 1 file changed, 6 deletions(-) diff --git a/doc/en/_templates/index.html b/doc/en/_templates/index.html index b7fdab076d..d57fd2f4ff 100644 --- a/doc/en/_templates/index.html +++ b/doc/en/_templates/index.html @@ -60,12 +60,6 @@

Related links

help on popular plugins

- - - These documents are also available in Spanish, - Japanese, - and Russian. - {% endblock %} From 5f883f8747dbdb28bd38f863e1f9a6a4e57cfc41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 13:20:01 +0000 Subject: [PATCH 08/16] s/bzr/brz. --- doc/en/admin-guide/backup.txt | 22 +++++++++++----------- doc/en/admin-guide/hooks-plugins.txt | 4 ++-- doc/en/admin-guide/licence.txt | 7 +++++-- doc/en/admin-guide/migration.txt | 6 +++--- doc/en/admin-guide/simple-setups.txt | 16 ++++++++-------- 5 files changed, 29 insertions(+), 26 deletions(-) diff --git a/doc/en/admin-guide/backup.txt b/doc/en/admin-guide/backup.txt index ee4461275a..ab81ba3eec 100644 --- a/doc/en/admin-guide/backup.txt +++ b/doc/en/admin-guide/backup.txt @@ -57,8 +57,8 @@ As an example, consider a separate backup server that stores backups in :: $ cd /var/backup - $ bzr branch bzr+ssh://server.example.com/srv/bzr/trunk - $ bzr branch bzr+ssh://server.example.com/srv/bzr/feature-gui + $ brz branch bzr+ssh://server.example.com/srv/bzr/trunk + $ brz branch bzr+ssh://server.example.com/srv/bzr/feature-gui to create the branches on the backup server. Then, we could regularly (for example from ``cron``) do @@ -66,9 +66,9 @@ example from ``cron``) do :: $ cd /var/backup/trunk - $ bzr pull # the location to pull from is remembered + $ brz pull # the location to pull from is remembered $ cd ../var/backup/feature-gui - $ bzr pull # again, the parent location is remembered + $ brz pull # again, the parent location is remembered The action of pulling from the parent for all branches in some directory is common enough that there is a plugin to do it. The `bzrtools`_ plugin @@ -82,7 +82,7 @@ With this plugin installed, the above periodically run commands would be :: $ cd /var/backup - $ bzr multi-pull + $ brz multi-pull Note that ``multi-pull`` does a pull in *every* branch in the specified directory (the current directory by default) and care should be taken that @@ -108,18 +108,18 @@ easily have used ``bzr branch`` from the backup server) :: $ cd /srv/bzr/projectx/trunk - $ bzr push bzr+ssh://backup.example.com/var/backup/trunk + $ brz push bzr+ssh://backup.example.com/var/backup/trunk $ cd ../feature-gui - $ bzr push bzr+ssh://backup.example.com/var/backup/feature-gui + $ brz push bzr+ssh://backup.example.com/var/backup/feature-gui and then we need to bind the main branches to their backups :: $ cd ../trunk - $ bzr bind bzr+ssh://backup.example.com/var/backup/trunk + $ brz bind bzr+ssh://backup.example.com/var/backup/trunk $ cd ../feature-gui - $ bzr bind bzr+ssh://backup.example.com/var/backup/feature-gui + $ brz bind bzr+ssh://backup.example.com/var/backup/feature-gui A branch can only be bound to a single location, so multiple backups cannot be created using this method. @@ -197,8 +197,8 @@ appropriate location:: $ cd /srv $ mv bzr bzr.old $ cd bzr - $ bzr branch bzr+ssh://backup.example.com/var/backup/trunk - $ bzr branch bzr+ssh://backup.example.com/var/backup/feature-gui + $ brz branch bzr+ssh://backup.example.com/var/backup/trunk + $ brz branch bzr+ssh://backup.example.com/var/backup/feature-gui If there are multiple backups, then change the URL above to restore from the other backups. diff --git a/doc/en/admin-guide/hooks-plugins.txt b/doc/en/admin-guide/hooks-plugins.txt index 11fe8bd4a4..37216e9879 100644 --- a/doc/en/admin-guide/hooks-plugins.txt +++ b/doc/en/admin-guide/hooks-plugins.txt @@ -96,7 +96,7 @@ set up to run at regular intervals, for example from ``cron``.) :: - $ bzr_hookless_email.py --email=projectx-commits@example.com \ + $ brz_hookless_email.py --email=projectx-commits@example.com \ --recurse /srv/bzr email-notifier @@ -143,7 +143,7 @@ If this file is stored as ``/srv/bzr/email-notifier.conf``, then the command :: - $ bzr-email-notifier.py --config=/srv/bzr/email-notifier.conf /srv/bzr/projectx + $ brz-email-notifier.py --config=/srv/bzr/email-notifier.conf /srv/bzr/projectx will watch all branches under the given directory for commits, branch creations and branch deletions. diff --git a/doc/en/admin-guide/licence.txt b/doc/en/admin-guide/licence.txt index 76a34c3655..4d0b547de8 100644 --- a/doc/en/admin-guide/licence.txt +++ b/doc/en/admin-guide/licence.txt @@ -1,7 +1,10 @@ Licence =============== -Copyright 2008-2011 Canonical Ltd. Bazaar is free software, and you -may use, modify and redistribute both Bazaar and this document under +Copyright 2008-2011 Canonical Ltd. +Copyright 2018 Breezy Developers + +Breezy is free software, and you +may use, modify and redistribute both Breezy and this document under the terms of the GNU General Public License version 2 or later. See . diff --git a/doc/en/admin-guide/migration.txt b/doc/en/admin-guide/migration.txt index b35a108c0f..a8ef736535 100644 --- a/doc/en/admin-guide/migration.txt +++ b/doc/en/admin-guide/migration.txt @@ -35,9 +35,9 @@ branch. (Recall that in `Further Configuration :: $ cd /srv/bzr/projectx - $ bzr fast-export-from-hg ../../hg/projectx projectx.fi - $ bzr init trunk - $ bzr fast-import projectx.fi trunk + $ brz fast-export-from-hg ../../hg/projectx projectx.fi + $ brz init trunk + $ brz fast-import projectx.fi trunk Subversion Conversion --------------------- diff --git a/doc/en/admin-guide/simple-setups.txt b/doc/en/admin-guide/simple-setups.txt index b65383d28d..112ea6c06b 100644 --- a/doc/en/admin-guide/simple-setups.txt +++ b/doc/en/admin-guide/simple-setups.txt @@ -37,12 +37,12 @@ Client Clients can access the branches using URLs with the ``bzr+ssh://`` prefix. For example, to get a local copy of the ProjectX trunk, a developer could do:: - $ bzr branch bzr+ssh://server.example.com/srv/bzr/projectx/trunk projectx + $ brz branch bzr+ssh://server.example.com/srv/bzr/projectx/trunk projectx If the developers have write access to the ``/srv/bzr/projectx`` directory, then they can create new branches themselves using:: - $ bzr branch bzr+ssh://server.example.com/srv/bzr/projectx/trunk \ + $ brz branch bzr+ssh://server.example.com/srv/bzr/projectx/trunk \ bzr+ssh://server.example.com/srv/bzr/projectx/feature-gui Of course, if this isn't desired, then developers should not have write access @@ -55,7 +55,7 @@ For a project with multiple branches that are all related, it is best to use a shared repository to hold all of the branches. To set this up, do:: $ cd /srv/bzr - $ bzr init-repo --no-trees projectx + $ brz init-repo --no-trees projectx The ``--no-trees`` option saves space by not creating a copy of the working files on the server's filesystem. Then, any branch created under @@ -69,7 +69,7 @@ configuration, then a path can be specified from the client with the ``BZR_REMOTE_PATH`` environment variable. For example, if the Bazaar executable is installed in ``/usr/local/bzr-2.0/bin/bzr``, then a developer could use:: - $ BZR_REMOTE_PATH=/usr/local/bzr-2.0/bin/bzr bzr info \ + $ brz_REMOTE_PATH=/usr/local/bzr-2.0/bin/bzr bzr info \ bzr+ssh://server.example.com/srv/bzr/proectx/trunk to get information about the trunk branch. The remote path can also be @@ -81,11 +81,11 @@ URLs to refer to their home directory. They can also use ``/~username/`` to refer to the home directory of user ``username``. For example, if there are two developers ``alice`` and ``bob``, then Bob could use:: - $ bzr log bzr+ssh://server.example.com/~/fix-1023 + $ brz log bzr+ssh://server.example.com/~/fix-1023 to refer to one of his bug fix branches and:: - $ bzr log bzr+ssh://server.example.com/~alice/fix-2047 + $ brz log bzr+ssh://server.example.com/~alice/fix-2047 to refer to one of Alice's branches. [#]_ @@ -133,10 +133,10 @@ serving using ``bzr serve`` and the ``--directory`` option. If Alice logs in she uses the following command for her fix-1023 branch:: - $ bzr log bzr+ssh://bzruser@server.example.com/fix-1023 + $ brz log bzr+ssh://bzruser@server.example.com/fix-1023 If Repo Manager logs in he uses the following command to access Alice's fix-1023:: - $ bzr log bzr+ssh://bzruser@server.example.com/alice/fix-1023 + $ brz log bzr+ssh://bzruser@server.example.com/alice/fix-1023 From 1d0e4e91d460021ec40a4b5447c2a48be3701332 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 13:20:08 +0000 Subject: [PATCH 09/16] Update license information. --- doc/en/tutorials/licence.txt | 5 ++++- doc/en/upgrade-guide/licence.txt | 5 ++++- doc/en/user-guide/licence.txt | 5 ++++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/doc/en/tutorials/licence.txt b/doc/en/tutorials/licence.txt index 3449827d4c..4a32d07012 100644 --- a/doc/en/tutorials/licence.txt +++ b/doc/en/tutorials/licence.txt @@ -1,7 +1,10 @@ Licence =============== -Copyright 2005-2011 Canonical Ltd. Breezy is free software, and you +Copyright 2005-2011 Canonical Ltd. +Copyright 2018 Breezy Developers + +Breezy is free software, and you may use, modify and redistribute both Breezy and this document under the terms of the GNU General Public License version 2 or later. See . diff --git a/doc/en/upgrade-guide/licence.txt b/doc/en/upgrade-guide/licence.txt index 09af80effa..134dd43754 100644 --- a/doc/en/upgrade-guide/licence.txt +++ b/doc/en/upgrade-guide/licence.txt @@ -1,7 +1,10 @@ Licence =============== -Copyright 2009-2011 Canonical Ltd. Bazaar is free software, and you +Copyright 2009-2011 Canonical Ltd. +Copyright 2018 Breezy Developers + +Bazaar is free software, and you may use, modify and redistribute both Bazaar and this document under the terms of the GNU General Public License version 2 or later. See . diff --git a/doc/en/user-guide/licence.txt b/doc/en/user-guide/licence.txt index 598e814637..a62f52872f 100644 --- a/doc/en/user-guide/licence.txt +++ b/doc/en/user-guide/licence.txt @@ -1,7 +1,10 @@ Licence =============== -Copyright 2009-2011 Canonical Ltd. Breezy is free software, and you +Copyright 2009-2011 Canonical Ltd. +Copyright 2018 Breezy Developers + +Breezy is free software, and you may use, modify and redistribute both Breezy and this document under the terms of the GNU General Public License version 2 or later. See . From e3a17cfc07fd7dc9e6a534ce902061078113615d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 13:43:04 +0000 Subject: [PATCH 10/16] Update lots of URLs. --- doc/developers/HACKING.txt | 10 ++++------ doc/developers/code-style.txt | 2 +- doc/developers/development-repo.txt | 2 +- doc/developers/overview.txt | 2 +- doc/developers/packrepo.txt | 2 +- doc/developers/ppa.txt | 4 ++-- doc/developers/releasing.txt | 4 ++-- doc/en/tutorials/centralized_workflow.txt | 15 --------------- doc/en/upgrade-guide/overview.txt | 2 +- doc/en/user-guide/installing_breezy.txt | 12 ++++++------ doc/en/user-guide/introducing_breezy.txt | 4 ++-- doc/en/user-reference/readme.txt | 2 +- doc/index.txt | 4 ++-- 13 files changed, 24 insertions(+), 41 deletions(-) diff --git a/doc/developers/HACKING.txt b/doc/developers/HACKING.txt index 0625de1eb8..8c35026e49 100644 --- a/doc/developers/HACKING.txt +++ b/doc/developers/HACKING.txt @@ -12,7 +12,7 @@ the Breezy mailing list. To propose a correction or addition to this document, send a merge request or new text to the mailing list. The latest developer documentation can be found online at -http://doc.bazaar.canonical.com/developers/. +https://www.breezy-vcs.org/developers/. Getting Started ############### @@ -52,7 +52,7 @@ Planning and Discussing Changes There is a very active community around Breezy. Mostly we meet on IRC (#bzr on irc.freenode.net) and on the mailing list. To join the Breezy -community, see http://wiki.bazaar.canonical.com/BzrSupport. +community, see https://www.breezy-vcs.org/pages/support.html. If you are planning to make a change, it's a very good idea to mention it on the IRC channel and/or on the mailing list. There are many advantages @@ -208,8 +208,6 @@ The key tools we use to enable these practices are: For further information, see . - - Preparing a Sandbox for Making Changes to Breezy ================================================ @@ -297,7 +295,7 @@ Automatically-generated API reference information is available at . See also the `Breezy Architectural Overview -`_. +`_. Core Topics @@ -533,7 +531,7 @@ stuff covered above, "core" developers have responsibility for: * reviewing changes * planning releases -* managing releases (see `Releasing Breezy `_) +* managing releases (see `Releasing Breezy `_) .. note:: Removing barriers to community participation is a key reason for adopting diff --git a/doc/developers/code-style.txt b/doc/developers/code-style.txt index 44b0d854b1..95ae34359a 100644 --- a/doc/developers/code-style.txt +++ b/doc/developers/code-style.txt @@ -396,7 +396,7 @@ Test coverage ============= All code should be exercised by the test suite. See the `Bazaar Testing -Guide `_ for detailed +Guide `_ for detailed information about writing tests. diff --git a/doc/developers/development-repo.txt b/doc/developers/development-repo.txt index 3bed732b8d..e3bd4bb016 100644 --- a/doc/developers/development-repo.txt +++ b/doc/developers/development-repo.txt @@ -171,7 +171,7 @@ Reporting problems If you need any help or encounter any problems, please contact the developers via the usual ways, i.e. chat to us on IRC or send a message to our mailing -list. See http://wiki.bazaar.canonical.com/BzrSupport for contact details. +list. See https://www.breezy-vcs.org/pages/support.html for contact details. Technical notes diff --git a/doc/developers/overview.txt b/doc/developers/overview.txt index 94c05f5098..58f8706c0b 100644 --- a/doc/developers/overview.txt +++ b/doc/developers/overview.txt @@ -425,7 +425,7 @@ Signature store Stores cryptographic signatures of revision contents. The keys match those of the revision store. -.. _Core Concepts: http://doc.bazaar.canonical.com/latest/en/user-guide/core_concepts.html +.. _Core Concepts: https://www.breezy-vcs.org/doc/en/user-guide/core_concepts.html .. vim: ft=rst tw=74 ai diff --git a/doc/developers/packrepo.txt b/doc/developers/packrepo.txt index bbefe15a42..006a95b4f9 100644 --- a/doc/developers/packrepo.txt +++ b/doc/developers/packrepo.txt @@ -138,7 +138,7 @@ Reporting problems If you need any help or encounter any problems, please contact the developers via the usual ways, i.e. chat to us on IRC or send a message to our mailing -list. See http://wiki.bazaar.canonical.com/BzrSupport for contact details. +list. See https://www.breezy-vcs.org/pages/support.html for contact details. Technical notes diff --git a/doc/developers/ppa.txt b/doc/developers/ppa.txt index 2d85a65713..eba0a47768 100644 --- a/doc/developers/ppa.txt +++ b/doc/developers/ppa.txt @@ -74,11 +74,11 @@ Supported releases We build packages for every supported Ubuntu release . Packages need no longer be updated when the release passes end-of-life because all users should -have upgraded by then. +have upgraded by then. As of August 2010, the following releases are supported: -* Maverick +* Maverick * Lucid LTS * Karmic * Jaunty (support ends October 2010) diff --git a/doc/developers/releasing.txt b/doc/developers/releasing.txt index a353306aa5..350ded541e 100644 --- a/doc/developers/releasing.txt +++ b/doc/developers/releasing.txt @@ -4,7 +4,7 @@ Releasing Breezy This document describes the processes for making and announcing a Breezy release, and managing the release process. This is just one phase of the `overall development cycle -`_, (go re-read this +`_, (go re-read this document to ensure it hasn't been updated since you last read it) but it's the most complex part. @@ -518,7 +518,7 @@ available to the world. #. Announce on the Breezy website. #. Check that the documentation for this release is available in - . It should be automatically build when + . It should be automatically build when the branch is created, by a cron script ``update-brz-docs`` on ``escudero``. When the first release is created in a new series, a branch needs to be created on ``escudero``:: diff --git a/doc/en/tutorials/centralized_workflow.txt b/doc/en/tutorials/centralized_workflow.txt index 1b24c002b2..888bec68cf 100644 --- a/doc/en/tutorials/centralized_workflow.txt +++ b/doc/en/tutorials/centralized_workflow.txt @@ -222,21 +222,6 @@ like they would have collaborated on the ``dev`` branch. [#cbranch]_ hierarchical namespace where the nested branch is derived from the outer branch. -.. [#cbranch] When using lots of independent branches, having to retype - the full URL all the time takes a lot of typing. We are looking into - various methods to help with this, such as branch aliases, etc. For - now, though, the brztools_ plugin provides the ``brz cbranch`` command. - Which is designed to take a base branch, create a new public branch, - and create a checkout of that branch, all with much less typing. - Configuring ``cbranch`` is outside the scope of this document, but the - final commands are similar to: - -:: - - % brz cbranch dev my-feature-branch - -.. _brztools: http://wiki.bazaar.canonical.com/brzTools - Merging changes back -------------------- diff --git a/doc/en/upgrade-guide/overview.txt b/doc/en/upgrade-guide/overview.txt index 40a72abac7..9d59c47e0f 100644 --- a/doc/en/upgrade-guide/overview.txt +++ b/doc/en/upgrade-guide/overview.txt @@ -56,7 +56,7 @@ To upgrade Breezy on OS X (via MacPorts): 2. Upgrade to the latest version using **sudo port upgrade brz** For further information on installing and upgrading, see -http://wiki.bazaar.canonical.com/Download. +https://www.breezy-vcs.org/pages/download.html Upgrading required plugins diff --git a/doc/en/user-guide/installing_breezy.txt b/doc/en/user-guide/installing_breezy.txt index cb68ff07a9..0395d8ca9e 100644 --- a/doc/en/user-guide/installing_breezy.txt +++ b/doc/en/user-guide/installing_breezy.txt @@ -6,7 +6,7 @@ GNU/Linux Breezy packages are available for most popular GNU/Linux distributions including Ubuntu, Debian, Red Hat and Gentoo. -See http://wiki.bazaar.canonical.com/Download for the latest instructions. +See https://www.breezy-vcs.org/pages/download.html for the latest instructions. Windows ------- @@ -14,7 +14,7 @@ Windows For Windows users, an installer is available that includes the core Breezy package together with necessary pre-requisites and some useful plug-ins. -See http://wiki.bazaar.canonical.com/Download for the latest instructions. +See https://www.breezy-vcs.org/pages/download.html for the latest instructions. Note: If you are running Cygwin on Windows, a Breezy for Cygwin package is available and ought to be used instead of the Windows version. @@ -24,7 +24,7 @@ Other operating systems Beyond Linux and Windows, Breezy packages are available for a large range of other operating systems include Mac OS X, FreeBSD and Solaris. -See http://wiki.bazaar.canonical.com/Download for the latest instructions. +See https://www.breezy-vcs.org/pages/download.html for the latest instructions. Installing from scratch @@ -33,10 +33,10 @@ Installing from scratch If you wish to install Breezy from scratch rather than using a pre-built package, the steps are: - 1. If it is not installed already, install Python 2.6 or later. + 1. If it is not installed already, install Python 2.7 or later. - 2. Download the ``bazaar-xxx.tar.gz`` file (where xxx is the version - number) from http://wiki.bazaar.canonical.com/Download or from Launchpad + 2. Download the ``breezy-xxx.tar.gz`` file (where xxx is the version + number) from https://www.breezy-vcs.org/pages/download.html or from Launchpad (https://launchpad.net/~brz/). 3. Unpack the archive using tar, WinZip or equivalent. diff --git a/doc/en/user-guide/introducing_breezy.txt b/doc/en/user-guide/introducing_breezy.txt index 348c8cd4f9..725597b211 100644 --- a/doc/en/user-guide/introducing_breezy.txt +++ b/doc/en/user-guide/introducing_breezy.txt @@ -98,12 +98,12 @@ Key features of Breezy While Breezy is not the only distributed VCS tool around, it does have some notable features that make it an excellent choice for many teams and communities. A summary of these and comparisons with other VCS tools -can be found on the Breezy Wiki, http://wiki.bazaar.canonical.com. +can be found on the Bazaar Wiki, http://wiki.bazaar.canonical.com. Of the many features, one in particular is worth highlighting: Breezy is completely free software written in Python. As a result, it is easy to contribute improvements. If you wish to get involved, -please see http://wiki.bazaar.canonical.com/BzrSupport. +please see https://www.breezy-vcs.org/pages/support.html. Learning more diff --git a/doc/en/user-reference/readme.txt b/doc/en/user-reference/readme.txt index 47e0b4ce04..a1bc81cce6 100644 --- a/doc/en/user-reference/readme.txt +++ b/doc/en/user-reference/readme.txt @@ -5,4 +5,4 @@ though, the material is built by probing various internal registries, e.g. the set of available file formats. If you're not sure where to find the source content you're looking for, please contact the developers on the mailing list or IRC. -See http://wiki.bazaar.canonical.com/BzrSupport for contact details. +See https://www.breezy-vcs.org/pages/support.html for contact details. diff --git a/doc/index.txt b/doc/index.txt index 4e6c6c9cd8..c6a6fa0a0e 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -4,7 +4,7 @@ Breezy Main Document Catalog The latest version of these documents are available from Breezy's documentation site, , and more documentation -may be linked from . +may be linked from . Core Documentation ================== @@ -51,7 +51,7 @@ Web links * `Glossary `_ -* `Frequently Asked Questions `_ +* `Frequently Asked Questions `_ .. |--| unicode:: U+2014 From 9cb4ebf3edce263d350d51bb382bdc15ec437020 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 14:23:08 +0000 Subject: [PATCH 11/16] Add API documentation. --- .bzrignore | 1 + breezy/bzr/smart/medium.py | 8 ++++++-- breezy/doc_generate/conf.py | 12 +++++++++++- doc/developers/HACKING.txt | 4 ++-- doc/developers/api-readme.txt | 3 +++ doc/developers/conf.py | 2 +- doc/developers/contribution-quickstart.txt | 7 +------ doc/developers/index-plain.txt | 9 +++++---- doc/developers/index.txt | 10 ++++++---- 9 files changed, 36 insertions(+), 20 deletions(-) create mode 100644 doc/developers/api-readme.txt diff --git a/.bzrignore b/.bzrignore index c68f20cd71..1717612381 100644 --- a/.bzrignore +++ b/.bzrignore @@ -73,3 +73,4 @@ breezy/_*.pyd .testrepository selftest.log .coverage +doc/developers/api diff --git a/breezy/bzr/smart/medium.py b/breezy/bzr/smart/medium.py index 378bfaeae2..3d9e930325 100644 --- a/breezy/bzr/smart/medium.py +++ b/breezy/bzr/smart/medium.py @@ -32,12 +32,16 @@ import sys import time +try: + import _thread +except ImportError: + import thread as _thread + import breezy from ...lazy_import import lazy_import lazy_import(globals(), """ import select import socket -import thread import weakref from breezy import ( @@ -432,7 +436,7 @@ def _write_out(self, bytes): tstart = osutils.timer_func() osutils.send_all(self.socket, bytes, self._report_activity) if 'hpss' in debug.debug_flags: - thread_id = thread.get_ident() + thread_id = _thread.get_ident() trace.mutter('%12s: [%s] %d bytes to the socket in %.3fs' % ('wrote', thread_id, len(bytes), osutils.timer_func() - tstart)) diff --git a/breezy/doc_generate/conf.py b/breezy/doc_generate/conf.py index 7ef2dc2256..afb3f2b377 100644 --- a/breezy/doc_generate/conf.py +++ b/breezy/doc_generate/conf.py @@ -21,7 +21,13 @@ # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.ifconfig', ] +extensions = [ + 'sphinx.ext.ifconfig', + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx_epytext', + # 'sphinxcontrib.napoleon', # TODO: for Google docstrings + ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -216,3 +222,7 @@ # Authors of the documents brz_team = u'Breezy Developers' + +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), +} diff --git a/doc/developers/HACKING.txt b/doc/developers/HACKING.txt index 8c35026e49..a31fad478c 100644 --- a/doc/developers/HACKING.txt +++ b/doc/developers/HACKING.txt @@ -205,7 +205,7 @@ The key tools we use to enable these practices are: * Patch Queue Manager - https://launchpad.net/pqm/ -For further information, see . +For further information, see . Preparing a Sandbox for Making Changes to Breezy @@ -292,7 +292,7 @@ doc/en/whats-new/ Automatically-generated API reference information is available at -. +. See also the `Breezy Architectural Overview `_. diff --git a/doc/developers/api-readme.txt b/doc/developers/api-readme.txt new file mode 100644 index 0000000000..41e2bce076 --- /dev/null +++ b/doc/developers/api-readme.txt @@ -0,0 +1,3 @@ +This is the API documentation for Breezy. + +It's still a work in progress. diff --git a/doc/developers/conf.py b/doc/developers/conf.py index 7a5cae7719..9be27281c2 100644 --- a/doc/developers/conf.py +++ b/doc/developers/conf.py @@ -10,7 +10,7 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path = [os.path.abspath('../..')] + sys.path +sys.path = [os.path.abspath('../..'), os.path.abspath('api')] + sys.path # Most of the configuration for Breezy docs is defined here ... from breezy.doc_generate.conf import * diff --git a/doc/developers/contribution-quickstart.txt b/doc/developers/contribution-quickstart.txt index f31d5ed97c..d0c41b9020 100644 --- a/doc/developers/contribution-quickstart.txt +++ b/doc/developers/contribution-quickstart.txt @@ -8,14 +8,9 @@ If you want to fix or improve something in Bazaar, we want to help you. You can ask at any time for help, on the list, on irc, or through a merge proposal on Launchpad. -In particular, the rostered -`Patch Pilot `_ -is an experienced developer who will help you get your changes in, through -code review, advice, debugging, writing tests, or whatever it takes. - * `Bazaar mailing list `_ -* IRC in channel ``#bzr`` on ``irc.ubuntu.com`` +* IRC in channel ``#bzr`` on ``irc.freenode.net`` Starting diff --git a/doc/developers/index-plain.txt b/doc/developers/index-plain.txt index 92cc28e71b..1339df52d9 100644 --- a/doc/developers/index-plain.txt +++ b/doc/developers/index-plain.txt @@ -11,7 +11,7 @@ Overall developer documentation * `Architectural Overview `_ |--| describes some of the most important classes and concepts. -* `bzrlib API reference `_ +* `breezy API reference `_ (external link) |--| automatically generated API reference information @@ -77,7 +77,7 @@ Plans Specifications ============== -* `API versioning `_ |--| bzrlib API versioning. +* `API versioning `_ |--| breezy API versioning. * `Apport error reporting `_ |--| Capture data to report bugs. @@ -93,7 +93,8 @@ Specifications * `Groupcompress `_ |--| Notes on the compression technology used in CHK repositories. -* `Indices `_ |--| The index facilities available within bzrlib. +* `Indices `_ |--| The index facilities available within + breezy. * `Inventories `_ |--| Tree shape abstraction. @@ -108,7 +109,7 @@ Specifications * `Repository stream `_ |--| Notes on streaming data for repositories (a layer above the container format). -* `Integration Guide `_ |--| A guide to integrate bzrlib into +* `Integration Guide `_ |--| A guide to integrate breezy into any python application. * `Breezy and case-insensitive file systems `_ diff --git a/doc/developers/index.txt b/doc/developers/index.txt index f716499f03..9f34eb99a4 100644 --- a/doc/developers/index.txt +++ b/doc/developers/index.txt @@ -51,7 +51,7 @@ Releasing and Packaging ec2 -Developing using bzrlib +Developing using breezy ======================= .. toctree:: @@ -62,8 +62,7 @@ Developing using bzrlib * `Writing plugins for Breezy `_ (web link) -* `bzrlib API reference `_ - (web link) +* `breezy API reference `_ Other documents @@ -82,7 +81,10 @@ Other documents Licence ============ -Copyright 2005-2011 Canonical Ltd. Breezy is free software, and you +Copyright 2005-2011 Canonical Ltd. +Copyright 2018 Breezy Developers + +Breezy is free software, and you may use, modify and redistribute both Breezy and this document under the terms of the GNU General Public License version 2 or later. See . From e0a82008e3f7880ae7c64a6d533529beec245a17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 14:23:54 +0000 Subject: [PATCH 12/16] Remove obsolete Makefile. --- breezy/git/Makefile | 80 --------------------------------------------- 1 file changed, 80 deletions(-) delete mode 100644 breezy/git/Makefile diff --git a/breezy/git/Makefile b/breezy/git/Makefile deleted file mode 100644 index d027e6c82b..0000000000 --- a/breezy/git/Makefile +++ /dev/null @@ -1,80 +0,0 @@ -DEBUGGER ?= -BRZ_OPTIONS ?= -BRZ ?= $(shell which brz) -PYTHON ?= $(shell which python) -SETUP ?= ./setup.py -PYDOCTOR ?= pydoctor -CTAGS ?= ctags -PYLINT ?= pylint -RST2HTML ?= rst2html -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 -SUBUNIT_FILTER ?= subunit-filter --fixup-expected-failures=xfail --success --xfail -SUBUNIT_FORMATTER = subunit2pyunit - -all:: build - -build:: - $(SETUP) build - -build-inplace:: - -install:: - $(SETUP) install - -clean:: - $(SETUP) clean - rm -f *.so - -check:: build-inplace - 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) - -list-failing-tests: - $(MAKE) check SUBUNIT_FILTER="subunit-filter -F" SUBUNIT_FORMATTER=subunit-ls | grep -e "^breezy\\." | sort - -xfail: - $(MAKE) -s list-failing-tests > xfail - -check-all:: - $(MAKE) check TESTS="^breezy.plugins.git. Git" SUBUNIT_FILTER=cat - -check-verbose:: - $(MAKE) check TEST_OPTIONS=-v - -check-one:: - $(MAKE) check TEST_OPTIONS=--one - -check-random:: - $(MAKE) check TEST_OPTIONS="--random=now --verbose --one" - -show-plugins:: - BRZ_PLUGINS_AT=git@$(shell pwd) $(BRZ) plugins -v - -lint:: - $(PYLINT) -f parseable *.py */*.py - -tags:: - $(CTAGS) -R . - -ctags:: tags - -coverage:: - $(MAKE) check BRZ_OPTIONS="--coverage coverage" - -.PHONY: update-pot po/brz-git.pot -update-pot: po/brz-git.pot - -TRANSLATABLE_PYFILES:=$(shell find . -name '*.py' \ - | grep -v 'tests/' \ - ) - -po/brz-git.pot: $(PYFILES) $(DOCFILES) - BRZ_PLUGINS_AT=git@$(shell pwd) brz export-pot \ - --plugin=git > po/brz-git.pot - echo $(TRANSLATABLE_PYFILES) | xargs \ - xgettext --package-name "brz-git" \ - --msgid-bugs-address "" \ - --copyright-holder "Canonical Ltd " \ - --from-code ISO-8859-1 --sort-by-file --join --add-comments=i18n: \ - -d brz-git -p po -o brz-git.pot - -.PHONY: xfail From 56fd572a2cf293c564b4f0c3f8c24e945421d831 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 14:23:58 +0000 Subject: [PATCH 13/16] Remove pydoctor references. --- Makefile | 6 ------ 1 file changed, 6 deletions(-) diff --git a/Makefile b/Makefile index 41cae13b48..f4bebd1319 100644 --- a/Makefile +++ b/Makefile @@ -105,12 +105,6 @@ realclean: clean rm -f breezy/*_pyx.c breezy/bzr/*_pyx.c rm -f breezy/_simple_set_pyx.h breezy/_simple_set_pyx_api.h -# Build API documentation -docfiles = brz breezy -api-docs: - mkdir -p api/html - pydoctor --make-html --docformat='restructuredtext' --html-output=api/html $(docfiles) - # build tags for emacs and vim TAGS: ctags -R -e breezy From 5dfc8217b1beaf9650c28d2dbcbba0f06509bb0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 14:25:57 +0000 Subject: [PATCH 14/16] Install sphinx_epytext. --- byov.conf | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/byov.conf b/byov.conf index 2c00813b7f..0ab08590f1 100644 --- a/byov.conf +++ b/byov.conf @@ -9,6 +9,8 @@ subunit.clone = (git clone https://github.com/testing-cabal/subunit.git ../subun fastimport.clone = (git clone git://jelmer.uk/python-fastimport.git ../fastimport.git) fastimport.install = (cd ../fastimport.git && ./setup.py install --user) fastimport.install3 = (cd ../fastimport.git && python3 ./setup.py install --user) +sphinx_epytext.install = (pip install sphinx_epytext) +sphinx_epytext.install3 = (pip3 install sphinx_epytext) [brz] # FIXME: we're stuck on xenial @@ -26,7 +28,7 @@ subunit.build_deps = python-testscenarios, python3-testscenarios, python-testtoo vm.packages = {brz.build_deps}, {subunit.build_deps}, bzr, git, python-junitxml [brz-xenial] vm.release = xenial -byoci.setup.command = ({dulwich.clone} && {dulwich.install} && {dulwich.install3} && {fastimport.clone} && {fastimport.install} && {fastimport.install3} && {subunit.clone}) +byoci.setup.command = ({dulwich.clone} && {dulwich.install} && {dulwich.install3} && {fastimport.clone} && {fastimport.install} && {fastimport.install3} && {subunit.clone} && {sphinx_epytext.install} && {sphinx_epytext.install3}) # FIXME: bzr log -l2 should be by default -- vila 2018-03-09 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" [brz-bionic] From 4de517ad3072ae8297b9291d24ad6b729c00347d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 16:26:08 +0000 Subject: [PATCH 15/16] Fix makefile invocation. --- Makefile | 24 ++++++++++++------------ doc/en/Makefile | 19 +++---------------- 2 files changed, 15 insertions(+), 28 deletions(-) diff --git a/Makefile b/Makefile index f4bebd1319..98fe1a9017 100644 --- a/Makefile +++ b/Makefile @@ -153,8 +153,8 @@ docs-sphinx: html-sphinx # Clean out generated documentation clean-sphinx: - cd doc/en && make clean - cd doc/developers && make clean + $(MAKE) -C doc/en clean + $(MAKE) -C doc/developers clean SPHINX_DEPENDENCIES = \ doc/en/release-notes/index.txt \ @@ -178,8 +178,8 @@ doc/%/make.bat: doc/en/make.bat # Build the html docs using Sphinx. html-sphinx: $(SPHINX_DEPENDENCIES) - cd doc/en && make html - cd doc/developers && make html + $(MAKE) -C doc/en html + $(MAKE) -C doc/developers api html # Build the PDF docs using Sphinx. This requires numerous LaTeX # packages. See http://sphinx.pocoo.org/builders.html for details. @@ -187,23 +187,23 @@ html-sphinx: $(SPHINX_DEPENDENCIES) # they require additional packages to be installed (to handle # Russian hyphenation rules, etc.) pdf-sphinx: $(SPHINX_DEPENDENCIES) - cd doc/en && make latex - cd doc/developers && make latex - cd doc/en/_build/latex && make all-pdf - cd doc/developers/_build/latex && make all-pdf + $(MAKE) -C doc/en latex + $(MAKE) -C doc/developers latex + $(MAKE) -C doc/en/_build/latex all-pdf + $(MAKE) -C doc/developers/_build/latex all-pdf # Build the CHM (Windows Help) docs using Sphinx. # Note: HtmlHelp Workshop needs to be used on the generated hhp files # to generate the final chm files. chm-sphinx: $(SPHINX_DEPENDENCIES) - cd doc/en && make htmlhelp - cd doc/developers && make htmlhelp + $(MAKE) -C doc/en htmlhelp + $(MAKE) -C doc/developers htmlhelp # Build the texinfo files using Sphinx. texinfo-sphinx: $(SPHINX_DEPENDENCIES) - cd doc/en && make texinfo - cd doc/developers && make texinfo + $(MAKE) -C doc/en texinfo + $(MAKE) -C doc/developers texinfo ### Documentation Website ### diff --git a/doc/en/Makefile b/doc/en/Makefile index 001b6d2906..1db55caf18 100644 --- a/doc/en/Makefile +++ b/doc/en/Makefile @@ -11,22 +11,6 @@ PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# Note that this assumes name of the output dir is same as name of the rule. -define make_output_dirs -# Create output directory (only needed for sphinx < 0.5) -[ -d _build ] || mkdir _build -[ -d "_build/$@" ] || mkdir "_build/$@" -# Workaround for a bug in sphinx < 0.5 where it tries to delete -# nonexistent static dirs and does not catch the exception. This was -# fixed in svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x -# at r65551 and merged as 280b62246342 in hg branch released as 0.5. -[ -d "_build/$@/_static" ] || mkdir "_build/$@/_static" -for fn in _static/*; do \ - [ ! -d "$$fn" ] && continue; \ - [ -d "_build/$@/$$fn" ] || mkdir "_build/$@/$$fn"; \ -done -endef - .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest help: @@ -45,6 +29,9 @@ help: clean: -rm -rf _build/* +api: + sphinx-apidoc -feM -s txt -o api ../../breezy + html: $(make_output_dirs) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html From 422df6d22167035b673a8384dc870207727946c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 18 Nov 2018 17:15:39 +0000 Subject: [PATCH 16/16] Fix syntax. --- doc/en/tutorials/centralized_workflow.txt | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/en/tutorials/centralized_workflow.txt b/doc/en/tutorials/centralized_workflow.txt index 888bec68cf..bcac5dc6b7 100644 --- a/doc/en/tutorials/centralized_workflow.txt +++ b/doc/en/tutorials/centralized_workflow.txt @@ -215,7 +215,7 @@ not interrupt people who are working on other parts of the code. Because we have a checkout, any commits made in the ``~/work/sigil/doodle-fixes/`` will also show up on ``centralhost``. [#nestedbranches]_ It is also possible to have two developers collaborate on one of these branches, just -like they would have collaborated on the ``dev`` branch. [#cbranch]_ +like they would have collaborated on the ``dev`` branch. .. [#nestedbranches] It may look odd to have a branch in a subdirectory of another branch. This is just fine, and you can think of it as a @@ -267,8 +267,7 @@ location. This can be done with:: brz+ssh://centralhost/srv/brz/sigil/user-b This gives each developer their own branch to work on. And, they can -easily create a new feature branch for themselves with just [#cbranch]_ -:: +easily create a new feature branch for themselves:: % brz branch brz+ssh://centralhost/srv/brz/sigil/user-a \ brz+ssh://centralhost/srv/brz/sigil/user-a/feature