← 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: John Arbash Meinel
  • Date: 2005-09-15 21:35:53 UTC
  • mfrom: (907.1.57)
  • mto: (1393.2.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050915213552-a6c83a5ef1e20897
(broken) Transport work is merged in. Tests do not pass yet.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/doc/api/branch.txt
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
 
 
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
 
Branches are created by BzrDir's:
11
 
 
12
 
   >>> from bzrlib.branch import Branch
13
 
   >>> from bzrlib.bzrdir import BzrDir
14
 
 
15
 
   >>> new_branch = BzrDir.create_branch_convenience(test_dir)
16
 
 
17
 
Existing Branches can be opened directly:
18
 
 
19
 
   >>> transport = new_branch.bzrdir.transport
20
 
   >>> another_instance = Branch.open(transport.clone('..').base)
21
 
 
22
 
or via the BzrDir:
23
 
 
24
 
   >>> still_the_same_branch = new_branch.bzrdir.open_branch()
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.
33
 
 
34
 
And finally, clean up:
35
 
 
36
 
   >>> import shutil
37
 
   >>> shutil.rmtree(test_dir)