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

fix indent for index doc block 

also consistent notation for k -> v mapping within the block

Change-Id: I0e18890ec8871057d303d23581ca7e93ff227ef8
This commit is contained in:
Eric Drechsel 2014-06-09 11:08:35 -07:00
parent a58a090a3f
commit 8f835e102c
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
pkg/index/doc.go
View File

@ -20,28 +20,27 @@ Package index provides a generic indexing system on top of the abstract Storage
The following keys & values are populated by receiving blobs and queried
for search operations:
* Recent Permanodes
"recpn|<pgp-keyid>|<reverse-modtime>|<claim-blobref>" == "<permanode-blobref>"
where reverse-modtime flips each digit to '9'-<digit> and prepends "rt" (for reverse time)
"2011-11-27T01:23:45Z"
==> "rt7988-88-72T98:76:54Z"
* Recent Permanodes
"recpn|<pgp-keyid>|<reverse-modtime>|<claim-blobref>" -> "<permanode-blobref>"
where reverse-modtime flips each digit to '9'-<digit> and prepends "rt" (for reverse time)
"2011-11-27T01:23:45Z" = "rt7988-88-72T98:76:54Z"
* signer blobref of ascii public key -> gpg key id
"signerkeyid:sha1-ad87ca5c78bd0ce1195c46f7c98e6025abbaf007" = "2931A67C26F5ABDA"
* PermanodeOfSignerAttrValue:
"signerattrvalue|<keyid>|<URLEscape(attr)>|<URLEscape(value)>|<reverse-claimtime>|<claim-blobref>" == "<permanode>"
"signerattrvalue|<keyid>|<URLEscape(attr)>|<URLEscape(value)>|<reverse-claimtime>|<claim-blobref>" -> "<permanode>"
e.g.
"signerattrvalue|2931A67C26F5ABDA|camliRoot|rootval|"+
"rt7988-88-71T98:67:60.999876543Z|sha1-bf115940641f1aae2e007edcf36b3b18c17256d9" =>
"rt7988-88-71T98:67:60.999876543Z|sha1-bf115940641f1aae2e007edcf36b3b18c17256d9" =
"sha1-7a14cce982aa73ab519e63050f82e2a2adfcf039"
* Other:
"meta:<blobref>" == "<size>|<mimetype>"
"have:<blobref>" == "<size>" (used for enumeration, which doesn't need mime type)
"meta:<blobref>" -> "<size>|<mimetype>"
"have:<blobref>" -> "<size>" (used for enumeration, which doesn't need mime type)
* For GetOwnerClaims(permanode, signer):
"claim|<permanode-blobref>|<keyid>|<date>|<claim-blobref>" => "<URL:type>|<URL:attr>|<URL:value>"
"claim|<permanode-blobref>|<keyid>|<date>|<claim-blobref>" -> "<URL:type>|<URL:attr>|<URL:value>"
*/
package index