/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

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

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/doc/api/branch.txt
1
 
The Branch API in breezy provides creation and management of Branches.
 
1
The Branch API in bzrlib provides creation and management of Branches.
2
2
 
3
3
A Branch represents a series of commits and merges carried out by a user.
4
4
 
5
5
Make a temporary directory for these tests:
6
6
 
7
 
   >>> from breezy import osutils
8
 
   >>> test_dir = osutils.mkdtemp(prefix='breezy_doc_api_branch_txt_')
9
 
 
10
 
Branches are created by ControlDir's:
11
 
 
12
 
   >>> from breezy.branch import Branch
13
 
   >>> from breezy.controldir import ControlDir
14
 
 
15
 
   >>> new_branch = ControlDir.create_branch_convenience(test_dir)
 
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
16
 
17
17
Existing Branches can be opened directly:
18
18
 
19
 
   >>> transport = new_branch.controldir.transport
 
19
   >>> transport = new_branch.bzrdir.transport
20
20
   >>> another_instance = Branch.open(transport.clone('..').base)
21
21
 
22
 
or via the ControlDir:
 
22
or via the BzrDir:
23
23
 
24
 
   >>> still_the_same_branch = new_branch.controldir.open_branch()
 
24
   >>> still_the_same_branch = new_branch.bzrdir.open_branch()
25
25
 
26
26
A branch has a history of revisions on it:
27
27
 
28
 
   >>> new_branch.last_revision()
29
 
   'null:'
 
28
   >>> new_branch.revision_history()
 
29
   []
30
30
 
31
31
We need to write some more documentation, showing
32
32
push and pull operations. Cloning might also be nice.