Re: remove 'returns no value' from man pages

2016-03-13 Thread Marc Espie 
On Sat, Mar 12, 2016 at 01:18:18PM -0800, Michael McConville wrote:
> Marc Espie wrote:
> > On Fri, Mar 11, 2016 at 05:18:52PM -0800, Michael McConville wrote:
> > > This is specified only irregularly, and people who don't know what a
> > > void return type means are beyond help anyway.
> > > 
> > > This also adds a sentence specifying that X509_free(3) is NULL-safe, now
> > > that we've removed all NULL-checks for it. I should sweep through and
> > > add the sentence the rest of the NULL-safe LibreSSL *_free() functions
> > > soon.
> > > 
> > > ok?
> > 
> > I would keep the one about rewind, maybe make it even stronger.
> > 
> > Using rewind is icky.   It deliberately hides an error message.
> 
> Sounds good - I'll leave that one and remove the rest. Let me know if
> you have a proposed wording for the additional rewind(3) warning.

You will have to work with jmc, I guess.  
I would probably go

The
.Fn rewind
function returns no value.
Prefer
.Fn fseek ,
which is just as portable, and does not hide errors.
.Pp

Re: remove 'returns no value' from man pages

2016-03-12 Thread Michael McConville 
Marc Espie wrote:
> On Fri, Mar 11, 2016 at 05:18:52PM -0800, Michael McConville wrote:
> > This is specified only irregularly, and people who don't know what a
> > void return type means are beyond help anyway.
> > 
> > This also adds a sentence specifying that X509_free(3) is NULL-safe, now
> > that we've removed all NULL-checks for it. I should sweep through and
> > add the sentence the rest of the NULL-safe LibreSSL *_free() functions
> > soon.
> > 
> > ok?
> 
> I would keep the one about rewind, maybe make it even stronger.
> 
> Using rewind is icky.   It deliberately hides an error message.

Sounds good - I'll leave that one and remove the rest. Let me know if
you have a proposed wording for the additional rewind(3) warning.

Re: remove 'returns no value' from man pages

2016-03-12 Thread Marc Espie 
On Fri, Mar 11, 2016 at 05:18:52PM -0800, Michael McConville wrote:
> This is specified only irregularly, and people who don't know what a
> void return type means are beyond help anyway.
> 
> This also adds a sentence specifying that X509_free(3) is NULL-safe, now
> that we've removed all NULL-checks for it. I should sweep through and
> add the sentence the rest of the NULL-safe LibreSSL *_free() functions
> soon.
> 
> ok?

I would keep the one about rewind, maybe make it even stronger.

Using rewind is icky.   It deliberately hides an error message.

Re: remove 'returns no value' from man pages

2016-03-12 Thread Ingo Schwarze 
Hi Michael,

Michael McConville wrote on Fri, Mar 11, 2016 at 05:18:52PM -0800:

> This is specified only irregularly, and people who don't know what a
> void return type means are beyond help anyway.

I don't feel strongly either way, but i certainly don't object.
Usually shorter with the same information is better, and consistency
is good, so you should probably do this.

Yours,
  Ingo