Merge lp:~gustav-hartvigsson/brz/fix-integration-docs into lp:brz

Proposed by Gustav Hartvigsson on 2021-01-11
Status: Merged
Approved by: Jelmer Vernooij on 2021-01-11
Approved revision: 7530
Merge reported by: The Breezy Bot
Merged at revision: not available
Proposed branch: lp:~gustav-hartvigsson/brz/fix-integration-docs
Merge into: lp:brz
Diff against target: 22 lines (+12/-0)
1 file modified
doc/developers/integration.txt (+12/-0)
To merge this branch: bzr merge lp:~gustav-hartvigsson/brz/fix-integration-docs
Reviewer Review Type Date Requested Status
Jelmer Vernooij 2021-01-11 Approve on 2021-01-11
Review via email: mp+396094@code.launchpad.net

Commit message

Mention the need to load bzr or git modules in the docs.

Description of the change

Request for Comments

Fixed bug #1910860.

To post a comment you must log in.
7529. By Gustav Hartvigsson on 2021-01-11

Fixed documentation related to breezy integration.

* See bug #1910860.

Jelmer Vernooij (jelmer) :
7530. By Gustav Hartvigsson on 2021-01-11

Fixed wording about loading bzr or git medules.

* Made it clearer that the user should only import
  the modules that they need.

Jelmer Vernooij (jelmer) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/developers/integration.txt'
2--- doc/developers/integration.txt 2020-12-11 15:47:15 +0000
3+++ doc/developers/integration.txt 2021-01-11 23:04:48 +0000
4@@ -48,6 +48,18 @@
5 This will send output through the current UIFactory; you can redirect this
6 elsewhere through the parameters to `breezy.initialize`.
7
8+Load the ``bzr`` and/or ``git`` module(s)
9+=========================================
10+The code below have the prerequisite that you have imported either of
11+the ``bzr`` or ``git`` module, or both::
12+
13+ import breezy.bzr
14+ import breezy.git
15+
16+Depending on what the code is intended to do, the corresponding module or
17+modules need to be imported (``bzr`` for Bazaar, and ``git`` for git), or some
18+of the code will not work, and will cause errors like
19+``breezy.errors.NotBranchError``.
20
21 Manipulating the Working Tree
22 =============================

Subscribers

People subscribed via source and target branches