~bzr-pqm/bzr/bzr.dev

4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
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
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
14
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
15
  (external link)
16
  |--| automatically generated API reference information
17
18
* `Integrating with Bazaar <http://bazaar-vcs.org/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
5225.2.3 by Martin Pool
Split out code review guidelines, and (sadly) remove Bundle Buggy from it. RIP.
27
* `Code Review <code-review.html>`_.
28
5225.2.9 by Martin Pool
Split out code style guide from HACKING
29
* `Bazaar Code Style Guide <code-style.html>`_.
30
5053.2.1 by Parth Malwankar
updated linkes for top level doc site and plugin-development guide
31
* `Writing plugins <http://doc.bazaar.canonical.com/plugins/en/plugin-development.html>`_
5053.2.3 by Parth Malwankar
indicate a weblink
32
  |--| specific advice on writing Bazaar plugins. (web link)
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
33
34
Process
35
=======
36
37
* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
38
  development cycle and how to run it.
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
39
40
* `Releasing Bazaar <releasing.html>`_ |--|
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
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://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
46
  your changes to Bazaar integrated into a release.
47
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
48
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
49
  bzr code and visualize the results.
50
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
51
* `EC2 resources <ec2.html>`_ |--| A team resource for
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
52
  Windows packaging and testing, and Ubuntu testing.
53
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
54
* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
55
  tracker.
56
57
Plans
58
=====
59
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
60
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
61
  for fixing performance in bzr over the next few releases.
62
63
* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
64
  for storing multiple branches in one file-system directory.
65
66
* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
67
  Implmentation strategy for Bazaar Windows Shell Extensions, aka
68
  TortoiseBzr.
69
70
* `CHK Optimized index <improved_chk_index.html>`_
71
72
Specifications
73
==============
74
75
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
76
77
* `Apport error reporting <apport.html>`_ |--| Capture data to report
78
  bugs.
79
80
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
81
  authentication.
82
83
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
84
85
* `Container format <container-format.html>`_ |--| Notes on a container format
86
  for streaming and storing Bazaar data.
87
88
* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
89
  technology used in CHK repositories.
90
91
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
92
93
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
94
95
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
96
97
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
98
99
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
100
101
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
102
103
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
104
  for repositories (a layer above the container format).
105
106
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
107
  any python application.
108
109
* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
110
  |--| How Bazaar operates on case-insensitive file systems such as commonly
111
  found on Windows, USB sticks, etc.
112
113
* `Development repository formats <development-repo.html>`_ |--| How to
114
  work with repository formats that are still under development.
115
  Contains instructions for those implementing new formats, of course,
116
  but also for (bleeding-edge) end users of those formats.
117
118
Data formats
119
============
120
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
121
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
122
  (new in Bazaar 0.92).
123
124
Implementation notes
125
====================
126
127
* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
128
  to pre-read extra nodes in the btree index.
129
130
* `Computing last_modified values <last-modified.html>`_ for inventory
131
  entries
132
133
* `Content filtering <content-filtering.html>`_
134
135
* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
136
  there is not a single unique ancestor (criss-cross merge).
137
138
Miscellaneous
139
=============
140
141
* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
142
143
* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
144
  performance analysis
145
146
147
.. |--| unicode:: U+2014
148
149
..
150
   vim: ft=rst tw=74 ai