PERFORCE change 69871 for review
Dag-Erling Smorgrav
des at FreeBSD.org
Fri Jan 28 05:09:40 PST 2005
http://perforce.freebsd.org/chv.cgi?CH=69871
Change 69871 by des at des.at.des.thinksec.com on 2005/01/28 13:08:44
Hard sentence breaks in inline documentation.
Affected files ...
.. //depot/projects/openpam/lib/openpam_borrow_cred.c#13 edit
.. //depot/projects/openpam/lib/openpam_free_data.c#6 edit
.. //depot/projects/openpam/lib/openpam_log.c#24 edit
.. //depot/projects/openpam/lib/openpam_nullconv.c#7 edit
.. //depot/projects/openpam/lib/openpam_ttyconv.c#25 edit
.. //depot/projects/openpam/lib/pam_get_authtok.c#28 edit
.. //depot/projects/openpam/lib/pam_get_user.c#20 edit
.. //depot/projects/openpam/lib/pam_open_session.c#14 edit
Differences ...
==== //depot/projects/openpam/lib/openpam_borrow_cred.c#13 (text+ko) ====
@@ -31,7 +31,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
- * $P4: //depot/projects/openpam/lib/openpam_borrow_cred.c#12 $
+ * $P4: //depot/projects/openpam/lib/openpam_borrow_cred.c#13 $
*/
#include <sys/param.h>
@@ -109,10 +109,10 @@
/**
* The =openpam_borrow_cred function saves the current credentials and
- * switches to those of the user specified by its =pwd argument. The
- * affected credentials are the effective UID, the effective GID, and the
- * group access list. The original credentials can be restored using
- * =openpam_restore_cred.
+ * switches to those of the user specified by its =pwd argument.
+ * The affected credentials are the effective UID, the effective GID, and
+ * the group access list.
+ * The original credentials can be restored using =openpam_restore_cred.
*
* >setegid 2
* >seteuid 2
==== //depot/projects/openpam/lib/openpam_free_data.c#6 (text+ko) ====
@@ -31,7 +31,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
- * $P4: //depot/projects/openpam/lib/openpam_free_data.c#5 $
+ * $P4: //depot/projects/openpam/lib/openpam_free_data.c#6 $
*/
#include <stdlib.h>
@@ -64,6 +64,6 @@
/**
* The =openpam_free_data is a cleanup function suitable for passing to
- * =pam_set_data. It simply releases the data by passing its =data
- * argument to =free.
+ * =pam_set_data.
+ * It simply releases the data by passing its =data argument to =free.
*/
==== //depot/projects/openpam/lib/openpam_log.c#24 (text+ko) ====
@@ -31,7 +31,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
- * $P4: //depot/projects/openpam/lib/openpam_log.c#23 $
+ * $P4: //depot/projects/openpam/lib/openpam_log.c#24 $
*/
#include <ctype.h>
@@ -122,27 +122,31 @@
#endif
/**
- * The =openpam_log function logs messages using =syslog. It is primarily
- * intended for internal use by the library and modules.
+ * The =openpam_log function logs messages using =syslog.
+ * It is primarily intended for internal use by the library and modules.
*
- * The =level argument indicates the importance of the message. The
- * following levels are defined:
+ * The =level argument indicates the importance of the message.
+ * The following levels are defined:
*
* =PAM_LOG_DEBUG:
- * Debugging messages. These messages are normally not
- * logged unless the global integer variable :_openpam_debug
- * is set to a non-zero value, in which case they are logged
- * with a =syslog priority of =LOG_DEBUG.
+ * Debugging messages.
+ * These messages are normally not logged unless the global
+ * integer variable :_openpam_debug is set to a non-zero
+ * value, in which case they are logged with a =syslog
+ * priority of =LOG_DEBUG.
* =PAM_LOG_VERBOSE:
* Information about the progress of the authentication
- * process, or other non-essential messages. These messages
- * are logged with a =syslog priority of =LOG_INFO.
+ * process, or other non-essential messages.
+ * These messages are logged with a =syslog priority of
+ * =LOG_INFO.
* =PAM_LOG_NOTICE:
- * Messages relating to non-fatal errors. These messages are
- * logged with a =syslog priority of =LOG_NOTICE.
+ * Messages relating to non-fatal errors.
+ * These messages are logged with a =syslog priority of
+ * =LOG_NOTICE.
* =PAM_LOG_ERROR:
- * Messages relating to serious errors. These messages are
- * logged with a =syslog priority of =LOG_ERR.
+ * Messages relating to serious errors.
+ * These messages are logged with a =syslog priority of
+ * =LOG_ERR.
*
* The remaining arguments are a =printf format string and the
* corresponding arguments.
==== //depot/projects/openpam/lib/openpam_nullconv.c#7 (text+ko) ====
@@ -31,7 +31,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
- * $P4: //depot/projects/openpam/lib/openpam_nullconv.c#6 $
+ * $P4: //depot/projects/openpam/lib/openpam_nullconv.c#7 $
*/
#include <sys/types.h>
@@ -70,12 +70,13 @@
/**
* The =openpam_nullconv function is a null conversation function suitable
* for applications that want to use PAM but don't support interactive
- * dialog with the user. Such applications should set =PAM_AUTHTOK to
- * whatever authentication token they've obtained on their own before
- * calling =pam_authenticate and / or =pam_chauthtok, and their PAM
- * configuration should specify the ;use_first_pass option for all modules
- * that require access to the authentication token, to make sure they use
- * =PAM_AUTHTOK rather than try to query the user.
+ * dialog with the user.
+ * Such applications should set =PAM_AUTHTOK to whatever authentication
+ * token they've obtained on their own before calling =pam_authenticate
+ * and / or =pam_chauthtok, and their PAM configuration should specify the
+ * ;use_first_pass option for all modules that require access to the
+ * authentication token, to make sure they use =PAM_AUTHTOK rather than
+ * try to query the user.
*
* >openpam_ttyconv
* >pam_prompt
==== //depot/projects/openpam/lib/openpam_ttyconv.c#25 (text+ko) ====
@@ -31,7 +31,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
- * $P4: //depot/projects/openpam/lib/openpam_ttyconv.c#24 $
+ * $P4: //depot/projects/openpam/lib/openpam_ttyconv.c#25 $
*/
#include <sys/types.h>
@@ -230,8 +230,9 @@
/**
* The =openpam_ttyconv function is a standard conversation function
- * suitable for use on TTY devices. It should be adequate for the needs
- * of most text-based interactive programs.
+ * suitable for use on TTY devices.
+ * It should be adequate for the needs of most text-based interactive
+ * programs.
*
* The =openpam_ttyconv function allows the application to specify a
* timeout for user input by setting the global integer variable
==== //depot/projects/openpam/lib/pam_get_authtok.c#28 (text+ko) ====
@@ -31,7 +31,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
- * $P4: //depot/projects/openpam/lib/pam_get_authtok.c#27 $
+ * $P4: //depot/projects/openpam/lib/pam_get_authtok.c#28 $
*/
#include <sys/param.h>
@@ -142,9 +142,9 @@
/**
* The =pam_get_authtok function returns the cached authentication token,
- * or prompts the user if no token is currently cached. Either way, a
- * pointer to the authentication token is stored in the location pointed
- * to by the =authtok argument.
+ * or prompts the user if no token is currently cached.
+ * Either way, a pointer to the authentication token is stored in the
+ * location pointed to by the =authtok argument.
*
* The =item argument must have one of the following values:
*
@@ -157,13 +157,13 @@
*
* The =prompt argument specifies a prompt to use if no token is cached.
* If it is =NULL, the =PAM_AUTHTOK_PROMPT or =PAM_OLDAUTHTOK_PROMPT item,
- * as appropriate, will be used. If that item is also =NULL, a hardcoded
- * default prompt will be used.
+ * as appropriate, will be used.
+ * If that item is also =NULL, a hardcoded default prompt will be used.
*
* If =item is set to =PAM_AUTHTOK and there is a non-null =PAM_OLDAUTHTOK
* item, =pam_get_authtok will ask the user to confirm the new token by
- * retyping it. If there is a mismatch, =pam_get_authtok will return
- * =PAM_TRY_AGAIN.
+ * retyping it.
+ * If there is a mismatch, =pam_get_authtok will return =PAM_TRY_AGAIN.
*
* >pam_get_item
* >pam_get_user
==== //depot/projects/openpam/lib/pam_get_user.c#20 (text+ko) ====
@@ -31,7 +31,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
- * $P4: //depot/projects/openpam/lib/pam_get_user.c#19 $
+ * $P4: //depot/projects/openpam/lib/pam_get_user.c#20 $
*/
#include <sys/param.h>
@@ -96,14 +96,16 @@
/**
* The =pam_get_user function returns the name of the target user, as
- * specified to =pam_start. If no user was specified, nor set using
- * =pam_set_item, =pam_get_user will prompt for a user name. Either way,
- * a pointer to the user name is stored in the location pointed to by the
- * =user argument.
-
+ * specified to =pam_start.
+ * If no user was specified, nor set using =pam_set_item, =pam_get_user
+ * will prompt for a user name.
+ * Either way, a pointer to the user name is stored in the location
+ * pointed to by the =user argument.
+ *
* The =prompt argument specifies a prompt to use if no user name is
- * cached. If it is =NULL, the =PAM_USER_PROMPT will be used. If that
- * item is also =NULL, a hardcoded default prompt will be used.
+ * cached.
+ * If it is =NULL, the =PAM_USER_PROMPT will be used.
+ * If that item is also =NULL, a hardcoded default prompt will be used.
*
* >pam_get_item
* >pam_get_authtok
==== //depot/projects/openpam/lib/pam_open_session.c#14 (text+ko) ====
@@ -31,7 +31,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
- * $P4: //depot/projects/openpam/lib/pam_open_session.c#13 $
+ * $P4: //depot/projects/openpam/lib/pam_open_session.c#14 $
*/
#include <sys/param.h>
@@ -71,8 +71,8 @@
/**
* The =pam_open_session sets up a user session for a previously
- * authenticated user. The session should later be torn down by a call to
- * =pam_close_session.
+ * authenticated user.
+ * The session should later be torn down by a call to =pam_close_session.
*
* The =flags argument is the binary or of zero or more of the following
* values:
More information about the p4-projects
mailing list