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

core: Improve variant format docs 

Use markdown to actually format the tuple member descriptions as a
list. Currently they are hardly legible as gtk-doc formats them into a
single sentence.

Also update the additional metadata docs in the summary objects.

Closes: #289
Approved by: cgwalters
This commit is contained in:
Krzesimir Nowak 2016-05-10 11:59:12 +02:00 committed by Colin Walters (automation)
parent 65e7969b0b
commit 3ae87e3f9e
1 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -90,10 +90,10 @@ typedef enum {
/** /**
* OSTREE_DIRMETA_GVARIANT_FORMAT: * OSTREE_DIRMETA_GVARIANT_FORMAT:
* *
* u - uid * - u - uid
* u - gid * - u - gid
* u - mode * - u - mode
* a(ayay) - xattrs * - a(ayay) - xattrs
*/ */
#define OSTREE_DIRMETA_GVARIANT_STRING "(uuua(ayay))" #define OSTREE_DIRMETA_GVARIANT_STRING "(uuua(ayay))"
#define OSTREE_DIRMETA_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_DIRMETA_GVARIANT_STRING) #define OSTREE_DIRMETA_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_DIRMETA_GVARIANT_STRING)
@ -106,10 +106,10 @@ typedef enum {
* can't store in the real filesystem but we can still use a regular .file object * can't store in the real filesystem but we can still use a regular .file object
* that we can hardlink to in the case of a user-mode checkout. * that we can hardlink to in the case of a user-mode checkout.
* *
* u - uid * - u - uid
* u - gid * - u - gid
* u - mode * - u - mode
* a(ayay) - xattrs * - a(ayay) - xattrs
*/ */
#define OSTREE_FILEMETA_GVARIANT_STRING "(uuua(ayay))" #define OSTREE_FILEMETA_GVARIANT_STRING "(uuua(ayay))"
#define OSTREE_FILEMETA_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_FILEMETA_GVARIANT_STRING) #define OSTREE_FILEMETA_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_FILEMETA_GVARIANT_STRING)
@ -117,8 +117,8 @@ typedef enum {
/** /**
* OSTREE_TREE_GVARIANT_FORMAT: * OSTREE_TREE_GVARIANT_FORMAT:
* *
* a(say) - array of (filename, checksum) for files * - a(say) - array of (filename, checksum) for files
* a(sayay) - array of (dirname, tree_checksum, meta_checksum) for directories * - a(sayay) - array of (dirname, tree_checksum, meta_checksum) for directories
*/ */
#define OSTREE_TREE_GVARIANT_STRING "(a(say)a(sayay))" #define OSTREE_TREE_GVARIANT_STRING "(a(say)a(sayay))"
#define OSTREE_TREE_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_TREE_GVARIANT_STRING) #define OSTREE_TREE_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_TREE_GVARIANT_STRING)
@ -126,14 +126,14 @@ typedef enum {
/** /**
* OSTREE_COMMIT_GVARIANT_FORMAT: * OSTREE_COMMIT_GVARIANT_FORMAT:
* *
* a{sv} - Metadata * - a{sv} - Metadata
* ay - parent checksum (empty string for initial) * - ay - parent checksum (empty string for initial)
* a(say) - Related objects * - a(say) - Related objects
* s - subject * - s - subject
* s - body * - s - body
* t - Timestamp in seconds since the epoch (UTC) * - t - Timestamp in seconds since the epoch (UTC)
* ay - Root tree contents * - ay - Root tree contents
* ay - Root tree metadata * - ay - Root tree metadata
*/ */
#define OSTREE_COMMIT_GVARIANT_STRING "(a{sv}aya(say)sstayay)" #define OSTREE_COMMIT_GVARIANT_STRING "(a{sv}aya(say)sstayay)"
#define OSTREE_COMMIT_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_COMMIT_GVARIANT_STRING) #define OSTREE_COMMIT_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_COMMIT_GVARIANT_STRING)
@ -141,8 +141,9 @@ typedef enum {
/** /**
* OSTREE_SUMMARY_GVARIANT_FORMAT: * OSTREE_SUMMARY_GVARIANT_FORMAT:
* *
* refs: a(s(taya{sv})) - Map of ref name -> (latest commit size, latest commit checksum, additional metadata), sorted by ref name * - a(s(taya{sv})) - Map of ref name -> (latest commit size, latest commit checksum, additional metadata), sorted by ref name
* extensions: a{sv} - Additional metadata, none defined at the current time * - a{sv} - Additional metadata, at the current time the following are defined:
* - key: "ostree.static-deltas", value: a{sv}, static delta name -> 32 bytes of checksum
*/ */
#define OSTREE_SUMMARY_GVARIANT_STRING "(a(s(taya{sv}))a{sv})" #define OSTREE_SUMMARY_GVARIANT_STRING "(a(s(taya{sv}))a{sv})"
#define OSTREE_SUMMARY_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_SUMMARY_GVARIANT_STRING) #define OSTREE_SUMMARY_GVARIANT_FORMAT G_VARIANT_TYPE (OSTREE_SUMMARY_GVARIANT_STRING)