summaryrefslogtreecommitdiffstats
path: root/shlibs/mount/src/optmap.c
diff options
context:
space:
mode:
authorKarel Zak2010-04-14 14:01:24 +0200
committerKarel Zak2010-06-03 15:20:12 +0200
commit192c6aad9c8e6ae5c4a480f41b9359180a468150 (patch)
tree92b53b67b4f94089b2e2e80c912ad7e9d5a1d722 /shlibs/mount/src/optmap.c
parentfindmnt: add man page (diff)
downloadkernel-qcow2-util-linux-192c6aad9c8e6ae5c4a480f41b9359180a468150.tar.gz
kernel-qcow2-util-linux-192c6aad9c8e6ae5c4a480f41b9359180a468150.tar.xz
kernel-qcow2-util-linux-192c6aad9c8e6ae5c4a480f41b9359180a468150.zip
libmount: cleanup docs
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'shlibs/mount/src/optmap.c')
-rw-r--r--shlibs/mount/src/optmap.c12
1 files changed, 9 insertions, 3 deletions
diff --git a/shlibs/mount/src/optmap.c b/shlibs/mount/src/optmap.c
index 873c545ce..ff8cc8c68 100644
--- a/shlibs/mount/src/optmap.c
+++ b/shlibs/mount/src/optmap.c
@@ -3,9 +3,13 @@
*
* This file may be redistributed under the terms of the
* GNU Lesser General Public License.
+ */
+
+/**
+ * SECTION: optmap
+ * @title: Option maps
+ * @short_description: description for mount options
*
- * Option-maps
- * -----------
* The mount(2) linux syscall uses two arguments for mount options:
*
* 1) mountflags (see MS_* macros in linux/fs.h)
@@ -45,6 +49,8 @@
* - MNT_LINUX_MAP -- fs-independent kernel mount options (usually MS_* flags)
* - MNT_USERSPACE_MAP -- userspace specific mount options (e.g. "user", "loop")
*
+ * For more details about option map struct see "struct mnt_optmap" in
+ * mount/mount.h.
*/
#include <string.h>
#include <stdlib.h>
@@ -153,7 +159,7 @@ static const struct mnt_optmap userspace_opts_map[] =
* MNT_USERSPACE_MAP - userpace mount(8) specific mount options
* (e.g user=, _netdev, ...)
*
- * Returns internal (static) libmount map.
+ * Returns: static built-in libmount map.
*/
const struct mnt_optmap *mnt_get_builtin_optmap(int id)
{