From 1ca33ae86f8cc4d66829630c63b97cb8c603c52e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dag-Erling=20Sm=C3=B8rgrav?= Date: Sat, 14 Apr 2012 15:00:10 +0000 Subject: [PATCH] Add proper documentation. git-svn-id: svn+ssh://svn.openpam.org/svn/openpam/trunk@597 185d5e19-27fe-0310-9dcf-9bff6b9f3609 --- lib/openpam_get_feature.c | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/lib/openpam_get_feature.c b/lib/openpam_get_feature.c index ba00354..913c3b1 100644 --- a/lib/openpam_get_feature.c +++ b/lib/openpam_get_feature.c @@ -64,7 +64,7 @@ openpam_get_feature(int feature, int *onoff) /** * EXPERIMENTAL - * + * The =openpam_get_feature function stores the current state of the * specified feature in the variable pointed to by its =onoff argument. * @@ -72,23 +72,24 @@ openpam_get_feature(int feature, int *onoff) * * =OPENPAM_FEATURE_RESTRICT_SERVICE_NAME: * Disallow path separators in service names. - * Disabling this feature allows the application - Restrict service names to sequences of characters from the - * POSIX portable filename character set, not including the - * path separator. - - * If this feature is disabled, the application can specifyservice name parameter - * can be used to specify a policy file directly. - * This feature is enabled by default. + * Disabling it allows the application to specify the path to + * the desired policy file directly. * * =OPENPAM_FEATURE_CHECK_POLICY_FILE: + * Verify the ownership and permissions of the policy file + * and the path leading up to it. * This feature is enabled by default. * * =OPENPAM_FEATURE_RESTRICT_MODULE_NAME: + * Disallow path separators in module names. * This feature is disabled by default. + * Enabling it prevents the use of modules in non-standard + * locations. * * =OPENPAM_FEATURE_CHECK_MODULE_FILE: + * Verify the ownership and permissions of each loadable + * module and the path leading up to it. * This feature is enabled by default. * *