Date: Fri, 06 Dec 2013 22:44:19 -0800 From: Xin Li <delphij@delphij.net> To: Eitan Adler <lists@eitanadler.com>, delphij@freebsd.org Cc: freebsd-doc@freebsd.org, rfg@tristatelogic.com Subject: Re: docs/184550: bc -q option not documented in man page Message-ID: <52A2C3C3.9010703@delphij.net> In-Reply-To: <CAF6rxgk50a0gL7_O3t=iFM-XGjnwam07ZNkOOgsWV=Tu7OKDXQ@mail.gmail.com> References: <201312070107.rB717SAW015758@freefall.freebsd.org> <CAF6rxgk50a0gL7_O3t=iFM-XGjnwam07ZNkOOgsWV=Tu7OKDXQ@mail.gmail.com>
next in thread | previous in thread | raw e-mail | index | archive | help
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA512 On 12/6/13, 6:12 PM, Eitan Adler wrote: > On 12/6/13, delphij@freebsd.org <delphij@freebsd.org> wrote: >> Synopsis: bc -q option not documented in man page >> >> State-Changed-From-To: open->closed State-Changed-By: delphij >> State-Changed-When: Sat Dec 7 01:06:05 UTC 2013 >> State-Changed-Why: This is intentional. Won't fix. >> >> >> Responsible-Changed-From-To: freebsd-doc->delphij >> Responsible-Changed-By: delphij Responsible-Changed-When: Sat Dec >> 7 01:06:05 UTC 2013 Responsible-Changed-Why: Take. >> >> http://www.freebsd.org/cgi/query-pr.cgi?pr=184550 >> _______________________________________________ >> freebsd-doc@freebsd.org mailing list >> http://lists.freebsd.org/mailman/listinfo/freebsd-doc To >> unsubscribe, send any mail to >> "freebsd-doc-unsubscribe@freebsd.org" >> > > all options should be documented. An undocumented option is a > bug. If we don't want people using it we should document as such. Well, no, it's not an undocumented option but a bug-for-bug compatibility shim. However as Warren pointed out, it's a bug having it in synopsis and usage. This is fixed in r259058. With our limited manpower, I think it's more important to improve our documentation in the direction that we describe our stuff better, like how to write a vt(4) driver, etc. rather than documenting the bug-for-bug features which would just give the reader an impression like "I can write program according to GNU command line standard and expect the BSD people to diligently implement bug-for-bug compatibility". Cheers, -----BEGIN PGP SIGNATURE----- iQIcBAEBCgAGBQJSosPDAAoJEJW2GBstM+nsTaEP/A6wFR3SoTDULnwsOosbpeWb 3EtYgecKijVUFjCHJBWxAApeW2EE5mUGdQsjiF7aXz/LsRyDgYt+EGlUZ8yPyd39 +sBfB3L9VxZESjIYbjyjZ9rUsiFE6yAyw74RC3+A9zg2Dj1BNBoLFHv/MVLbpmBP NArWFS28qaY57VGgnsZG4IU1k5cdhN74vI3wa+xMbXHXainlynbV8/ZMnaaX7/yT 9OZO57JgILqEw2v+4fOMbclMraFbVj8EMW6x+nT/6In7ikej9aIRjS2cjmzZ+Zyz DIAurwb8C4IZyugdg1GrYsLe785cE4dYFcZ3k8s7hZJlcuS/OUaGo/qJ1QngThfh qjsgxCrZzf+LEQTgx95FvGTuaQ+C88NsotJC0KWoMSFDcir8K+z47LLtrYH9W96z +yAVKRgVPILtSHoGo6ETGOxN2dIaqj0kF8yG9Vt93IUN11gazTeY2TKvk+4JostA rkxMeN7DPnB6osDP3cuJ5FljVMtc7Z9WI0SkbvcCoJB585VFDpT9CrehbtKdcyLK OT+zkrTWHLW7GF1ivYnrfcnWjGe5yEi/ri/PsYefuCjs4Ud1EsQmQwWXrQUE07tw vN/WfU4BccqSPFmMn/Gl2NjgIqXm/l+qiB2K6krph3KqYZdZqYPRxjQkBLHVO73B wdYolMzVMaqAq1GzUfUG =h8jo -----END PGP SIGNATURE-----
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?52A2C3C3.9010703>