summaryrefslogtreecommitdiffstats
path: root/shlibs/mount/src/tab_update.c
diff options
context:
space:
mode:
authorKarel Zak2011-01-04 00:43:56 +0100
committerKarel Zak2011-01-04 00:43:56 +0100
commit0f32f1e2fca10124952ca8d83d08f56f79b669c0 (patch)
tree14f98dfd57bd6c239c3835ab3a98f0602280f4b9 /shlibs/mount/src/tab_update.c
parentmount: use verbose info for HAVE_LIBMOUNT_MOUNT only (diff)
downloadkernel-qcow2-util-linux-0f32f1e2fca10124952ca8d83d08f56f79b669c0.tar.gz
kernel-qcow2-util-linux-0f32f1e2fca10124952ca8d83d08f56f79b669c0.tar.xz
kernel-qcow2-util-linux-0f32f1e2fca10124952ca8d83d08f56f79b669c0.zip
libmount: cleanup API and docs
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'shlibs/mount/src/tab_update.c')
-rw-r--r--shlibs/mount/src/tab_update.c12
1 files changed, 10 insertions, 2 deletions
diff --git a/shlibs/mount/src/tab_update.c b/shlibs/mount/src/tab_update.c
index 9638f47c9..cf32baf15 100644
--- a/shlibs/mount/src/tab_update.c
+++ b/shlibs/mount/src/tab_update.c
@@ -7,8 +7,15 @@
/**
* SECTION: update
- * @title: mtab (fstab) managment
- * @short_description: userspace mount information management
+ * @title: mtab managment
+ * @short_description: userspace mount information management.
+ *
+ * The mnt_update provides abstraction to manage mount options in userspace independently on
+ * system configuration. This low-level API works on system with and without /etc/mtab. On
+ * systems without the regular /etc/mtab file are userspace mount options (e.g. user=)
+ * stored to the /dev/.mount/utab file.
+ *
+ * It's recommended to use high-level mnt_context API.
*/
#include <stdio.h>
@@ -770,6 +777,7 @@ static int update_modify_options(mnt_update *upd, mnt_lock *lc)
/**
* mnt_update_tab:
+ * @upd: update
* @lc: lock
*
* High-level API to update /etc/mtab (or private /dev/.mount/utab file).