~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
3408.1.6 by Martin Pool
Fix link to developer guide
11
* `Developer Guide <../en/developer-guide/HACKING.html>`_
3464.3.5 by Martin Pool
ReST tweaks and link back from HACKING to catalog
12
3683.1.1 by Martin Pool
Improved review process docs and separate out architectural overview
13
* `Architectural Overview <overview.html>`_ |--| describes some of the
14
  most important classes and concepts.
15
3995.5.2 by Martin Pool
Remove links to editable api docs; just point to generated ones
16
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_ 
3464.3.16 by Martin Pool
Point directly to API docs
17
  (external link)
3464.3.5 by Martin Pool
ReST tweaks and link back from HACKING to catalog
18
  |--| automatically generated API reference information
2534.1.1 by Robert Collins
Create a document describing bundles and their motivation.
19
3464.3.9 by Martin Pool
Add plugin and integration guides to doc indexes
20
* `Integrating with Bazaar <http://bazaar-vcs.org/Integrating_with_Bazaar>`_
21
  (wiki) |--| a guide for writing Python programs that work with Bazaar.
22
4070.10.12 by Martin Pool
Clearer developer doc link text
23
* `Testing <testing.html>`_ |--| Guide to writing tests for Bazaar.
3653.1.1 by Robert Collins
Move testing.txt to be with the other developers documents.
24
3464.3.9 by Martin Pool
Add plugin and integration guides to doc indexes
25
* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki) 
26
  |--| specific advice on writing Bazaar plugins.
27
2534.1.1 by Robert Collins
Create a document describing bundles and their motivation.
28
Process
29
=======
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)
30
3778.2.1 by Martin Pool
Updated release process documentation.
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.
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
36
3549.3.1 by Martin Pool
Updated instructions in packaging into the PPA
37
* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
38
3464.3.9 by Martin Pool
Add plugin and integration guides to doc indexes
39
* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
40
  your changes to Bazaar integrated into a release.
41
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
42
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile 
43
  bzr code and visualize the results.
2534.1.1 by Robert Collins
Create a document describing bundles and their motivation.
44
4012.2.1 by Martin Pool
Documentation on using EC2 Windows VM
45
* `EC2 Windows server <ec2-windows.html>`_ |--| A team resource for 
46
  Windows packaging and testing.
47
2534.1.1 by Robert Collins
Create a document describing bundles and their motivation.
48
Plans
49
=====
50
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
51
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap 
52
  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.
53
2534.1.1 by Robert Collins
Create a document describing bundles and their motivation.
54
Specifications
55
==============
56
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
57
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
58
3418.5.1 by Vincent Ladeuil
Fix #183705 by updating the authentication docs regarding ssh agents.
59
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
60
  authentication.
61
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
62
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
63
64
* `Container format <container-format.html>`_ |--| Notes on a container format
65
  for streaming and storing Bazaar data.
66
3350.3.1 by Robert Collins
Draft up an interface for repository streams that is more capable than the
67
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
68
  for repositories (a layer above the container format).
69
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
70
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
71
3152.1.3 by Robert Collins
Resolve conflicts with bzr.dev.
72
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
73
74
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
75
76
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
77
3246.6.1 by Robert Collins
Add a plugin-api.txt developer document starting to description services for/from plugins.
78
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
79
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
80
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
81
3250.4.1 by Martin Albisetti
Added integration guide for developers
82
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
83
  any python application.
84
3794.5.33 by Mark Hammond
Add link to case-insensitive-file-systems doc.
85
* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
3932.3.1 by Martin Pool
merge cicp patch, correct rest syntax and news typo
86
  |--| How Bazaar operates on case-insensitive file systems such as commonly
87
  found on Windows, USB sticks, etc.
3794.5.33 by Mark Hammond
Add link to case-insensitive-file-systems doc.
88
2592.3.229 by Martin Pool
Initial pack format documentation
89
Data formats
2535.4.31 by Andrew Bennetts
Tweak in response to review comments.
90
============
2592.3.229 by Martin Pool
Initial pack format documentation
91
3052.6.1 by Matt Nordhoff
doc/developers/index.txt: Fix link to pack docs.
92
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories 
2592.3.229 by Martin Pool
Initial pack format documentation
93
  (new in Bazaar 0.92).
94
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
95
96
.. |--| unicode:: U+2014
3464.3.5 by Martin Pool
ReST tweaks and link back from HACKING to catalog
97
98
..
99
   vim: ft=rst tw=74 ai