← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/index-plain.txt

Add a group cache to decompression, 5 times faster than knit at decompression when accessing everything in a group.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/index-plain.txt
1
 
=================================
2
 
Bazaar Developer Document Catalog
3
 
=================================
4
 
 
5
 
 
6
 
Overall developer documentation
7
 
===============================
8
 
 
9
 
* `Developer Guide <HACKING.html>`_
10
 
 
11
 
* `Architectural Overview <overview.html>`_ |--| describes some of the
12
 
  most important classes and concepts.
13
 
 
14
 
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_
15
 
  (external link)
16
 
  |--| automatically generated API reference information
17
 
 
18
 
* `Integrating with Bazaar <http://wiki.bazaar.canonical.com/Integrating_with_Bazaar>`_
19
 
  (wiki) |--| a guide for writing Python programs that work with Bazaar.
20
 
 
21
 
* `Revision Properties <revision-properties.html>`_ |--| An application
22
 
  can set arbitrary per-revision key/value pairs to store app-specific
23
 
  data.
24
 
 
25
 
* `Testing <testing.html>`_ |--| Guide to writing tests for Bazaar.
26
 
 
27
 
* `Code Review <code-review.html>`_.
28
 
 
29
 
* `Bazaar Code Style Guide <code-style.html>`_.
30
 
 
31
 
* `Writing plugins <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_
32
 
  |--| specific advice on writing Bazaar plugins. (web link)
33
 
 
34
 
Process
35
 
=======
36
 
 
37
 
* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
38
 
  development cycle and how to run it.
39
 
 
40
 
* `Releasing Bazaar <releasing.html>`_ |--|
41
 
  Checklist to make a release of Bazaar.
42
 
 
43
 
* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
44
 
 
45
 
* `Giving back <http://wiki.bazaar.canonical.com/BzrGivingBack>`_ (wiki) |--| How to get
46
 
  your changes to Bazaar integrated into a release.
47
 
 
48
 
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
49
 
  bzr code and visualize the results.
50
 
 
51
 
* `EC2 resources <ec2.html>`_ |--| A team resource for
52
 
  Windows packaging and testing, and Ubuntu testing.
53
 
 
54
 
* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug
55
 
  tracker.
56
 
 
57
 
Architecture overviews
58
 
======================
59
 
 
60
 
* `Transports <transports.html>`_ |--| Transport virtual filesystem
61
 
  abstraction.
62
 
 
63
 
Plans
64
 
=====
65
 
 
66
 
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
67
 
  for fixing performance in bzr over the next few releases.
68
 
 
69
 
* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
70
 
  for storing multiple branches in one file-system directory.
71
 
 
72
 
* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
73
 
  Implmentation strategy for Bazaar Windows Shell Extensions, aka
74
 
  TortoiseBzr.
75
 
 
76
 
* `CHK Optimized index <improved_chk_index.html>`_
77
 
 
78
 
Specifications
79
 
==============
80
 
 
81
 
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
82
 
 
83
 
* `Apport error reporting <apport.html>`_ |--| Capture data to report
84
 
  bugs.
85
 
 
86
 
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
87
 
  authentication.
88
 
 
89
 
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
90
 
 
91
 
* `Container format <container-format.html>`_ |--| Notes on a container format
92
 
  for streaming and storing Bazaar data.
93
 
 
94
 
* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
95
 
  technology used in CHK repositories.
96
 
 
97
 
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
98
 
 
99
 
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
100
 
 
101
 
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
102
 
 
103
 
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
104
 
 
105
 
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
106
 
 
107
 
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
108
 
 
109
 
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
110
 
  for repositories (a layer above the container format).
111
 
 
112
 
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
113
 
  any python application.
114
 
 
115
 
* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
116
 
  |--| How Bazaar operates on case-insensitive file systems such as commonly
117
 
  found on Windows, USB sticks, etc.
118
 
 
119
 
* `Development repository formats <development-repo.html>`_ |--| How to
120
 
  work with repository formats that are still under development.
121
 
  Contains instructions for those implementing new formats, of course,
122
 
  but also for (bleeding-edge) end users of those formats.
123
 
 
124
 
Data formats
125
 
============
126
 
 
127
 
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories
128
 
  (new in Bazaar 0.92).
129
 
 
130
 
Implementation notes
131
 
====================
132
 
 
133
 
* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
134
 
  to pre-read extra nodes in the btree index.
135
 
 
136
 
* `Computing last_modified values <last-modified.html>`_ for inventory
137
 
  entries
138
 
 
139
 
* `Content filtering <content-filtering.html>`_
140
 
 
141
 
* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
142
 
  there is not a single unique ancestor (criss-cross merge).
143
 
 
144
 
Miscellaneous
145
 
=============
146
 
 
147
 
* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
148
 
 
149
 
* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
150
 
  performance analysis
151
 
 
152
 
 
153
 
.. |--| unicode:: U+2014
154
 
 
155
 
..
156
 
   vim: ft=rst tw=74 ai