docs/184550: bc -q option not documented in man page

Warren Block wblock at wonkity.com
Sat Dec 7 05:59:24 UTC 2013


On Fri, 6 Dec 2013, Eitan Adler wrote:

> On Fri, Dec 6, 2013 at 9:18 PM, Glen Barber <gjb at freebsd.org> wrote:
>> On Fri, Dec 06, 2013 at 09:12:30PM -0500, Eitan Adler wrote:
>>> all options should be documented.  An undocumented option is a bug.
>>> If we don't want people using it we should document as such.
>>>
>>
>> It is documented.
>>
>>                 case 'q':
>>                         /* compatibility option */
>>                         break;
>
> Source code is not documentation.  It it surprising to hear that,
> especially on this list.

This is a bit puzzling.  If -q is secret somehow, let's take it out of 
the synopsis.  If it's real, it should be in the synopsis and 
description.

   -q	No-op, does nil, nothing, nada.  Emphatically not for
 	compatibility with GNU bc, but coincidentally allows scripts
 	from icky other platforms where -q does something to run without error.
 	May occasionally print "gravy-sucking pig-dog" or contain traces
 	of soy, nuts, eggs, titanium, and riboflavin, all part of a
 	really interesting alibi.


More information about the freebsd-doc mailing list