From owner-freebsd-doc@FreeBSD.ORG  Sat Dec  7 02:47:17 2013
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
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 9CA6AD2F;
 Sat,  7 Dec 2013 02:47:17 +0000 (UTC)
Received: from mail-pb0-x235.google.com (mail-pb0-x235.google.com
 [IPv6:2607:f8b0:400e:c01::235])
 (using TLSv1 with cipher ECDHE-RSA-RC4-SHA (128/128 bits))
 (No client certificate requested)
 by mx1.freebsd.org (Postfix) with ESMTPS id 650D1197B;
 Sat,  7 Dec 2013 02:47:17 +0000 (UTC)
Received: by mail-pb0-f53.google.com with SMTP id ma3so2099903pbc.26
 for <multiple recipients>; Fri, 06 Dec 2013 18:47:17 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;
 h=mime-version:in-reply-to:references:date:message-id:subject:from:to
 :cc:content-type;
 bh=NiG4TV1crAGjHHtGv9QPoXKaW2Q8lfdfO9rTYf7PmBc=;
 b=QYLgNYeIyRYYn4Ss0mNHW/Vc8S3W9rcWQWVgZ/uTL892Pl6u+uDY9fXKIu53KuKYtw
 4tQez9UgzWHcpnt/GU4tHEcMqyod84Z4beIxX66XUfOrrhX83bOgsb4utj1opTU6ZiYl
 An//8ZAzjJcAdjAm8ZX9NoCw4GUhRJNBNyzNjpSeTGt/4sb1x5jRHw644vYn1UAMFd1d
 o+AlmCfB89JHUgTLllZ0s+LPp0djXlkXZJcQBVHG/wQGkhUskkmwpQeOT/gwLTxGayHZ
 MBHnGwt9TtDM+I55wXXQc5lJz477KMn+UYoUamVxIY3itjj6LSexxBV/LobjU/+w52qk
 UV9Q==
MIME-Version: 1.0
X-Received: by 10.66.26.106 with SMTP id k10mr7906488pag.136.1386384436884;
 Fri, 06 Dec 2013 18:47:16 -0800 (PST)
Received: by 10.70.92.79 with HTTP; Fri, 6 Dec 2013 18:47:16 -0800 (PST)
In-Reply-To: <20131207024249.GM20078@glenbarber.us>
References: <201312070107.rB717SAW015758@freefall.freebsd.org>
 <CAF6rxgk50a0gL7_O3t=iFM-XGjnwam07ZNkOOgsWV=Tu7OKDXQ@mail.gmail.com>
 <20131207021835.GK20078@glenbarber.us>
 <CA+tpaK1=oifQd8Fu7xAVNtw3OTHXDPqUJ8m28GLT3UGsTGMsFA@mail.gmail.com>
 <20131207024249.GM20078@glenbarber.us>
Date: Fri, 6 Dec 2013 20:47:16 -0600
Message-ID: <CA+tpaK3i_d2faRVrQAnBy9fz3z4sY0f0xw3yNLsUfDEE5RvenA@mail.gmail.com>
Subject: Re: docs/184550: bc -q option not documented in man page
From: Adam Vande More <amvandemore@gmail.com>
To: Glen Barber <gjb@freebsd.org>
Content-Type: text/plain; charset=ISO-8859-1
X-Content-Filtered-By: Mailman/MimeDel 2.1.17
Cc: freebsd-doc@freebsd.org, delphij@freebsd.org,
 "Ronald F. Guilmette" <rfg@tristatelogic.com>
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.17
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc/>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sat, 07 Dec 2013 02:47:17 -0000

On Fri, Dec 6, 2013 at 8:42 PM, Glen Barber <gjb@freebsd.org> wrote:

> 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:
> >
> > > 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;
> > >
> >
> > Source code comments IMO don't qualify for docs.
> >
> > 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.
> >
>
> Since it does nothing, it absolutely applies, IMHO.
>

You're right, it is < trivial.  However it's still technically a bug.
 Maybe there is no good reason for q's existence.


-- 
Adam