From owner-freebsd-doc@FreeBSD.ORG Sat Dec 7 06:44:24 2013 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id 36E495B4; Sat, 7 Dec 2013 06:44:24 +0000 (UTC) Received: from anubis.delphij.net (anubis.delphij.net [IPv6:2001:470:1:117::25]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id 13A9B1820; Sat, 7 Dec 2013 06:44:24 +0000 (UTC) Received: from delphij-macbook.local (unknown [IPv6:2001:470:83bf:0:ed89:fcd3:46d0:72b3]) (using TLSv1 with cipher ECDHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by anubis.delphij.net (Postfix) with ESMTPSA id 6F4AF267EF; Fri, 6 Dec 2013 22:44:23 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=delphij.net; s=anubis; t=1386398663; bh=bbwF65imrsEad6JVP3k+FCkm/83xbQJiW7B02wiGjBs=; h=Date:From:Reply-To:To:CC:Subject:References:In-Reply-To; b=VYgFPfdI/k5bBdg78VJJeu3+54R8UYA6qhSwWzEH4baOVbmiwlTrNdOe7T+p0+Lwi OpMgpf39ybP3fYcYmvyaBW4ZCupBJJa8dqg/1ZOFcCf9hoJQPZ+9Wm/lXTcf4JUg2f izZB68l7jNu8DrVrSADl1QTVAYmm7VqzxIsUOSOg= Message-ID: <52A2C3C3.9010703@delphij.net> Date: Fri, 06 Dec 2013 22:44:19 -0800 From: Xin Li Organization: The FreeBSD Project MIME-Version: 1.0 To: Eitan Adler , delphij@freebsd.org Subject: Re: docs/184550: bc -q option not documented in man page References: <201312070107.rB717SAW015758@freefall.freebsd.org> In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Cc: freebsd-doc@freebsd.org, rfg@tristatelogic.com X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list Reply-To: d@delphij.net List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 07 Dec 2013 06:44:24 -0000 -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA512 On 12/6/13, 6:12 PM, Eitan Adler wrote: > On 12/6/13, 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-----