From 0c91c44c44415ee1484ee9a189ca5428891eaa4d Mon Sep 17 00:00:00 2001 From: Alberto Bertogli Date: Thu, 23 Apr 2009 19:51:38 -0300 Subject: [PATCH 36/38] [ABI BREAK] Make the public flags more tidy This patch splits the flags in two sets (jopen() flags and jfsck() flags), making them more tidy, while also improving the documentation. Signed-off-by: Alberto Bertogli --- libjio/libjio.h | 65 ++++++++++++++++++++++++++++++++++++++++++------------ 1 files changed, 50 insertions(+), 15 deletions(-) diff --git a/libjio/libjio.h b/libjio/libjio.h index 166fb3b..4421d25 100644 --- a/libjio/libjio.h +++ b/libjio/libjio.h @@ -400,34 +400,69 @@ void jrewind(jfs_t *stream); FILE *jfsopen(jfs_t *stream, const char *mode); - /* - * Miscelaneous flags + * jopen() flags. + * + * Internally used also for jtrans_t flags. */ -/** Don't lock the file before operating on it */ +/** Don't lock the file before operating on it. + * + * @see jopen() + * @ingroup basic */ #define J_NOLOCK 1 -/** No need to read rollback information */ +/** No need to read rollback information. + * + * @see jopen() + * @ingroup basic */ #define J_NOROLLBACK 2 -/** Use lingering transactions */ +/** Use lingering transactions. + * + * @see jopen() + * @ingroup basic */ #define J_LINGER 4 -/** Marks a transaction as committed */ -#define J_COMMITTED 8 +/* Range 8-256 is reserved for future public use */ -/** Marks a transaction as rollbacked */ -#define J_ROLLBACKED 16 +/** Marks a file as read-only. + * + * For internal use only, automatically set when O_RDONLY is passed to + * jopen(). + * + * @internal */ +#define J_RDONLY 512 -/** Marks a transaction as rollbacking */ -#define J_ROLLBACKING 32 -/** Marks a file as read-only */ -#define J_RDONLY 64 +/* + * jtrans_t flags. + * + * For internal use only, but must be in the same space as the jopen() flags. + */ -/** Do not perform a journal cleanup. Used in jfsck(). */ -#define J_NOCLEANUP 128 +/** Marks a transaction as committed. + * @internal */ +#define J_COMMITTED 1024 + +/** Marks a transaction as rollbacked. + * @internal */ +#define J_ROLLBACKED 2048 + +/** Marks a transaction as rollbacking. + * @internal */ +#define J_ROLLBACKING 4096 + + +/* + * jfsck() flags + */ + +/** Do not perform a journal cleanup. Used in jfsck(). + * + * @see jfsck() + * @ingroup check */ +#define J_NOCLEANUP 1 #endif -- 1.6.2.2.646.gb214