← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/index.txt

  • Committer: John Arbash Meinel
  • Date: 2009-03-27 04:23:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4209.
  • Revision ID: john@arbash-meinel.com-20090327042335-5a8ii0h5sa4ktx04
Switch to using a FIFOCache.

That gives us the lookup performance of a dict, while still being capped
at max size.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/index.txt
 
1
=================================
 
2
Bazaar Developer Document Catalog
 
3
=================================
 
4
 
 
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
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
 
81
  for repositories (a layer above the container format).
 
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
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
 
96
  any python application.
 
97
 
 
98
* `Bazaar and case-insensitive file systems <case-insensitive-file-systems.html>`_
 
99
  |--| How Bazaar operates on case-insensitive file systems such as commonly
 
100
  found on Windows, USB sticks, etc.
 
101
 
 
102
* `Development repository formats <development-repo.html>`_ |--| How to
 
103
  work with repository formats that are still under development.
 
104
  Contains instructions for those implementing new formats, of course,
 
105
  but also for (bleeding-edge) end users of those formats.
 
106
 
 
107
Data formats
 
108
============
 
109
 
 
110
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories 
 
111
  (new in Bazaar 0.92).
 
112
 
 
113
Implementation notes
 
114
====================
 
115
 
 
116
* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How bzr decides
 
117
  to pre-read extra nodes in the btree index.
 
118
 
 
119
* `Computing last_modified values <last-modified.html>`_ for inventory
 
120
  entries
 
121
 
 
122
* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
 
123
  there is not a single unique ancestor (criss-cross merge).
 
124
 
 
125
Miscellaneous
 
126
=============
 
127
 
 
128
* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
 
129
 
 
130
* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
 
131
  performance analysis
 
132
 
 
133
 
 
134
.. |--| unicode:: U+2014
 
135
 
 
136
..
 
137
   vim: ft=rst tw=74 ai