From e6ecd606ae2b3665b7f5a99e612a74979d8e8457 Mon Sep 17 00:00:00 2001 From: Karel Zak Date: Mon, 25 Jul 2011 10:42:08 +0200 Subject: [PATCH] libmount: clean up docs Signed-off-by: Karel Zak --- libmount/docs/libmount-sections.txt | 66 +++++++++++++++++++++++------ libmount/src/context.c | 9 ++-- libmount/src/context_mount.c | 2 +- libmount/src/libmount.h.in | 9 +++- libmount/src/optstr.c | 4 +- 5 files changed, 70 insertions(+), 20 deletions(-) diff --git a/libmount/docs/libmount-sections.txt b/libmount/docs/libmount-sections.txt index e58dbcdfc9..99b81c2abf 100644 --- a/libmount/docs/libmount-sections.txt +++ b/libmount/docs/libmount-sections.txt @@ -1,5 +1,6 @@
cache +libmnt_cache mnt_new_cache mnt_free_cache mnt_cache_device_has_tag @@ -14,6 +15,7 @@ mnt_resolve_tag
context +libmnt_context mnt_free_context mnt_new_context mnt_reset_context @@ -78,6 +80,48 @@ mnt_context_finalize_mount mnt_context_mount mnt_context_next_mount mnt_context_prepare_mount + +MNT_MS_COMMENT +MNT_MS_GROUP +MNT_MS_HELPER +MNT_MS_LOOP +MNT_MS_NETDEV +MNT_MS_NOAUTO +MNT_MS_NOFAIL +MNT_MS_OFFSET +MNT_MS_OWNER +MNT_MS_SIZELIMIT +MNT_MS_UHELPER +MNT_MS_USER +MNT_MS_USERS +MNT_MS_XCOMMENT + +MS_BIND +MS_DIRSYNC +MS_I_VERSION +MS_MANDLOCK +MS_MGC_MSK +MS_MGC_VAL +MS_MOVE +MS_NOATIME +MS_NODEV +MS_NODIRATIME +MS_NOEXEC +MS_NOSUID +MS_OWNERSECURE +MS_PRIVATE +MS_PROPAGATION +MS_RDONLY +MS_REC +MS_RELATIME +MS_REMOUNT +MS_SECURE +MS_SHARED +MS_SILENT +MS_SLAVE +MS_STRICTATIME +MS_SYNCHRONOUS +MS_UNBINDABLE
@@ -90,6 +134,7 @@ mnt_context_umount
fs +libmnt_fs mnt_copy_fs mnt_free_fs mnt_free_mntent @@ -146,6 +191,7 @@ mnt_init_debug
iter +libmnt_iter mnt_free_iter mnt_iter_get_direction mnt_new_iter @@ -154,6 +200,7 @@ mnt_reset_iter
lock +libmnt_lock mnt_free_lock mnt_lock_file mnt_new_lock @@ -164,6 +211,9 @@ mnt_lock_block_signals
optmap mnt_get_builtin_optmap +MNT_INVERT +MNT_NOMTAB +MNT_PREFIX
@@ -182,6 +232,7 @@ mnt_split_optstr
table +libmnt_table mnt_free_table mnt_new_table mnt_reset_table @@ -213,6 +264,7 @@ mnt_table_set_parser_errcb
tabdiff +libmnt_tabdiff mnt_new_tabdiff mnt_free_tabdiff mnt_tabdiff_next_change @@ -221,6 +273,7 @@ mnt_diff_tables
update +libmnt_update mnt_free_update mnt_new_update mnt_update_force_rdonly @@ -251,16 +304,5 @@ mnt_unmangle version mnt_parse_version_string mnt_get_library_version +LIBMOUNT_VERSION
- - - - - - - - - - - - diff --git a/libmount/src/context.c b/libmount/src/context.c index 422469bf88..b3be915c75 100644 --- a/libmount/src/context.c +++ b/libmount/src/context.c @@ -765,7 +765,7 @@ int mnt_context_get_mtab(struct libmnt_context *cxt, struct libmnt_table **tb) /** * mnt_context_get_table: * @cxt: mount context - * @file: filename (e.g. /proc/self/mountinfo, ...) + * @filename: e.g. /proc/self/mountinfo * @tb: returns the table * * This function allocates a new table and parses the @file. The parser error @@ -1629,12 +1629,12 @@ int mnt_context_init_helper(struct libmnt_context *cxt, int action, int flags) /** * mnt_context_helper_setopt: - * @cxr: context + * @cxt: context * @c: getopt() result * @arg: getopt() optarg * * This function applies [u]mount.type command line option (for example parsed - * by getopt() or getopt_long()) to @cxt. All unknown options are ignored and + * by getopt or getopt_long) to @cxt. All unknown options are ignored and * then 1 is returned. * * Returns: negative number on error, 1 if @c is unknown option, 0 on success. @@ -1653,8 +1653,9 @@ int mnt_context_helper_setopt(struct libmnt_context *cxt, int c, char *arg) } /** + * mnt_context_is_fs_mounted: * @cxt: context - * @fs; filesystem + * @fs: filesystem * @mounted: returns 1 for mounted and 0 for non-mounted filesystems * * Returns: 0 on success and negative number in case of error. diff --git a/libmount/src/context_mount.c b/libmount/src/context_mount.c index f9642e5a71..ae66a441bd 100644 --- a/libmount/src/context_mount.c +++ b/libmount/src/context_mount.c @@ -652,7 +652,7 @@ int mnt_context_mount(struct libmnt_context *cxt) * @cxt: context * @itr: iterator * @fs: returns the current filesystem - * @mntrc: returns the return code from mnt_mount_context() + * @mntrc: returns the return code from mnt_context_mount() * @ignored: returns 1 for not matching and 2 for already mounted filesystems * * This function tries to mount the next filesystem from fstab (as returned by diff --git a/libmount/src/libmount.h.in b/libmount/src/libmount.h.in index 160c7049d8..cf3db2ffb3 100644 --- a/libmount/src/libmount.h.in +++ b/libmount/src/libmount.h.in @@ -103,6 +103,13 @@ struct libmnt_update; */ struct libmnt_context; +/** + * libmnt_tabdiff: + * + * Stores mountinfo state + */ +struct libmnt_tabdiff; + /* * Actions */ @@ -317,7 +324,7 @@ extern int mnt_table_is_fs_mounted(struct libmnt_table *tb, struct libmnt_fs *fs extern struct libmnt_update *mnt_new_update(void); extern void mnt_free_update(struct libmnt_update *upd); extern int mnt_update_is_ready(struct libmnt_update *upd); -extern int mnt_update_set_fs(struct libmnt_update *upd, unsigned long mflags, +extern int mnt_update_set_fs(struct libmnt_update *upd, unsigned long mountflags, const char *target, struct libmnt_fs *fs); extern int mnt_update_table(struct libmnt_update *upd, struct libmnt_lock *lc); extern unsigned long mnt_update_get_mflags(struct libmnt_update *upd); diff --git a/libmount/src/optstr.c b/libmount/src/optstr.c index 216d9ac1ef..c9d925ca50 100644 --- a/libmount/src/optstr.c +++ b/libmount/src/optstr.c @@ -518,11 +518,11 @@ int mnt_split_optstr(const char *optstr, char **user, char **vfs, * * Extracts options from @optstr that belongs to the @map, for example: * - * mnt_split_optstr_by_map(optstr, &p, + * mnt_optstr_get_options(optstr, &p, * mnt_get_builtin_optmap(MNT_LINUX_MAP), * MNT_NOMTAB); * - * returns all VFS options, the options that does not belong to mtab + * the 'p' returns all VFS options, the options that does not belong to mtab * are ignored. * * Returns: 0 on success, or negative number in case of error. -- 2.47.3