From owner-freebsd-doc@FreeBSD.ORG Sat Dec 7 02:42:58 2013 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id CDB57C12; Sat, 7 Dec 2013 02:42:58 +0000 (UTC) Received: from mail0.glenbarber.us (mail0.glenbarber.us [IPv6:2607:fc50:1:2300:1001:1001:1001:face]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id 9DC1D195B; Sat, 7 Dec 2013 02:42:58 +0000 (UTC) Received: from glenbarber.us (unknown [IPv6:2001:470:8:1205:2:2:ff:100]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) (Authenticated sender: gjb) by mail0.glenbarber.us (Postfix) with ESMTPSA id 070053FC1; Sat, 7 Dec 2013 02:42:50 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.8.3 mail0.glenbarber.us 070053FC1 Authentication-Results: mail0.glenbarber.us; dkim=none reason="no signature"; dkim-adsp=none Date: Fri, 6 Dec 2013 21:42:49 -0500 From: Glen Barber To: Adam Vande More Subject: Re: docs/184550: bc -q option not documented in man page Message-ID: <20131207024249.GM20078@glenbarber.us> References: <201312070107.rB717SAW015758@freefall.freebsd.org> <20131207021835.GK20078@glenbarber.us> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="rpGc+ACYPE+RMC+Z" Content-Disposition: inline In-Reply-To: X-Operating-System: FreeBSD 11.0-CURRENT amd64 User-Agent: Mutt/1.5.22 (2013-10-16) Cc: freebsd-doc@freebsd.org, delphij@freebsd.org, "Ronald F. Guilmette" X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 07 Dec 2013 02:42:58 -0000 --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 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--