packaging
/
ostree
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

core: Add a comment header about the format 

This should probably be a design document or something, but this is
useful for now.
This commit is contained in:
Colin Walters 2013-08-14 17:27:30 +02:00
parent 1904e3e0f4
commit 61773f6ca4
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/libostree/ostree-core.h
View File

@ -26,6 +26,23 @@
G_BEGIN_DECLS
/**
* These functions implement repository-independent algorithms for
* operating on the core OSTree data formats, such as converting
* #GFileInfo into a #GVariant.
*
* There are 4 types of objects; file, dirmeta, tree, and commit. The
* last 3 are metadata, and the file object is the only content object
* type.
*
* All metadata objects are stored as #GVariant (big endian). The
* rationale for this is the same as that of the ext{2,3,4} family of
* filesystems; most developers will be using LE, and so it's better
* to continually test the BE->LE swap.
*
* The file object is a custom format in order to support streaming.
*/
#define OSTREE_MAX_METADATA_SIZE (1 << 26)
#define OSTREE_MAX_RECURSION (256)