diff options
author | Chuck Lever <chuck.lever@oracle.com> | 2010-06-22 12:51:42 -0400 |
---|---|---|
committer | Steve Dickson <steved@redhat.com> | 2010-06-22 16:04:53 -0400 |
commit | 22d6566d473f71e241c791a02435d414648c99e8 (patch) | |
tree | 80e0433dd106d63fe883fa1ffaced6b45060df3d /support/export/export.c | |
parent | 53928c0166dcc0acceaa995edb8551b48968b5dd (diff) | |
download | nfs-utils-22d6566d473f71e241c791a02435d414648c99e8.tar.gz nfs-utils-22d6566d473f71e241c791a02435d414648c99e8.tar.xz nfs-utils-22d6566d473f71e241c791a02435d414648c99e8.zip |
libexport.a: Add documenting comments
Clean up. Add a few additional documenting comments for globally
visible functions.
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
Signed-off-by: Steve Dickson <steved@redhat.com>
Diffstat (limited to 'support/export/export.c')
-rw-r--r-- | support/export/export.c | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/support/export/export.c b/support/export/export.c index eca833c..f528603 100644 --- a/support/export/export.c +++ b/support/export/export.c @@ -81,8 +81,13 @@ export_read(char *fname) endexportent(); } -/* - * Create an in-core export struct from an export entry. +/** + * export_create - create an in-core nfs_export record from an export entry + * @xep: export entry to lookup + * @canonical: if set, e_hostname is known to be canonical DNS name + * + * Returns a freshly instantiated export record, or NULL if + * a problem occurred. */ nfs_export * export_create(struct exportent *xep, int canonical) @@ -260,11 +265,17 @@ export_allowed(const struct addrinfo *ai, const char *path) return NULL; } -/* - * Search hash table for export entry. - */ +/** + * export_lookup - search hash table for export entry + * @hname: '\0'-terminated ASCII string containing client hostname to look for + * @path: '\0'-terminated ASCII string containing export path to look for + * @canonical: if set, @hname is known to be canonical DNS name + * + * Returns a pointer to nfs_export record matching @hname and @path, + * or NULL if the export was not found. + */ nfs_export * -export_lookup(char *hname, char *path, int canonical) +export_lookup(char *hname, char *path, int canonical) { nfs_client *clp; nfs_export *exp; |