/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/annotate.txt

  • Committer: Andrew Bennetts
  • Date: 2008-08-12 14:53:26 UTC
  • mto: This revision was merged to the branch mainline in revision 3624.
  • Revision ID: andrew.bennetts@canonical.com-20080812145326-yx693x2jc4rcovb7
Move the notes on writing tests out of HACKING into a new file, and improve
them.

Many of the testing notes in the HACKING file were in duplicated in two places
in that file!  This change removes that duplication.  It also adds new sections
on “Where should I put a new test?” and “TestCase and its subclasses”, and
others like “Test feature dependencies” have been expanded.  The whole document
has generally been edited to be a bit more coherent. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/annotate.txt
 
1
Annotate
 
2
========
 
3
 
 
4
Broadly tries to ascribe parts of the tree state to individual commits.
 
5
 
 
6
There appear to be three basic ways of generating annotations:
 
7
 
 
8
If the annotation works by asking the storage layer for successive full texts
 
9
then the scaling of this will be proportional to the time to diff throughout
 
10
the history of thing being annotated.
 
11
 
 
12
If the annotation works by asking the storage layer for successive deltas
 
13
within the history of the thing being annotated we believe we can make it scale
 
14
broadly proportional to the depth of the tree of revisions of the annotated
 
15
object.
 
16
 
 
17
If the annotation works by combining cached annotations such that creating a
 
18
full text recreates annotations for it then it will scale with the cost of
 
19
obtaining that text.
 
20
 
 
21
Generally we want our current annotations but it would be nice to be able to do
 
22
whitespace annotations and potentially other diff based annotations.
 
23
 
 
24
Some things to think about:
 
25
 
 
26
 * Perhaps multiparent deltas would allow us to not store the cached
 
27
   annotations in each delta without losing performance or accuracy.
 
28