From 22d6566d473f71e241c791a02435d414648c99e8 Mon Sep 17 00:00:00 2001 From: Chuck Lever Date: Tue, 22 Jun 2010 12:51:42 -0400 Subject: libexport.a: Add documenting comments Clean up. Add a few additional documenting comments for globally visible functions. Signed-off-by: Chuck Lever Signed-off-by: Steve Dickson --- support/export/export.c | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) (limited to 'support/export/export.c') 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; -- cgit