← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/index.txt

  • Committer: John Arbash Meinel
  • Date: 2008-08-28 20:13:31 UTC
  • mfrom: (3658 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3688.
  • Revision ID: john@arbash-meinel.com-20080828201331-dqffxf54l2heokll
Merge bzr.dev 3658

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/index.txt
2
2
Bazaar Developer Document Catalog
3
3
=================================
4
4
 
5
 
 
6
 
Introduction
7
 
============
8
 
 
9
 
.. toctree::
10
 
   :maxdepth: 1
11
 
 
12
 
   contribution-quickstart
13
 
 
14
 
 
15
 
Working on Bazaar
16
 
=================
17
 
 
18
 
.. toctree::
19
 
   :maxdepth: 1
20
 
 
21
 
   cycle
22
 
   profiling
23
 
   bug-handling
24
 
   HACKING
25
 
   testing
26
 
   code-review
27
 
   code-style
28
 
   documenting-changes
29
 
 
30
 
* `Contributing to Bazaar Documentation <http://wiki.bazaar.canonical.com/ContributingToTheDocs>`_ (wiki)
31
 
 
32
 
 
33
 
Architecture overviews
34
 
======================
35
 
 
36
 
.. toctree::
37
 
   :maxdepth: 1
38
 
 
39
 
   configuration
40
 
   fetch
41
 
   transports
42
 
   ui
43
 
 
44
 
Releasing and Packaging
45
 
=======================
46
 
 
47
 
.. toctree::
48
 
   :maxdepth: 1
49
 
 
50
 
   releasing
51
 
   ppa
52
 
   ec2 
53
 
 
54
 
 
55
 
Developing using bzrlib
56
 
=======================
57
 
 
58
 
.. toctree::
59
 
   :maxdepth: 1
60
 
 
61
 
   overview
62
 
   integration
63
 
 
64
 
* `Writing plugins for Bazaar <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_ (web link)
65
 
 
66
 
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_
67
 
  (web link)
68
 
 
69
 
 
70
 
Other documents
71
 
===============
72
 
 
73
 
.. toctree::
74
 
   :maxdepth: 1
75
 
 
76
 
   principles
77
 
   plans
78
 
   specifications
79
 
   implementation-notes
80
 
   miscellaneous-notes
81
 
 
82
 
 
83
 
Licence
84
 
============
85
 
 
86
 
Copyright 2005-2011 Canonical Ltd. Bazaar is free software, and you
87
 
may use, modify and redistribute both Bazaar and this document under
88
 
the terms of the GNU General Public License version 2 or later.  See
89
 
<http://www.gnu.org/licenses/>.
 
5
Bazaar user documentation is in the 
 
6
`Main Document Catalog <../index.html>`_.
 
7
 
 
8
Overall developer documentation
 
9
===============================
 
10
 
 
11
* `Developer Guide <../en/developer-guide/HACKING.html>`_
 
12
 
 
13
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi-oe/>`_ 
 
14
  (external link)
 
15
  |--| automatically generated API reference information
 
16
 
 
17
* `Integrating with Bazaar <http://bazaar-vcs.org/Integrating_with_Bazaar>`_
 
18
  (wiki) |--| a guide for writing Python programs that work with Bazaar.
 
19
 
 
20
* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki) 
 
21
  |--| specific advice on writing Bazaar plugins.
 
22
 
 
23
Process
 
24
=======
 
25
 
 
26
* `Releasing Bazaar <releasing.html>`_ |--| How to make a release of Bazaar,
 
27
  and how to coordinate the monthly development cycle.
 
28
 
 
29
* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
 
30
 
 
31
* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
 
32
  your changes to Bazaar integrated into a release.
 
33
 
 
34
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile 
 
35
  bzr code and visualize the results.
 
36
 
 
37
Plans
 
38
=====
 
39
 
 
40
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap 
 
41
  for fixing performance in bzr over the next few releases.
 
42
 
 
43
Specifications
 
44
==============
 
45
 
 
46
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
 
47
 
 
48
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
 
49
  authentication.
 
50
 
 
51
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
 
52
 
 
53
* `Container format <container-format.html>`_ |--| Notes on a container format
 
54
  for streaming and storing Bazaar data.
 
55
 
 
56
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
 
57
  for repositories (a layer above the container format).
 
58
 
 
59
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
 
60
 
 
61
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
 
62
 
 
63
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
 
64
 
 
65
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
 
66
 
 
67
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
 
68
 
 
69
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
 
70
 
 
71
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
 
72
  any python application.
 
73
 
 
74
Data formats
 
75
============
 
76
 
 
77
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories 
 
78
  (new in Bazaar 0.92).
 
79
 
90
80
 
91
81
.. |--| unicode:: U+2014
92
82