/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
1
=================================
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
2
Breezy Developer Document Catalog
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
3
=================================
4
5
6
Overall developer documentation
7
===============================
8
9
* `Developer Guide <HACKING.html>`_
10
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
11
* `Architectural Overview <overview.html>`_ |--| describes some of the
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
12
  most important classes and concepts.
13
7192.3.7 by Jelmer Vernooij
Add API documentation.
14
* `breezy API reference <https://www.breezy-vcs.org/developers/api/>`_
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
15
  (external link)
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
16
  |--| automatically generated API reference information
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
17
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
18
* `Integrating with Breezy <http://wiki.bazaar.canonical.com/Integrating_with_Bazaar>`_
19
  (wiki) |--| a guide for writing Python programs that work with Breezy.
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
20
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
21
* `Revision Properties <revision-properties.html>`_ |--| An application
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
22
  can set arbitrary per-revision key/value pairs to store app-specific
23
  data.
24
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
25
* `Testing <testing.html>`_ |--| Guide to writing tests for Breezy.
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
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
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
29
* `Breezy Code Style Guide <code-style.html>`_.
5225.2.9 by Martin Pool
Split out code style guide from HACKING
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>`_
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
32
  |--| specific advice on writing Breezy plugins. (web link)
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
33
5473.2.5 by Martin Pool
Developer guide to documenting changes
34
* `Documenting changes <documenting-changes.html>`_.
35
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
36
Process
37
=======
38
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
39
* `Releasing Breezy <releasing.html>`_ |--|
40
  Checklist to make a release of Breezy.
41
42
* `Managing the Breezy PPA <ppa.html>`_ |--| Packaging Breezy for Ubuntu.
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
43
5050.22.1 by John Arbash Meinel
Lots of documentation updates.
44
* `Giving back <http://wiki.bazaar.canonical.com/BzrGivingBack>`_ (wiki) |--| How to get
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
45
  your changes to Breezy integrated into a release.
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
46
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
47
* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
48
  brz code and visualize the results.
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
49
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
50
* `EC2 resources <ec2.html>`_ |--| A team resource for
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
51
  Windows packaging and testing, and Ubuntu testing.
52
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
53
* `Tracking Bugs in Breezy <bug-handling.html>`_ |--| How we use the bug
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
54
  tracker.
55
5346.2.1 by Martin Pool
Add some developer docs about symlinks and transports towards bug 192859
56
Architecture overviews
57
======================
58
59
* `Transports <transports.html>`_ |--| Transport virtual filesystem
60
  abstraction.
61
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
62
Plans
63
=====
64
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
65
* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
66
  for fixing performance in brz over the next few releases.
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
67
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
68
* `Co-located branches <colocated-branches.html>`_ |--| Planned(?) support
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
69
  for storing multiple branches in one file-system directory.
70
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
71
* `Breezy Windows Shell Extension Options <tortoise-strategy.html>`_ |--|
72
  Implementation strategy for Breezy Windows Shell Extensions, aka
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
73
  TortoiseBzr.
74
75
* `CHK Optimized index <improved_chk_index.html>`_
76
77
Specifications
78
==============
79
7192.3.7 by Jelmer Vernooij
Add API documentation.
80
* `API versioning <api-versioning.html>`_ |--| breezy API versioning.
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
81
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
82
* `Apport error reporting <apport.html>`_ |--| Capture data to report
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
83
  bugs.
84
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
85
* `Authentication ring <authentication-ring.html>`_ |--| Configuring
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
86
  authentication.
87
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
88
* `Bundles <bundles.html>`_ |--| All about brz bundles.
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
89
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
90
* `Container format <container-format.html>`_ |--| Notes on a container format
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
91
  for streaming and storing Breezy data.
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
92
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
93
* `Groupcompress <groupcompress-design.html>`_ |--| Notes on the compression
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
94
  technology used in CHK repositories.
95
7192.3.7 by Jelmer Vernooij
Add API documentation.
96
* `Indices <indices.html>`_ |--| The index facilities available within
97
  breezy.
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
98
99
* `Inventories <inventory.html>`_ |--| Tree shape abstraction.
100
101
* `LCA merge <lca-merge.html>`_ |--| A nice new merge algorithm.
102
103
* `Network protocol <network-protocol.html>`_ |--| Custom network protocol.
104
105
* `Plugin APIs <plugin-api.html>`_ |--| APIs plugins should use.
106
107
* `Repositories <repository.html>`_ |--| What repositories do and are used for.
108
109
* `Repository stream <repository-stream.html>`_ |--| Notes on streaming data
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
110
  for repositories (a layer above the container format).
111
7192.3.7 by Jelmer Vernooij
Add API documentation.
112
* `Integration Guide <integration.html>`_ |--| A guide to integrate breezy into
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
113
  any python application.
114
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
115
* `Breezy and case-insensitive file systems <case-insensitive-file-systems.html>`_
116
  |--| How Breezy operates on case-insensitive file systems such as commonly
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
117
  found on Windows, USB sticks, etc.
118
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
119
* `Development repository formats <development-repo.html>`_ |--| How to
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
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.
123
124
Data formats
125
============
126
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
127
* `Knit pack repositories <packrepo.html>`_ |--| KnitPack repositories
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
128
  (new in Bazaar 0.92).
129
130
Implementation notes
131
====================
132
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
133
* `BTree Index Prefetch <btree_index_prefetch.html>`_ |--| How brz decides
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
134
  to pre-read extra nodes in the btree index.
135
136
* `Computing last_modified values <last-modified.html>`_ for inventory
137
  entries
138
139
* `Content filtering <content-filtering.html>`_
140
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
141
* `LCA Tree Merging <lca_tree_merging.html>`_ |--| Merging tree-shape when
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
142
  there is not a single unique ancestor (criss-cross merge).
143
144
Miscellaneous
145
=============
146
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
147
* `dirstate <dirstate.html>`_ |--| An observation re. the dirstate file
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
148
6803.1.1 by Jelmer Vernooij
Bunch of developer docs changes:
149
* `"brz update" performance analysis <update.html>`_ |--| "brz update"
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
150
  performance analysis
151
5193.5.8 by Vincent Ladeuil
Revert previous change as I can't reproduce the related problem anymore.
152
153
.. |--| unicode:: U+2014
154
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
155
..
156
   vim: ft=rst tw=74 ai