← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/inventory.txt

  • Committer: Andrew Bennetts
  • Date: 2009-04-02 05:53:12 UTC
  • mto: This revision was merged to the branch mainline in revision 4242.
  • Revision ID: andrew.bennetts@canonical.com-20090402055312-h7mvgumvm7e620mj
Fix nits in spelling and naming.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/inventory.txt
456
456
Inventory deltas
457
457
================
458
458
 
459
 
An inventory is a serialization of the in-memory inventory delta.  To serialise
 
459
An inventory is a serialization of the in-memory inventory delta.  To serialize
460
460
an inventory delta, one takes an existing inventory delta and the revision_id
461
461
of the revision it was created it against and the revision id of the inventory
462
 
which should result by applying the delta to the parent.  We then serialise
 
462
which should result by applying the delta to the parent.  We then serialize
463
463
every item in the delta in a simple format:
464
464
 
465
 
'format: bzr journalled inventory v1' NL
466
 
'parent:' SP BASIS_INVENTORY NL 
467
 
'version:' SP NULL_OR_REVISION NL 
 
465
'format: bzr inventory delta v1 (1.14)' NL
 
466
'parent:' SP BASIS_INVENTORY NL
 
467
'version:' SP NULL_OR_REVISION NL
468
468
'versioned_root:' SP BOOL NL
469
469
'tree_references:' SP BOOL NL
470
470
DELTA_LINES
471
471
 
472
 
 
473
472
DELTA_LINES ::= (DELTA_LINE NL)*
474
473
DELTA_LINE ::= OLDPATH NULL NEWPATH NULL file-id NULL PARENT_ID NULL LAST_MODIFIED NULL CONTENT
475
474
SP ::= ' '
492
491
REVISION ::= revision-id-in-utf8-no-whitespace
493
492
EXEC ::= '' | 'Y'
494
493
 
495
 
DELTA_LINES is lexographically sorted.
 
494
DELTA_LINES is lexicographically sorted.
496
495
 
497
496
Some explanation is in order. When NEWPATH is 'None' a delete has been
498
 
recorded, and because this journalled inventory is not attempting to be a
499
 
reversible journal, the only other valid field is 'file-id'. PARENT_ID is ''
 
497
recorded, and because this inventory delta is not attempting to be a reversible
 
498
delta, the only other valid fields are OLDPATH and 'file-id'. PARENT_ID is ''
500
499
when a delete has been recorded or when recording a new root entry.
501
500