From: Rafał Miłecki <rafal@milecki.pl>
Date: Mon, 27 Mar 2017 11:17:40 +0000 (+0200)
Subject: libfstools: add basic documentation of mount functions
X-Git-Url: http://git.archive.openwrt.org/?p=project%2Ffstools.git;a=commitdiff_plain;h=92b4c2cbe1682c77826c4d7392e2e52cab3d2a28

libfstools: add basic documentation of mount functions

Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
Acked-by: John Crispin <john@phrozen.org>
---

diff --git a/libfstools/mount.c b/libfstools/mount.c
index 371082b..551f4e7 100644
--- a/libfstools/mount.c
+++ b/libfstools/mount.c
@@ -25,6 +25,12 @@
 /* this is a raw syscall - man 2 pivot_root */
 extern int pivot_root(const char *new_root, const char *put_old);
 
+/**
+ * mount_move - move mounted point to the new location
+ *
+ * @oldroot: directory that is current location of mount point
+ * @newroot: new directory for the mount point
+ */
 int
 mount_move(char *oldroot, char *newroot, char *dir)
 {
@@ -79,6 +85,12 @@ pivot(char *new, char *old)
 	return 0;
 }
 
+/**
+ * fopivot - switch to overlay using passed dir as upper one
+ *
+ * @rw_root: writable directory that will be used as upper dir
+ * @ro_root: directory where old root will be put
+ */
 int
 fopivot(char *rw_root, char *ro_root)
 {
@@ -134,6 +146,9 @@ fopivot(char *rw_root, char *ro_root)
 	return pivot("/mnt", ro_root);
 }
 
+/**
+ * ramoverlay - use RAM to store filesystem changes on top of RO root
+ */
 int
 ramoverlay(void)
 {