[PATCH]: remove references to "outlen" from tls_init.3.

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

[PATCH]: remove references to "outlen" from tls_init.3.

Remco
Index: tls_init.3

===================================================================

RCS file: /cvs/src/lib/libtls/tls_init.3,v

retrieving revision 1.54

diff -u -p -u -r1.54 tls_init.3

--- tls_init.3 9 Nov 2015 17:52:07 -0000 1.54

+++ tls_init.3 23 Apr 2016 09:37:02 -0000

@@ -550,8 +550,7 @@ reads

.Fa buflen

bytes of data from the socket into

.Fa buf .

-The amount of data read is returned in

-.Fa outlen .

+The amount of data read, or an error condition, is returned.

.It

.Fn tls_write

writes

@@ -559,8 +558,7 @@ writes

bytes of data from

.Fa buf

to the socket.

-The amount of data written is returned in

-.Fa outlen .

+The amount of data written, or an error condition, is returned.

.It

.Fn tls_close

closes a connection after use.

Reply | Threaded
Open this post in threaded view
|

Re: [PATCH]: remove references to "outlen" from tls_init.3.

Jason McIntyre-2
On Sat, Apr 23, 2016 at 06:24:58PM +0200, Remco wrote:
> Index: tls_init.3
>
> ===================================================================
>

i think your diff is correct - in -r1.33 beck altered this to "document
changed tls_read and tls_write semantics".

i'm less convinced about stating that it may return an error code -
nothing else is documented that way, and i think it's obvious anyway. to
be fair, i can;t honestly tell by looking at the code if it returns
anything at all, so i'm guessing that hasn't changed.

so, i'll commit the diff below soon, unless i hear it's wrong.
jmc

Index: tls_init.3
===================================================================
RCS file: /cvs/src/lib/libtls/tls_init.3,v
retrieving revision 1.55
diff -u -r1.55 tls_init.3
--- tls_init.3 24 Apr 2016 07:02:07 -0000 1.55
+++ tls_init.3 24 Apr 2016 07:03:13 -0000
@@ -550,8 +550,7 @@
 .Fa buflen
 bytes of data from the socket into
 .Fa buf .
-The amount of data read is returned in
-.Fa outlen .
+It returns the amount of data read.
 .It
 .Fn tls_write
 writes
@@ -559,8 +558,7 @@
 bytes of data from
 .Fa buf
 to the socket.
-The amount of data written is returned in
-.Fa outlen .
+It returns the amount of data written.
 .It
 .Fn tls_close
 closes a connection after use.

Reply | Threaded
Open this post in threaded view
|

Re: [PATCH]: remove references to "outlen" from tls_init.3.

Brent Cook
yes, that is correct - ok bcook@

On Sun, Apr 24, 2016 at 2:06 AM, Jason McIntyre <[hidden email]> wrote:

> On Sat, Apr 23, 2016 at 06:24:58PM +0200, Remco wrote:
> > Index: tls_init.3
> >
> > ===================================================================
> >
>
> i think your diff is correct - in -r1.33 beck altered this to "document
> changed tls_read and tls_write semantics".
>
> i'm less convinced about stating that it may return an error code -
> nothing else is documented that way, and i think it's obvious anyway. to
> be fair, i can;t honestly tell by looking at the code if it returns
> anything at all, so i'm guessing that hasn't changed.
>
> so, i'll commit the diff below soon, unless i hear it's wrong.
> jmc
>
> Index: tls_init.3
> ===================================================================
> RCS file: /cvs/src/lib/libtls/tls_init.3,v
> retrieving revision 1.55
> diff -u -r1.55 tls_init.3
> --- tls_init.3  24 Apr 2016 07:02:07 -0000      1.55
> +++ tls_init.3  24 Apr 2016 07:03:13 -0000
> @@ -550,8 +550,7 @@
>  .Fa buflen
>  bytes of data from the socket into
>  .Fa buf .
> -The amount of data read is returned in
> -.Fa outlen .
> +It returns the amount of data read.
>  .It
>  .Fn tls_write
>  writes
> @@ -559,8 +558,7 @@
>  bytes of data from
>  .Fa buf
>  to the socket.
> -The amount of data written is returned in
> -.Fa outlen .
> +It returns the amount of data written.
>  .It
>  .Fn tls_close
>  closes a connection after use.
>
>