← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/index.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-12-12 01:24:50 UTC
  • mfrom: (3882.4.2 doc-hacking)
  • Revision ID: pqm@pqm.ubuntu.com-20081212012450-3gw576prpztxziib
(mbp) Developer documentation about when to add new exception classes

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
 
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
* `Architectural Overview <overview.html>`_ |--| describes some of the
 
14
  most important classes and concepts.
 
15
 
 
16
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi-oe/>`_ 
 
17
  (external link)
 
18
  |--| automatically generated API reference information
 
19
 
 
20
* `Integrating with Bazaar <http://bazaar-vcs.org/Integrating_with_Bazaar>`_
 
21
  (wiki) |--| a guide for writing Python programs that work with Bazaar.
 
22
 
 
23
* `Testing <testing.html>`_ |--| Testing bzr.
 
24
 
 
25
* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki) 
 
26
  |--| specific advice on writing Bazaar plugins.
 
27
 
 
28
Process
 
29
=======
 
30
 
 
31
* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
 
32
  development cycle and how to run it.
 
33
  
 
34
* `Releasing Bazaar <releasing.html>`_ |--| 
 
35
  Checklist to make a release of Bazaar.
 
36
 
 
37
* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
 
38
 
 
39
* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
 
40
  your changes to Bazaar integrated into a release.
 
41
 
 
42
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile 
 
43
  bzr code and visualize the results.
 
44
 
 
45
Plans
 
46
=====
 
47
 
 
48
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap 
 
49
  for fixing performance in bzr over the next few releases.
 
50
 
 
51
Specifications
 
52
==============
 
53
 
 
54
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
 
55
 
 
56
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
 
57
  authentication.
 
58
 
 
59
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
 
60
 
 
61
* `Container format <container-format.html>`_ |--| Notes on a container format
 
62
  for streaming and storing Bazaar data.
 
63
 
 
64
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
 
65
  for repositories (a layer above the container format).
 
66
 
 
67
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
 
68
 
 
69
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
 
70
 
 
71
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
 
72
 
 
73
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
 
74
 
 
75
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
 
76
 
 
77
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
 
78
 
 
79
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
 
80
  any python application.
 
81
 
 
82
Data formats
7
83
============
8
84
 
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
 
 
27
 
* `Contributing to Bazaar Documentation <http://wiki.bazaar.canonical.com/ContributingToTheDocs>`_ (wiki)
28
 
 
29
 
 
30
 
Releasing and Packaging
31
 
=======================
32
 
 
33
 
.. toctree::
34
 
   :maxdepth: 1
35
 
 
36
 
   releasing
37
 
   ppa
38
 
   ec2 
39
 
 
40
 
 
41
 
Developing using bzrlib
42
 
=======================
43
 
 
44
 
.. toctree::
45
 
   :maxdepth: 1
46
 
 
47
 
   overview
48
 
   integration
49
 
 
50
 
* `Writing plugins for Bazaar <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_ (web link)
51
 
 
52
 
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_
53
 
  (web link)
54
 
 
55
 
 
56
 
Other documents
57
 
===============
58
 
 
59
 
.. toctree::
60
 
   :maxdepth: 1
61
 
 
62
 
   principles
63
 
   plans
64
 
   specifications
65
 
   implementation-notes
66
 
   miscellaneous-notes
 
85
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories 
 
86
  (new in Bazaar 0.92).
67
87
 
68
88
 
69
89
.. |--| unicode:: U+2014