~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

Add RepositoryFormats and allow bzrdir.open or create _repository to be used.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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
Branches are created at urls or file paths:
 
6
 
 
7
   >>> from tempfile import mkdtemp
 
8
   >>> from bzrlib.branch import Branch
 
9
   >>> branchdir = mkdtemp()
 
10
   >>> new_branch = Branch.create(branchdir)
 
11
 
 
12
A branch has a history of revisions on it:
 
13
 
 
14
   >>> new_branch.revision_history()
 
15
   []
 
16
 
 
17
 
 
18
We need to write some more documentation, showing
 
19
push and pull operations. Cloning might also be nice.