From owner-freebsd-doc@FreeBSD.ORG Sat Dec 7 07:11:48 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 5F323C18 for ; Sat, 7 Dec 2013 07:11:48 +0000 (UTC) Received: from mail-qe0-x229.google.com (mail-qe0-x229.google.com [IPv6:2607:f8b0:400d:c02::229]) (using TLSv1 with cipher ECDHE-RSA-RC4-SHA (128/128 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id 137CD1923 for ; Sat, 7 Dec 2013 07:11:48 +0000 (UTC) Received: by mail-qe0-f41.google.com with SMTP id gh4so1284255qeb.14 for ; Fri, 06 Dec 2013 23:11:47 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=eitanadler.com; s=0xdeadbeef; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type; bh=imj1N+iX6LRieC+LF/tWQbNwvtAHxiCyOapK3F1+mmM=; b=nzTefpSlcfjdtrgU5SGaQzqX41aGsPF/hDYozx7Z9M/1SE0LKkO6J+8pQtmHgKXDe5 0dTjnNT5GXRp98pahmD7zE0/KW+F1PD89nKkhNXaiEw5gs8e0qcA0wcF1hZFhDc8x+Sv WwC8hfKjFki84LL2foUoisbjprZJjf+hbJV28= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc:content-type; bh=imj1N+iX6LRieC+LF/tWQbNwvtAHxiCyOapK3F1+mmM=; b=RLj3pzlvzqHlbNcqDk/PKOJYGWl6X/vmvXHXl1I2KksI203Pj/kEqiQHJIeuTpvujJ 3GvR3jes+PUrlhdUtEK1tA49J6EucckrTL6fHY494g/OZiSKzdELBZfBogi9EXSbvw41 87AnblrtNnODMcjDrOumsRi7tjW+Tl268FaAzcSKEI92IhJJrj0d3Z+XzV0P4B87klrf M0FJCG5z2fWNLjLp6i7w/OJv0Nd4gYzSQNDPKP3GvFdzO5vh7B9qTyyE2dgnavlBZFv/ JTuAfb523b0+7o548hRP0ljWUsmbpxdAnj01NTKQbEi6oTE6Gr22HEgCqgiTpKcMK1vQ 0/UA== X-Gm-Message-State: ALoCoQmAPRCf0kzZbqCwomP9z0ozzMQLuxU00Mpfq1TrsY03xf6B7xWL6/QkQCh/U3q8w11R5FnY X-Received: by 10.49.24.211 with SMTP id w19mr13707943qef.9.1386400307256; Fri, 06 Dec 2013 23:11:47 -0800 (PST) MIME-Version: 1.0 Received: by 10.96.86.42 with HTTP; Fri, 6 Dec 2013 23:11:17 -0800 (PST) In-Reply-To: <52A2C9A0.4050800@delphij.net> References: <201312070107.rB717SAW015758@freefall.freebsd.org> <52A2C3C3.9010703@delphij.net> <52A2C9A0.4050800@delphij.net> From: Eitan Adler Date: Sat, 7 Dec 2013 02:11:17 -0500 Message-ID: Subject: Re: docs/184550: bc -q option not documented in man page To: Xin LI Content-Type: text/plain; charset=UTF-8 Cc: "freebsd-doc@freebsd.org" , Xin LI , "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 07:11:48 -0000 On Sat, Dec 7, 2013 at 2:09 AM, Xin Li wrote: > -----BEGIN PGP SIGNED MESSAGE----- > Hash: SHA512 > > On 12/6/13, 10:48 PM, Eitan Adler wrote: >> On Sat, Dec 7, 2013 at 1:44 AM, Xin Li >> wrote: >>> -----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. >> >> Eh? >> >>> However as Warren pointed out, it's a bug having it in synopsis >>> and usage. >> >> It is not a bug. >> >>> This is fixed in r259058. >> >> This is a bug. >> >>> 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. >> >> I agree that we need better documentation for our own features; >> however, this is not a dichotomy. >> >>> 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". >> >> A similar discussion occurred when we implemented '==' for >> test(1). If a program accepts some flag as input, or some text as >> input, it must be documented. We may document it as a >> non-portable, to be avoided feature, but it should not be left >> alone. > > Fair enough, how about this? Works for me. Thank you very much! -- Eitan Adler