Mention in the conversation function section that a newline is

not implicit.

diff --git a/doc/sudo_plugin.cat b/doc/sudo_plugin.cat
index bcf50df0a02e89754930653d2ee269705d7b0fd8..b2d1c00cb9ea1ece808785e952fc9db52fa82991 100644 (file)
--- a/doc/sudo_plugin.cat
+++ b/doc/sudo_plugin.cat
@@ -1,7 +1,7 @@
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
 S\bSu\bud\bdo\bo P\bPl\blu\bug\bgi\bin\bn A\bAP\bPI\bI
@@ -61,13 +61,13 @@ S\bSu\bud\bdo\bo P\bPl\blu\bug\bgi\bin\bn A\bAP\bPI\bI
 
 
 
-1.8.0a1                 February 24, 2010                       1
+1.8.0a1                   March 11, 2010                        1
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
         struct policy_plugin {
@@ -127,13 +127,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                       2
+1.8.0a1                   March 11, 2010                        2
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
                when running s\bsu\bud\bdo\bo.  As such, they will only be present when the
@@ -193,13 +193,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                       3
+1.8.0a1                   March 11, 2010                        3
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
                selinux_type=string
@@ -259,13 +259,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                       4
+1.8.0a1                   March 11, 2010                        4
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
        close
@@ -325,13 +325,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                       5
+1.8.0a1                   March 11, 2010                        5
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
                command line in the form of a NULL-terminated vector of
@@ -391,13 +391,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                       6
+1.8.0a1                   March 11, 2010                        6
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
                chroot=string
@@ -457,13 +457,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                       7
+1.8.0a1                   March 11, 2010                        7
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
            argc
@@ -510,7 +510,8 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
        If the plugin needs to interact with the user or display informational
        or error messages, it may do so via the conversation function.  A
        plugin should not attempt to read directly from the standard input or
-       the user's tty.
+       the user's tty (neither of which are guaranteed to exist).  The caller
+       must include a trailing newline in msg if they want one to be printed.
 
 
 
@@ -522,14 +523,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
+1.8.0a1                   March 11, 2010                        8
 
-1.8.0a1                 February 24, 2010                       8
 
 
 
 
-
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
         struct sudo_conv_message {
@@ -589,13 +589,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                       9
+1.8.0a1                   March 11, 2010                        9
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
        version
@@ -655,13 +655,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                      10
+1.8.0a1                   March 11, 2010                       10
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
            user_env
@@ -721,13 +721,13 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                      11
+1.8.0a1                   March 11, 2010                       11
 
 
 
 
 
-SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
            The _\bl_\bo_\bg_\b__\bo_\bu_\bt_\bp_\bu_\bt function is called whenever data can be read from
@@ -787,6 +787,6 @@ SUDO_PLUGIN(8)         MAINTENANCE COMMANDS        SUDO_PLUGIN(8)
 
 
 
-1.8.0a1                 February 24, 2010                      12
+1.8.0a1                   March 11, 2010                       12
 
 

diff --git a/doc/sudo_plugin.man.in b/doc/sudo_plugin.man.in
index c0571314f43981c0d9598aae69234f8647b72a64..4b7d5227751a0eef584d9ab25b9e27e96e59862e 100644 (file)
--- a/doc/sudo_plugin.man.in
+++ b/doc/sudo_plugin.man.in
@@ -139,7 +139,7 @@
 .\" ========================================================================
 .\"
 .IX Title "SUDO_PLUGIN @mansectsu@"
-.TH SUDO_PLUGIN @mansectsu@ "February 24, 2010" "1.8.0a1" "MAINTENANCE COMMANDS"
+.TH SUDO_PLUGIN @mansectsu@ "March 11, 2010" "1.8.0a1" "MAINTENANCE COMMANDS"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -607,7 +607,9 @@ support credential caching.
 If the plugin needs to interact with the user or display informational
 or error messages, it may do so via the conversation function.  A
 plugin should not attempt to read directly from the standard input
-or the user's tty.
+or the user's tty (neither of which are guaranteed to exist).  The
+caller must include a trailing newline in \f(CW\*(C`msg\*(C'\fR if they want one
+to be printed.
 .PP
 .Vb 9
 \& struct sudo_conv_message {

diff --git a/doc/sudo_plugin.pod b/doc/sudo_plugin.pod
index ec20757974108048bba9ab29c13d3bf320612520..b5ad09a7e35a7d36bc1f953b8dffa57400cbc67c 100644 (file)
--- a/doc/sudo_plugin.pod
+++ b/doc/sudo_plugin.pod
@@ -527,7 +527,9 @@ support credential caching.
 If the plugin needs to interact with the user or display informational
 or error messages, it may do so via the conversation function.  A
 plugin should not attempt to read directly from the standard input
-or the user's tty.
+or the user's tty (neither of which are guaranteed to exist).  The
+caller must include a trailing newline in C<msg> if they want one
+to be printed.
 
  struct sudo_conv_message {
  #define SUDO_CONV_PROMPT_ECHO_OFF     1