← 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: 2010-04-08 06:17:41 UTC
  • mfrom: (4797.33.16 apport)
  • Revision ID: pqm@pqm.ubuntu.com-20100408061741-m7vl6z97vu33riv7
(robertc) Make sure ExecutablePath and InterpreterPath are set in
        Apport. (Martin Pool, James Westby, lp:528114)

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
 
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
 
* `Testing <testing.html>`_ |--| Testing bzr.
21
 
 
22
 
* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki) 
23
 
  |--| specific advice on writing Bazaar plugins.
24
 
 
25
 
Process
26
 
=======
27
 
 
28
 
* `Releasing Bazaar <releasing.html>`_ |--| How to make a release of Bazaar,
29
 
  and how to coordinate the monthly development cycle.
30
 
 
31
 
* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
32
 
 
33
 
* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
34
 
  your changes to Bazaar integrated into a release.
35
 
 
36
 
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile 
37
 
  bzr code and visualize the results.
38
 
 
39
 
Plans
40
 
=====
41
 
 
42
 
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap 
43
 
  for fixing performance in bzr over the next few releases.
44
 
 
45
 
Specifications
46
 
==============
47
 
 
48
 
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
49
 
 
50
 
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
51
 
  authentication.
52
 
 
53
 
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
54
 
 
55
 
* `Container format <container-format.html>`_ |--| Notes on a container format
56
 
  for streaming and storing Bazaar data.
57
 
 
58
 
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
59
 
  for repositories (a layer above the container format).
60
 
 
61
 
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
62
 
 
63
 
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
64
 
 
65
 
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
66
 
 
67
 
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
68
 
 
69
 
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
70
 
 
71
 
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
72
 
 
73
 
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
74
 
  any python application.
75
 
 
76
 
Data formats
 
5
 
 
6
Introduction
77
7
============
78
8
 
79
 
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories 
80
 
  (new in Bazaar 0.92).
 
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
81
67
 
82
68
 
83
69
.. |--| unicode:: U+2014