libmount: clean up docs

Signed-off-by: Karel Zak <kzak@redhat.com>

diff --git a/libmount/docs/libmount-sections.txt b/libmount/docs/libmount-sections.txt
index e58dbcdfc98ce2cf2211cd967e7ebc39b6b62358..99b81c2abfa0eaaa198edf08b03f9fce7c445466 100644 (file)
--- a/libmount/docs/libmount-sections.txt
+++ b/libmount/docs/libmount-sections.txt
@@ -1,5 +1,6 @@
 <SECTION>
 <FILE>cache</FILE>
+libmnt_cache
 mnt_new_cache
 mnt_free_cache
 mnt_cache_device_has_tag
@@ -14,6 +15,7 @@ mnt_resolve_tag
 
 <SECTION>
 <FILE>context</FILE>
+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
+<SUBSECTION>
+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
+<SUBSECTION>
+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
 </SECTION>
 
 <SECTION>
@@ -90,6 +134,7 @@ mnt_context_umount
 
 <SECTION>
 <FILE>fs</FILE>
+libmnt_fs
 mnt_copy_fs
 mnt_free_fs
 mnt_free_mntent
@@ -146,6 +191,7 @@ mnt_init_debug
 
 <SECTION>
 <FILE>iter</FILE>
+libmnt_iter
 mnt_free_iter
 mnt_iter_get_direction
 mnt_new_iter
@@ -154,6 +200,7 @@ mnt_reset_iter
 
 <SECTION>
 <FILE>lock</FILE>
+libmnt_lock
 mnt_free_lock
 mnt_lock_file
 mnt_new_lock
@@ -164,6 +211,9 @@ mnt_lock_block_signals
 <SECTION>
 <FILE>optmap</FILE>
 mnt_get_builtin_optmap
+MNT_INVERT
+MNT_NOMTAB
+MNT_PREFIX
 </SECTION>
 
 <SECTION>
@@ -182,6 +232,7 @@ mnt_split_optstr
 
 <SECTION>
 <FILE>table</FILE>
+libmnt_table
 mnt_free_table
 mnt_new_table
 mnt_reset_table
@@ -213,6 +264,7 @@ mnt_table_set_parser_errcb
 
 <SECTION>
 <FILE>tabdiff</FILE>
+libmnt_tabdiff
 mnt_new_tabdiff
 mnt_free_tabdiff
 mnt_tabdiff_next_change
@@ -221,6 +273,7 @@ mnt_diff_tables
 
 <SECTION>
 <FILE>update</FILE>
+libmnt_update
 mnt_free_update
 mnt_new_update
 mnt_update_force_rdonly
@@ -251,16 +304,5 @@ mnt_unmangle
 <FILE>version</FILE>
 mnt_parse_version_string
 mnt_get_library_version
+LIBMOUNT_VERSION
 </SECTION>
-
-
-
-
-
-
-
-
-
-
-
-

diff --git a/libmount/src/context.c b/libmount/src/context.c
index 422469bf8820b67c397c170662b54d77c2e361db..b3be915c7567822ddd3c923f51b4d0cd257322a0 100644 (file)
--- 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 f9642e5a71e84ba332afc8788ed8361e1af6b2d9..ae66a441bdadf871ebf6a9b52bf4da2f7a37f7e3 100644 (file)
--- 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 160c7049d8a418dfdf1f72b97fdb4b213e183a38..cf3db2ffb36226dcdd5200ce8522faf61b944e1e 100644 (file)
--- 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 216d9ac1ef1bb312446437f6dbabea999cf6c17a..c9d925ca50567b7371651a7e7ab94bf3e198ad65 100644 (file)
--- 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.