~bzr-pqm/bzr/bzr.dev

1534.4.38 by Robert Collins
Start a branch api document.
1
The Branch API in bzrlib provides creation and management of Branches.
2
3
A Branch represents a series of commits and merges carried out by a user.
4
1740.6.1 by Martin Pool
Remove Scratch objects used by doctests
5
Make a temporary directory for these tests:
6
1996.3.18 by John Arbash Meinel
Now that mkdtemp and rmtree are lazy, they should not be directly improted.
7
   >>> from bzrlib import osutils
8
   >>> test_dir = osutils.mkdtemp(prefix='bzrlib_doc_api_branch_txt_')
1740.6.1 by Martin Pool
Remove Scratch objects used by doctests
9
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
10
Branches are created by BzrDir's:
1534.4.38 by Robert Collins
Start a branch api document.
11
12
   >>> from bzrlib.branch import Branch
1740.6.1 by Martin Pool
Remove Scratch objects used by doctests
13
   >>> from bzrlib.bzrdir import BzrDir
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
14
1740.6.1 by Martin Pool
Remove Scratch objects used by doctests
15
   >>> new_branch = BzrDir.create_branch_convenience(test_dir)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
16
17
Existing Branches can be opened directly:
18
1740.6.1 by Martin Pool
Remove Scratch objects used by doctests
19
   >>> transport = new_branch.bzrdir.transport
20
   >>> another_instance = Branch.open(transport.clone('..').base)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
21
22
or via the BzrDir:
23
1740.6.1 by Martin Pool
Remove Scratch objects used by doctests
24
   >>> still_the_same_branch = new_branch.bzrdir.open_branch()
1534.4.38 by Robert Collins
Start a branch api document.
25
26
A branch has a history of revisions on it:
27
28
   >>> new_branch.revision_history()
29
   []
30
31
We need to write some more documentation, showing
32
push and pull operations. Cloning might also be nice.
1740.6.1 by Martin Pool
Remove Scratch objects used by doctests
33
34
And finally, clean up:
35
36
   >>> import shutil
37
   >>> shutil.rmtree(test_dir)