~bzr-pqm/bzr/bzr.dev

2691.1.7 by Ian Clatworthy
Update doc indexes following discussion with poolie on IRC
1
=================================
2
Bazaar Developer Document Catalog
3
=================================
2481.1.4 by Robert Collins
Fix the developer documentation to use the right style sheet and give it its own index. (Robert Collins, Alexander Belchenko)
4
3383.2.1 by Martin Pool
Point to all developer documentation doc/developer/index
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
* `bzrlib API reference <http://bazaar-vcs.org/BzrLib>`_
2534.1.1 by Robert Collins
Create a document describing bundles and their motivation.
13
14
Process
15
=======
2481.1.4 by Robert Collins
Fix the developer documentation to use the right style sheet and give it its own index. (Robert Collins, Alexander Belchenko)
16
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
17
* `Releasing Bazaar <releasing.html>`_ -- How to make a release of Bazaar,
18
  and how to coordinate the monthly development cycle.
19
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
20
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile 
21
  bzr code and visualize the results.
2534.1.1 by Robert Collins
Create a document describing bundles and their motivation.
22
23
Plans
24
=====
25
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
26
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap 
27
  for fixing performance in bzr over the next few releases.
2499.4.1 by Andrew Bennetts
First draft of container format developer doc, based on discussion with Robert.
28
2534.1.1 by Robert Collins
Create a document describing bundles and their motivation.
29
Specifications
30
==============
31
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
32
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
33
3418.5.1 by Vincent Ladeuil
Fix #183705 by updating the authentication docs regarding ssh agents.
34
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
35
  authentication.
36
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
37
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
38
39
* `Container format <container-format.html>`_ |--| Notes on a container format
40
  for streaming and storing Bazaar data.
41
3350.3.1 by Robert Collins
Draft up an interface for repository streams that is more capable than the
42
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
43
  for repositories (a layer above the container format).
44
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
45
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
46
3152.1.3 by Robert Collins
Resolve conflicts with bzr.dev.
47
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
48
49
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
50
51
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
52
3246.6.1 by Robert Collins
Add a plugin-api.txt developer document starting to description services for/from plugins.
53
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
54
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
55
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
56
3250.4.1 by Martin Albisetti
Added integration guide for developers
57
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
58
  any python application.
59
2592.3.229 by Martin Pool
Initial pack format documentation
60
Data formats
2535.4.31 by Andrew Bennetts
Tweak in response to review comments.
61
============
2592.3.229 by Martin Pool
Initial pack format documentation
62
3052.6.1 by Matt Nordhoff
doc/developers/index.txt: Fix link to pack docs.
63
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories 
2592.3.229 by Martin Pool
Initial pack format documentation
64
  (new in Bazaar 0.92).
65
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
66
67
.. |--| unicode:: U+2014