Bug 579

Summary: Version 1.8.7: Documentation for I/O Plugin API open() function
Product: Sudo Reporter: Ryan A. Chapman <ryan>
Component: DocumentationAssignee: Todd C. Miller <Todd.Miller>
Status: RESOLVED FIXED    
Severity: normal    
Priority: low    
Version: 1.8.6   
Hardware: All   
OS: All   
Attachments: Diff

Description Ryan A. Chapman 2012-11-25 06:28:49 MST
Created attachment 359 [details]
Diff

Hi Todd,

I've been playing with the sudo plugins API and came across a documentation issue. In the plugin man page, the function signature for I/O Plugin API open() is missing the command_info argument (diff below).

1: int (*open)(unsigned int version,
2:             sudo_conv_t conversation
3:             sudo_printf_t plugin_printf,
4:             char * const settings[],
5:             char * const user_info[],
6:             int argc,
7:             char * const argv[],
8:             char * const user_env[],
9:             char * const plugin_options[]);  

1: int (*open)(unsigned int version,
2:             sudo_conv_t conversation,
3:             sudo_printf_t sudo_printf,
4:             char * const settings[],
5:             char * const user_info[],
6:             char * const command_info[],
7:             int argc,
8:             char * const argv[],
9:             char * const user_env[],
10:            char * const args[])



--- sudo_plugin.mdoc.in 2012-11-23 18:45:53.000000000 -0700
+++ sudo_plugin.mdoc.in.NEW     2012-11-25 04:13:32.000000000 -0700
@@ -1219,10 +1219,11 @@
 #define SUDO_IO_PLUGIN 2
     unsigned int type; /* always SUDO_IO_PLUGIN */
     unsigned int version; /* always SUDO_API_VERSION */
-    int (*open)(unsigned int version, sudo_conv_t conversation
+    int (*open)(unsigned int version, sudo_conv_t conversation,
                 sudo_printf_t plugin_printf, char * const settings[],
-                char * const user_info[], int argc, char * const argv[],
-                char * const user_env[], char * const plugin_options[]);
+                char * const user_info[], char * const command_info[],
+                int argc, char * const argv[], char * const user_env[],
+                char * const plugin_options[]);
     void (*close)(int exit_status, int error); /* wait status or error */
     int (*show_version)(int verbose);
     int (*log_ttyin)(const char *buf, unsigned int len);


Best regards,

Ryan Chapman
Bozeman, MT
Comment 1 Todd C. Miller 2012-11-26 09:58:48 MST
Thanks, I've committed that fix, along with a missing command
after the conversation argument.