1
=================================
2
Bazaar Developer Document Catalog
3
=================================
6
Overall developer documentation
7
===============================
9
* `Developer Guide <HACKING.html>`_
11
* `Architectural Overview <overview.html>`_ |--| describes some of the
12
most important classes and concepts.
14
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_
16
|--| automatically generated API reference information
18
* `Integrating with Bazaar <http://wiki.bazaar.canonical.com/Integrating_with_Bazaar>`_
19
(wiki) |--| a guide for writing Python programs that work with Bazaar.
21
* `Revision Properties <revision-properties.html>`_ |--| An application
22
can set arbitrary per-revision key/value pairs to store app-specific
25
* `Testing <testing.html>`_ |--| Guide to writing tests for Bazaar.
27
* `Code Review <code-review.html>`_.
29
* `Bazaar Code Style Guide <code-style.html>`_.
31
* `Writing plugins <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_
32
|--| specific advice on writing Bazaar plugins. (web link)
37
* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
38
development cycle and how to run it.
40
* `Releasing Bazaar <releasing.html>`_ |--|
41
Checklist to make a release of Bazaar.
43
* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
45
* `Giving back <http://wiki.bazaar.canonical.com/BzrGivingBack>`_ (wiki) |--| How to get
46
your changes to Bazaar integrated into a release.
48
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
49
bzr code and visualize the results.
51
* `EC2 resources <ec2.html>`_ |--| A team resource for
52
Windows packaging and testing, and Ubuntu testing.
54
* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug
57
Architecture overviews
58
======================
60
* `Transports <transports.html>`_ |--| Transport virtual filesystem
66
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
67
for fixing performance in bzr over the next few releases.
69
* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
70
for storing multiple branches in one file-system directory.
72
* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
73
Implmentation strategy for Bazaar Windows Shell Extensions, aka
76
* `CHK Optimized index <improved_chk_index.html>`_
81
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
83
* `Apport error reporting <apport.html>`_ |--| Capture data to report
86
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
89
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
91
* `Container format <container-format.html>`_ |--| Notes on a container format
92
for streaming and storing Bazaar data.
94
* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
95
technology used in CHK repositories.
97
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
99
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
101
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
103
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
105
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
107
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
109
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
110
for repositories (a layer above the container format).
112
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
113
any python application.
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.
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.
127
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories
128
(new in Bazaar 0.92).
133
* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
134
to pre-read extra nodes in the btree index.
136
* `Computing last_modified values <last-modified.html>`_ for inventory
139
* `Content filtering <content-filtering.html>`_
141
* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
142
there is not a single unique ancestor (criss-cross merge).
147
* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
149
* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
153
.. |--| unicode:: U+2014