cURL / Mailing Lists / curl-library / Single Mail

curl-library

Re: options man pages (Re: the survey summary)

From: Dan Fandrich <dan_at_coneharvesters.com>
Date: Mon, 16 Jun 2014 21:36:21 +0200

On Mon, 16 Jun 2014, Daniel Stenberg wrote:
> Here's a taste of what I have in mind. Here's a separate man page for
> CURLOPT_WRITEFUNCTION:
>
> http://curl.haxx.se/libcurl/c/CURLOPT_WRITEFUNCTION.html

I'll admit I was a bit dubious about the value of splitting these options into
their own man pages, but having seen a few examples now, I can see the benefit.
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.

At some point, a filecheck: makefile target would make sense to verify that
all options have a man page.

>>> Dan
-------------------------------------------------------------------
List admin: http://cool.haxx.se/list/listinfo/curl-library
Etiquette: http://curl.haxx.se/mail/etiquette.html
Received on 2014-06-16