/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/developers/index-plain.txt

  • Committer: Vincent Ladeuil
  • Date: 2012-01-18 14:09:19 UTC
  • mto: This revision was merged to the branch mainline in revision 6468.
  • Revision ID: v.ladeuil+lp@free.fr-20120118140919-rlvdrhpc0nq1lbwi
Change set/remove to require a lock for the branch config files.

This means that tests (or any plugin for that matter) do not requires an
explicit lock on the branch anymore to change a single option. This also
means the optimisation becomes "opt-in" and as such won't be as
spectacular as it may be and/or harder to get right (nothing fails
anymore).

This reduces the diff by ~300 lines.

Code/tests that were updating more than one config option is still taking
a lock to at least avoid some IOs and demonstrate the benefits through
the decreased number of hpss calls.

The duplication between BranchStack and BranchOnlyStack will be removed
once the same sharing is in place for local config files, at which point
the Stack class itself may be able to host the changes.

Show diffs side-by-side

added added

removed removed

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