← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/index.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-08-24 21:25:26 UTC
  • mfrom: (4641.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090824212526-5j41jw5zsciji66e
(robertc) Back out draft documentation change landed as 'selftest
        improvements'. (Robert Collins)

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
 
Bazaar user documentation is in the 
6
 
`Main Document Catalog <../index.html>`_.
7
5
 
8
6
Overall developer documentation
9
7
===============================
13
11
* `Architectural Overview <overview.html>`_ |--| describes some of the
14
12
  most important classes and concepts.
15
13
 
16
 
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi-oe/>`_ 
 
14
* `bzrlib API reference <http://starship.python.net/crew/mwh/bzrlibapi/>`_ 
17
15
  (external link)
18
16
  |--| automatically generated API reference information
19
17
 
20
18
* `Integrating with Bazaar <http://bazaar-vcs.org/Integrating_with_Bazaar>`_
21
19
  (wiki) |--| a guide for writing Python programs that work with Bazaar.
22
20
 
23
 
* `Testing <testing.html>`_ |--| Testing bzr.
 
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.
24
26
 
25
27
* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki) 
26
28
  |--| specific advice on writing Bazaar plugins.
28
30
Process
29
31
=======
30
32
 
31
 
* `Releasing Bazaar <releasing.html>`_ |--| How to make a release of Bazaar,
32
 
  and how to coordinate the monthly development cycle.
 
33
* `The Bazaar Development Cycle <cycle.html>`_ |--| The monthly
 
34
  development cycle and how to run it.
 
35
  
 
36
* `Releasing Bazaar <releasing.html>`_ |--| 
 
37
  Checklist to make a release of Bazaar.
33
38
 
34
39
* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
35
40
 
39
44
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile 
40
45
  bzr code and visualize the results.
41
46
 
 
47
* `EC2 resources <ec2.html>`_ |--| A team resource for 
 
48
  Windows packaging and testing, and Ubuntu testing.
 
49
 
 
50
* `Tracking Bugs in Bazaar <bug-handling.html>`_ |--| How we use the bug 
 
51
  tracker.
 
52
 
42
53
Plans
43
54
=====
44
55
 
45
56
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap 
46
57
  for fixing performance in bzr over the next few releases.
47
58
 
 
59
* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
 
60
  for storing multiple branches in one file-system directory.
 
61
 
 
62
* `Bazaar Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
 
63
  Implmentation strategy for Bazaar Windows Shell Extensions, aka
 
64
  TortoiseBzr.
 
65
 
 
66
* `CHK Optimized index <improved_chk_index.html>`_
 
67
 
48
68
Specifications
49
69
==============
50
70
 
51
71
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
52
72
 
 
73
* `Apport error reporting <apport.html>`_ |--| Capture data to report
 
74
  bugs.
 
75
 
53
76
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
54
77
  authentication.
55
78
 
58
81
* `Container format <container-format.html>`_ |--| Notes on a container format
59
82
  for streaming and storing Bazaar data.
60
83
 
61
 
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
62
 
  for repositories (a layer above the container format).
 
84
* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
 
85
  technology used in CHK repositories.
63
86
 
64
87
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
65
88
 
73
96
 
74
97
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
75
98
 
 
99
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
 
100
  for repositories (a layer above the container format).
 
101
 
76
102
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
77
103
  any python application.
78
104
 
 
105
* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
 
106
  |--| How Bazaar operates on case-insensitive file systems such as commonly
 
107
  found on Windows, USB sticks, etc.
 
108
 
 
109
* `Development repository formats <development-repo.html>`_ |--| How to
 
110
  work with repository formats that are still under development.
 
111
  Contains instructions for those implementing new formats, of course,
 
112
  but also for (bleeding-edge) end users of those formats.
 
113
 
79
114
Data formats
80
115
============
81
116
 
82
117
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories 
83
118
  (new in Bazaar 0.92).
84
119
 
 
120
Implementation notes
 
121
====================
 
122
 
 
123
* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
 
124
  to pre-read extra nodes in the btree index.
 
125
 
 
126
* `Computing last_modified values <last-modified.html>`_ for inventory
 
127
  entries
 
128
 
 
129
* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
 
130
  there is not a single unique ancestor (criss-cross merge).
 
131
 
 
132
Miscellaneous
 
133
=============
 
134
 
 
135
* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
 
136
 
 
137
* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
 
138
  performance analysis
 
139
 
85
140
 
86
141
.. |--| unicode:: U+2014
87
142