[apparmor] [PATCH 6/7] libapparmor: Update aa_getcon man page to reflect getpeercon changes

[Tyler Hicks]

On 2013-06-23 16:23:18, Tyler Hicks wrote:
> Add aa_getpeercon_raw() to the man page and adjust aa_getpeercon()
> prototype to include the new mode parameter.
> 
> Also, explain the significance of ERANGE for aa_getpeercon_raw() and fix
> a misspelling in the meaning of ERANGE.
> 
> Signed-off-by: Tyler Hicks <tyhicks at canonical.com>
> ---
>  libraries/libapparmor/doc/aa_getcon.pod | 15 +++++++++++++--
>  1 file changed, 13 insertions(+), 2 deletions(-)
> 
> diff --git a/libraries/libapparmor/doc/aa_getcon.pod b/libraries/libapparmor/doc/aa_getcon.pod
> index f279128..d7f2ba6 100644
> --- a/libraries/libapparmor/doc/aa_getcon.pod
> +++ b/libraries/libapparmor/doc/aa_getcon.pod
> @@ -41,7 +41,9 @@ B<int aa_gettaskcon(pid_t target, char **con, char **mode);>
>  
>  B<int aa_getcon(char **con, char **mode);>
>  
> -B<int aa_getpeercon(int fd, char **con);>
> +B<int aa_getpeercon_raw(int fd, char *buf, int *len, char **mode);>
> +
> +B<int aa_getpeercon(int fd, char **con, char **mode);>
>  
>  Link with B<-lapparmor> when compiling.
>  
> @@ -59,6 +61,9 @@ The aa_getpeercon function is similar to that of aa_gettaskcon except that
>  it returns the confinement information for task on the other end of a socket
>  connection.
>  
> +The aa_getpeercon_raw function is the backend for the aa_getpeercon function
> +and does not handle buffer allocation.
> +
>  The aa_getprocattr function is the backend for the aa_getcon and aa_gettaskcon
>  functions and handles the reading and parsing of the confinement data from
>  different arbitrary attr files and returns the processed results in
> @@ -96,10 +101,16 @@ The specified I<file/task> does not exist or is not visible.
>  
>  =item B<ERANGE>
>  
> -The confinement data is to large to fit in the supplied buffer.
> +The confinement data is too large to fit in the supplied buffer.
>  
>  =back
>  
> +=head1 NOTES
> +
> +If aa_getpeercon_raw returns -1 and errno is ERANGE, the value of size can be
> +used to reallocate buf so that it is sufficiently large enough to store the
> +confinement data.

This should read, "... ERANGE, the value of *len can be used ...". I
changed the parameter's name from size to len in the previous patch but
this portion of the man page was not updated after I did that.

I'll change this before committing.

Tyler

> +
>  =head1 BUGS
>  
>  None known. If you find any, please report them at
> -- 
> 1.8.1.2
> 
> 
> -- 
> AppArmor mailing list
> AppArmor at lists.ubuntu.com
> Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/apparmor
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <https://lists.ubuntu.com/archives/apparmor/attachments/20130625/7f2fd527/attachment.pgp>