← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/index.txt

  • Committer: Jelmer Vernooij
  • Date: 2009-06-09 00:59:51 UTC
  • mto: (4443.1.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 4444.
  • Revision ID: jelmer@samba.org-20090609005951-apv900cdk35o2ygh
Move squashing of XML-invalid characters to XMLSerializer.

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
* `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/>`_ 
 
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
* `Revision Properties <revision-properties.html>`_ |--| An application
 
24
  can set arbitrary per-revision key/value pairs to store app-specific
 
25
  data.
 
26
 
 
27
* `Testing <testing.html>`_ |--| Guide to writing tests for Bazaar.
 
28
 
 
29
* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki) 
 
30
  |--| specific advice on writing Bazaar plugins.
 
31
 
 
32
Process
 
33
=======
 
34
 
 
35
* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
 
36
  development cycle and how to run it.
 
37
  
 
38
* `Releasing Bazaar <releasing.html>`_ |--| 
 
39
  Checklist to make a release of Bazaar.
 
40
 
 
41
* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
 
42
 
 
43
* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
 
44
  your changes to Bazaar integrated into a release.
 
45
 
 
46
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile 
 
47
  bzr code and visualize the results.
 
48
 
 
49
* `EC2 resources <ec2.html>`_ |--| A team resource for 
 
50
  Windows packaging and testing, and Ubuntu testing.
 
51
 
 
52
Plans
 
53
=====
 
54
 
 
55
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap 
 
56
  for fixing performance in bzr over the next few releases.
 
57
 
 
58
* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
 
59
  for storing multiple branches in one file-system directory.
 
60
 
 
61
* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
 
62
  Implmentation strategy for Bazaar Windows Shell Extensions, aka
 
63
  TortoiseBzr.
 
64
 
 
65
* `CHK Optimized index <improved_chk_index.html>`_
 
66
 
 
67
Specifications
 
68
==============
 
69
 
 
70
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
 
71
 
 
72
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
 
73
  authentication.
 
74
 
 
75
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
 
76
 
 
77
* `Container format <container-format.html>`_ |--| Notes on a container format
 
78
  for streaming and storing Bazaar data.
 
79
 
 
80
* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
 
81
  technology used in CHK repositories.
 
82
 
 
83
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
 
84
 
 
85
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
 
86
 
 
87
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
 
88
 
 
89
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
 
90
 
 
91
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
 
92
 
 
93
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
 
94
 
 
95
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
 
96
  for repositories (a layer above the container format).
 
97
 
 
98
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
 
99
  any python application.
 
100
 
 
101
* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
 
102
  |--| How Bazaar operates on case-insensitive file systems such as commonly
 
103
  found on Windows, USB sticks, etc.
 
104
 
 
105
* `Development repository formats <development-repo.html>`_ |--| How to
 
106
  work with repository formats that are still under development.
 
107
  Contains instructions for those implementing new formats, of course,
 
108
  but also for (bleeding-edge) end users of those formats.
 
109
 
 
110
Data formats
 
111
============
 
112
 
 
113
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories 
 
114
  (new in Bazaar 0.92).
 
115
 
 
116
Implementation notes
 
117
====================
 
118
 
 
119
* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
 
120
  to pre-read extra nodes in the btree index.
 
121
 
 
122
* `Computing last_modified values <last-modified.html>`_ for inventory
 
123
  entries
 
124
 
 
125
* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
 
126
  there is not a single unique ancestor (criss-cross merge).
 
127
 
 
128
Miscellaneous
 
129
=============
 
130
 
 
131
* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
 
132
 
 
133
* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
 
134
  performance analysis
 
135
 
90
136
 
91
137
.. |--| unicode:: U+2014
92
138