← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/doc/api/branch.txt

  • Committer: Martin Pool
  • Date: 2006-03-21 12:26:54 UTC
  • mto: This revision was merged to the branch mainline in revision 1621.
  • Revision ID: mbp@sourcefrog.net-20060321122654-514047ed65795a17
New developer commands 'weave-list' and 'weave-join'.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/doc/api/branch.txt
2
2
 
3
3
A Branch represents a series of commits and merges carried out by a user.
4
4
 
5
 
Make a temporary directory for these tests:
6
 
 
7
 
   >>> from bzrlib import osutils
8
 
   >>> test_dir = osutils.mkdtemp(prefix='bzrlib_doc_api_branch_txt_')
9
 
 
10
5
Branches are created by BzrDir's:
11
6
 
 
7
   >>> from bzrlib.bzrdir import ScratchDir
12
8
   >>> from bzrlib.branch import Branch
13
 
   >>> from bzrlib.bzrdir import BzrDir
 
9
   >>> dir = ScratchDir()
 
10
   >>> new_branch = dir.create_branch()
14
11
 
15
 
   >>> new_branch = BzrDir.create_branch_convenience(test_dir)
16
12
 
17
13
Existing Branches can be opened directly:
18
14
 
19
 
   >>> transport = new_branch.bzrdir.transport
20
 
   >>> another_instance = Branch.open(transport.clone('..').base)
 
15
   >>> another_instance = Branch.open(dir.transport.clone('..').base)
21
16
 
22
17
or via the BzrDir:
23
18
 
24
 
   >>> still_the_same_branch = new_branch.bzrdir.open_branch()
 
19
   >>> still_the_same_branch = dir.open_branch()
 
20
 
25
21
 
26
22
A branch has a history of revisions on it:
27
23
 
28
24
   >>> new_branch.revision_history()
29
25
   []
30
26
 
 
27
 
31
28
We need to write some more documentation, showing
32
29
push and pull operations. Cloning might also be nice.
33
 
 
34
 
And finally, clean up:
35
 
 
36
 
   >>> import shutil
37
 
   >>> shutil.rmtree(test_dir)