Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 6 Dec 2013 21:42:49 -0500
From:      Glen Barber <gjb@FreeBSD.org>
To:        Adam Vande More <amvandemore@gmail.com>
Cc:        freebsd-doc@freebsd.org, delphij@freebsd.org, "Ronald F. Guilmette" <rfg@tristatelogic.com>
Subject:   Re: docs/184550: bc -q option not documented in man page
Message-ID:  <20131207024249.GM20078@glenbarber.us>
In-Reply-To: <CA%2BtpaK1=oifQd8Fu7xAVNtw3OTHXDPqUJ8m28GLT3UGsTGMsFA@mail.gmail.com>
References:  <201312070107.rB717SAW015758@freefall.freebsd.org> <CAF6rxgk50a0gL7_O3t=iFM-XGjnwam07ZNkOOgsWV=Tu7OKDXQ@mail.gmail.com> <20131207021835.GK20078@glenbarber.us> <CA%2BtpaK1=oifQd8Fu7xAVNtw3OTHXDPqUJ8m28GLT3UGsTGMsFA@mail.gmail.com>

next in thread | previous in thread | raw e-mail | index | archive | help

--rpGc+ACYPE+RMC+Z
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Fri, Dec 06, 2013 at 08:41:29PM -0600, Adam Vande More wrote:
> On Fri, Dec 6, 2013 at 8:18 PM, Glen Barber <gjb@freebsd.org> wrote:
>=20
> > 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;
> >
>=20
> Source code comments IMO don't qualify for docs.
>=20
> It should be documented in the man page.  There are plenty of other
> examples cite option X is there for compatibility/historical purposes.
>  Most users aren't going to review the source code for docs.
>=20

Since it does nothing, it absolutely applies, IMHO.

Glen


--rpGc+ACYPE+RMC+Z
Content-Type: application/pgp-signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (FreeBSD)

iQIcBAEBCAAGBQJSoospAAoJELls3eqvi17QHDIP/A6w+EAHF7IrI375VlVP+zDV
Jx2seAk9qe8YsHugd+ecrlHoNVNeJdtnzW7jBZ54AtXKi+eAPBtZu6QbbMVeGPur
jgLdWeLuDzjDyWl2g3uYgP0K/iyFEN8QS+LXbvDOlN1cNjUb0ZVaYKPDCvGfDlHf
k8zZVqMogoEsqKtmXmwHZIh0Vfx6ecDxxyFX2tEh3SlE5nAyaifcbBCHwgUmk5+Q
GQbE0+qUVBXvq//kjQxIPC8AzqaI5InMTpxlvA2zoGaf28h/Tc0VckZe1n5XxF5V
6spB9UO03fFYlyk70zYTLwDDJydB2yaUzTHHybpAOnD8byEDyLZkIpLxn7Uya89J
awL4m4X9VpyYomE1p7EiNO53HngU4SClYgftlZJm9v5XGZmIiPnmiKeKf4eLbOql
PxMR1klHc7bsYFWG/XCq44AoeqzEC9S9zoYieheGOEl/91/DXQiZo80pPZkMNozd
AlOFlFrWjG4QCCVIB8KqHmqobFnlPpgWV1xDPwwZ6UUCd9l1SR2+I9ad+har4fSk
6H11dhbxVzSBwJKlZBvvpDriTEoeI8IyMFaYQdpvOIvSLHFGkHVFFG4H/z836+nc
nUTAL319JGCWt7OT5LmAiMzKAgYqX8GWi0bCt5rw4H5vvEIHFGUszMUDnlf4/KnQ
phxj62CzmkZOnoe24wRl
=NlKb
-----END PGP SIGNATURE-----

--rpGc+ACYPE+RMC+Z--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20131207024249.GM20078>