From: Ronnie Sahlberg <ronniesahlberg@gmail.com>
Date: Sat, 2 Jul 2011 00:33:19 +0000 (+1000)
Subject: document the find_all_servers function
X-Git-Tag: upstream/1.9.6^2~361
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=9c4212bf552b9bee2e85b3890abe4e69465ef20a;p=deb_libnfs.git

document the find_all_servers function
---

diff --git a/include/libnfs.h b/include/libnfs.h
index 81febb2..0676efa 100644
--- a/include/libnfs.h
+++ b/include/libnfs.h
@@ -955,10 +955,24 @@ off_t nfs_get_current_offset(struct nfsfh *nfsfh);
 
 
 
+
+
 struct nfs_server_list {
        struct nfs_server_list *next;
        char *addr;
 };
 
+/*
+ * Sync find_local_servers(<server>)
+ * This function will probe all local networks for NFS server. This function will
+ * block for one second while awaiting for all nfs servers to respond.
+ *
+ * Function returns
+ * NULL : something failed
+ *
+ * struct nfs_server_list : a linked list of all discovered servers
+ * 
+ * returned data must be freed by nfs_free_srvr_list(srv);
+ */
 struct nfs_server_list *nfs_find_local_servers(void);
 void free_nfs_srvr_list(struct nfs_server_list *srv);