« back to all changes in this revision
Viewing changes to doc/developers/index.txt
- browse files at revision 4634.39.10
- compare with another revision
- compare with revision 3321
- download diff
- download tarball
- view history from revision 4634.39.10
- Committer: Ian Clatworthy
- Date: 2009-09-07 07:44:36 UTC
- mto: (4634.37.2 prepare-2.0)
- mto: This revision was merged to the branch mainline in revision 4689.
- Revision ID: ian.clatworthy@canonical.com-20090907074436-pede7phglz90jrvf
split developer docs into their own website/chm file
- files added:
- doc/developers/Makefile
- doc/developers/_static
- doc/developers/_templates
- files removed:
- doc/en/developer-guide
- files renamed:
- doc/en/developer-guide/HACKING.txt => doc/developers/HACKING.txt
- files modified:
- doc/conf.py
added
removed
doc/developers/index.txt
2
2
Bazaar Developer Document Catalog
3
3
=================================
4
4
5
6
Overall developer documentation
7
===============================
8
9
* `Developer Guide <../en/developer-guide/HACKING.html>`_
10
11
* `Architectural Overview <overview.html>`_ |--| describes some of the
12
most important classes and concepts.
5
.. toctree::
6
:hidden:
7
8
process
9
HACKING
10
testing
11
overview
12
integration
13
plans
14
specifications
15
implementation-notes
16
miscellaneous-notes
17
18
19
Core developer documentation
20
============================
21
22
* `Process Docs <process.html>`_ |--| How Bazaar is developed
23
24
* `Developer Guide <HACKING.html>`_ |--| Guide to writing code for Bazaar
25
26
* `Testing Guide <testing.html>`_ |--| Guide to writing tests for Bazaar
27
28
* `Writer Guide <http://bazaar-vcs.org/ContributingToTheDocs>`_ (web link)
29
|--| Guide to writing documentation for Bazaar
30
31
* `Architectural Overview <overview.html>`_ |--| Describes some of the
32
most important classes and concepts
33
34
* `Integration Guide <integration.html>`_ |--| A guide to integrating Bazaar
35
into other applications
36
37
* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (web link)
38
|--| Advice on writing Bazaar plugins
13
39
14
40
* `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://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
27
* `Writing plugins <http://bazaar-vcs.org/WritingPlugins>`_ (wiki)
28
|--| specific advice on writing Bazaar plugins.
29
30
Process
31
=======
32
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.
38
39
* `Managing the Bazaar PPA <ppa.html>`_ |--| Packaging Bazaar for Ubuntu.
40
41
* `Giving back <http://bazaar-vcs.org/BzrGivingBack>`_ (wiki) |--| How to get
42
your changes to Bazaar integrated into a release.
43
44
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
45
bzr code and visualize the results.
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
53
Plans
54
=====
55
56
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
57
for fixing performance in bzr over the next few releases.
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
68
Specifications
69
==============
70
71
* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
72
73
* `Apport error reporting <apport.html>`_ |--| Capture data to report
74
bugs.
75
76
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
77
authentication.
78
79
* `Bundles <bundles.html>`_ |--| All about bzr bundles.
80
81
* `Container format <container-format.html>`_ |--| Notes on a container format
82
for streaming and storing Bazaar data.
83
84
* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
85
technology used in CHK repositories.
86
87
* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
88
89
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
90
91
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
92
93
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
94
95
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
96
97
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
98
99
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
100
for repositories (a layer above the container format).
101
102
* `Integration Guide <integration.html>`_ |--| A guide to integrate bzrlib into
103
any python application.
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
114
Data formats
115
============
116
117
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories
118
(new in Bazaar 0.92).
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
* `Content filtering <content-filtering.html>`_
130
131
* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
132
there is not a single unique ancestor (criss-cross merge).
133
134
Miscellaneous
135
=============
136
137
* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
138
139
* `"bzr update" performance analysis <update.html>`_ |--| "bzr update"
140
performance analysis
41
(web link)
42
|--| Automatically generated API reference information
43
44
45
Other developer documentation
46
=============================
47
48
* `Plans <plans.html>`_
49
50
* `Specifications <specifications.html>`_
51
52
* `Implementation notes <implementation-notes.html>`_
53
54
* `Miscellaneous notes <miscellaneous-notes.html>`_
141
55
142
56
143
57
.. |--| unicode:: U+2014
Loggerhead is a web-based interface for Breezy
Version: 2.0.1