From: Chuck Lever <chuck.lever@oracle.com>
Date: Fri, 24 Aug 2007 17:11:53 +0000 (-0400)
Subject: mount.nfs: Add a block comment before mount_error() and umount_error()
X-Git-Tag: nfs-utils-1-1-1~59
X-Git-Url: https://git.decadent.org.uk/gitweb/?a=commitdiff_plain;h=2fa7d272bdbfe3a73d813b843e5d66b1c044459e;p=nfs-utils.git

mount.nfs: Add a block comment before mount_error() and umount_error()

Add block comments before mount_error() and umount_error() to help
distinguish them from the other error reporting functions.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
Signed-off-by: Neil Brown <neilb@suse.de>
---

diff --git a/utils/mount/error.c b/utils/mount/error.c
index cab84c9..1f60b79 100644
--- a/utils/mount/error.c
+++ b/utils/mount/error.c
@@ -121,6 +121,13 @@ void mount_errors(char *server, int will_retry, int bg)
 		fprintf(stderr, "%s\n", errbuf);
 }
 
+/*
+ * mount_error - report a foreground mount error
+ * @spec: C string containing the device name being mounted
+ * @mount_point: C string containing the pathname of the local mounted on dir
+ * @error: errno value to report
+ *
+ */
 void mount_error(const char *spec, const char *mount_point, int error)
 {
 	switch(error) {
@@ -148,7 +155,10 @@ void mount_error(const char *spec, const char *mount_point, int error)
 }
 
 /*
- * Report a failed umount
+ * umount_error - report a failed umount request
+ * @err: errno value to report
+ * @dev: C string containing the pathname of the local mounted on dir
+ *
  */
 void umount_error(int err, const char *dev)
 {