Rooba
/
perkeep
mirror of https://github.com/perkeep/perkeep.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

minor documentation updates

This commit is contained in:
Daniel Erat 2010-11-04 21:06:52 -07:00
parent d796f43fd9
commit bd2b45c23e
4 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/json-signing.txt
View File

@ -72,7 +72,7 @@ SIGNING
we'll call this data structure 'O'. we'll call this data structure 'O'.
-- serialize it with whatever JSON serialization library you have -- serialize it with whatever JSON serialization library you have
available. internal or traliing whitespace doesn't matter. we'll available. internal or trailing whitespace doesn't matter. we'll
call the JSON serialization of 'O' (defined in earlier step) 'J' call the JSON serialization of 'O' (defined in earlier step) 'J'
(e.g. doc/examples/signing-before.camli) (e.g. doc/examples/signing-before.camli)

4
doc/overview.txt
View File

@ -77,7 +77,7 @@ Schema of files/objects in Layer 1:
Instead, a camli JSON object is known as such if the bytes of the file Instead, a camli JSON object is known as such if the bytes of the file
begin exactly with the bytes: begin exactly with the bytes:
{"camliVerison" {"camliVersion"
... which lets upper layers know what it is, and how to index it. ... which lets upper layers know what it is, and how to index it.
@ -95,7 +95,7 @@ Schema of files/objects in Layer 1:
-- signed statements/claims on other objects -- signed statements/claims on other objects
(think decentralized commenting/starring on the web, (think decentralized commenting/starring on the web,
verifying claims with webfinger lookups to find verifying claims with webfinger lookups to find
public keys to veirfy signatures) public keys to verify signatures)
-- references to encrypted/split files -- references to encrypted/split files
-- etc... (extensible over time) -- etc... (extensible over time)

2
doc/spec.txt
View File

@ -5,7 +5,7 @@ Camli Blob Magic
[Note: not totally happy with this yet...] [Note: not totally happy with this yet...]
Ideal Camli JSON blobs should begin with the following 15 bytes: Ideal Camli JSON blobs should begin with the following 15 bytes:
{"camliVerison" {"camliVersion"
However, it's acknowledged that some JSON serialization libraries will However, it's acknowledged that some JSON serialization libraries will
format things differently, so additional whitespace should be format things differently, so additional whitespace should be

5
doc/terminology.txt
View File

@ -18,7 +18,7 @@ Object / Camli Object: a data structure consisting of keys/values
or arrays of values. In Camli, these are serialized as JSON or arrays of values. In Camli, these are serialized as JSON
everywhere. everywhere.
Object Blob / Camli Blob: the JSON serialation of a Camli Object. Object Blob / Camli Blob: the JSON serialization of a Camli Object.
This is just a normal JSON serialization (with any JSON This is just a normal JSON serialization (with any JSON
serialization library that's available), with the extra requirement serialization library that's available), with the extra requirement
that the serialization must start with the 16 bytes: that the serialization must start with the 16 bytes:
@ -30,7 +30,8 @@ Object Blob / Camli Blob: the JSON serialation of a Camli Object.
JSON serialization libraries [sanely] won't let you specify the JSON serialization libraries [sanely] won't let you specify the
order of keys in a dictionary, the camli serialization libraries order of keys in a dictionary, the camli serialization libraries
will wrap the JSON serialization libraries and replace the leading will wrap the JSON serialization libraries and replace the leading
'{' character with the above magic number. '{' character with the above magic number (plus a version number
and comma).
Object Origin: for objects intended to be mutated over time Object Origin: for objects intended to be mutated over time
(e.g. annotating and renaming a photo, commenting on an item, (e.g. annotating and renaming a photo, commenting on an item,