curl-library
Re: options man pages (Re: the survey summary)
From: Daniel Stenberg <daniel_at_haxx.se>
Date: Mon, 16 Jun 2014 22:20:13 +0200 (CEST)
Date: Mon, 16 Jun 2014 22:20:13 +0200 (CEST)
On Mon, 16 Jun 2014, Dan Fandrich wrote:
> Since the new format encourages more verbosity, I suggest adding a RETURN
> VALUE section, which will be mind-numbingly repetitive for most options, but
> should subtly encourage people to actually check the return value. Also, a
> DEFAULT VALUE section may make sense as well, since these are all options
> and will all have a default value of some sort.
A good idea - added now. I've also created a 'template.3' file now for
creating new option man pages to make sure most fields get added at once.
> At some point, a filecheck: makefile target would make sense to verify that
> all options have a man page.
I like that idea too!
-- / daniel.haxx.se ------------------------------------------------------------------- List admin: http://cool.haxx.se/list/listinfo/curl-library Etiquette: http://curl.haxx.se/mail/etiquette.htmlReceived on 2014-06-16