Merge lp://qastaging/~ian-clatworthy/bzr-externals/format-fixes-for-plugin-guide into lp://qastaging/bzr-externals

Proposed by Ian Clatworthy
Status: Merged
Merged at revision: not available
Proposed branch: lp://qastaging/~ian-clatworthy/bzr-externals/format-fixes-for-plugin-guide
Merge into: lp://qastaging/bzr-externals
Diff against target: 54 lines (+25/-16)
1 file modified
__init__.py (+25/-16)
To merge this branch: bzr merge lp://qastaging/~ian-clatworthy/bzr-externals/format-fixes-for-plugin-guide
Reviewer Review Type Date Requested Status
Eugene Tarasenko Pending
Review via email: mp+15082@code.qastaging.launchpad.net
To post a comment you must log in.
Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote :

This makes some formatting improvements ready for this plugin to be added to the Plugins Guide: http://doc.bazaar-vcs.org/plugins/en/

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file '__init__.py'
2--- __init__.py 2009-11-18 13:12:42 +0000
3+++ __init__.py 2009-11-20 10:25:21 +0000
4@@ -16,25 +16,34 @@
5
6 """Support external branches like svn:externals.
7
8-Description:
9- Supports external branches for commands: branch/checkout, pull/update via
10- hooks. Works from any client: bzr, QBzr, TortoiseBzr or Bazaar Explorer.
11-
12- To use external branch please add to '.bzrmeta/externals' file line of the
13- following format:
14- url directory [revisionspec]
15-
16-Examples:
17+Using hooks, this plugin supports external branches for these commands:
18+
19+* branch
20+* checkout
21+* pull
22+* update.
23+
24+Works from any client including bzr, QBzr, TortoiseBzr and Bazaar Explorer.
25+
26+To define an external branch, add a line to the ``.bzrmeta/externals`` file
27+using the following format::
28+
29+ url directory [revisionspec]
30+
31+Example definitions are::
32+
33 bzr://bzr.server/my.project/trunk my.project
34 http://svn.server/libs/trunk/my.lib libs/my.lib revno:100
35
36-Issues:
37- Not supports '^/' expression in relative urls.
38-
39- Pull command not overwrite you working tree if you use custom revision.
40-
41- Update command not supports custom revision and not call externals
42- if branch tip not changed.
43+Known issues:
44+
45+* Does not support ``^/`` expression in relative urls.
46+
47+* pull command does not overwrite your working tree if you use a custom
48+ revision.
49+
50+* update command does not support a custom revision and does not check
51+ externals if the branch tip is not changed.
52 """
53
54 from bzrlib import branch

Subscribers

People subscribed via source and target branches