/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: John Arbash Meinel
  • Date: 2006-04-25 15:05:42 UTC
  • mfrom: (1185.85.85 bzr-encoding)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: john@arbash-meinel.com-20060425150542-c7b518dca9928691
[merge] the old bzr-encoding changes, reparenting them on bzr.dev

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
 
Make a temporary directory for these tests:
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)
 
5
Branches are created by BzrDir's:
 
6
 
 
7
   >>> from bzrlib.bzrdir import ScratchDir
 
8
   >>> from bzrlib.branch import Branch
 
9
   >>> dir = ScratchDir()
 
10
   >>> new_branch = dir.create_branch()
 
11
 
16
12
 
17
13
Existing Branches can be opened directly:
18
14
 
19
 
   >>> transport = new_branch.controldir.transport
20
 
   >>> another_instance = Branch.open(transport.clone('..').base)
21
 
 
22
 
or via the ControlDir:
23
 
 
24
 
   >>> still_the_same_branch = new_branch.controldir.open_branch()
 
15
   >>> another_instance = Branch.open(dir.transport.clone('..').base)
 
16
 
 
17
or via the BzrDir:
 
18
 
 
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
 
   >>> new_branch.last_revision()
29
 
   'null:'
 
24
   >>> new_branch.revision_history()
 
25
   []
 
26
 
30
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)