summaryrefslogtreecommitdiff
path: root/registry
diff options
context:
space:
mode:
authorMichael Meeks <michael.meeks@suse.com>2012-03-06 16:28:44 +0000
committerMichael Meeks <michael.meeks@suse.com>2012-03-06 16:29:23 +0000
commit4f688fd794a7e04a294f0b215889ce076c91823f (patch)
treeeefb5686bd33b30252467027ac0b857093273d89 /registry
parent9b7e871fa8839e698953ec27c1f9d5f24791a1b5 (diff)
more documentation and cleanups for various modules.
Diffstat (limited to 'registry')
-rw-r--r--registry/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/registry/README b/registry/README
index b455809406a7..914db30a2f01 100644
--- a/registry/README
+++ b/registry/README
@@ -1 +1,15 @@
Registry reading, etc.
+
+This provides tools for dealing with the legacy binary types database
+format, still in use by extensions and the core code. While the actual
+binary file format is implemented by the [[store]] code, the wrapper
+that turns this into a type registry is implemented here.
+
+While this code is primarily used in only two modes:
+
+* linear write / concatenate
+* random access read
+
+The API unfortunately exposes a random-access write approach, which -
+while ~unused needs before we can re-write this away from the store
+backend.