From owner-freebsd-doc@FreeBSD.ORG  Sat Dec  7 02:41:31 2013
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
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 31C28BB1;
 Sat,  7 Dec 2013 02:41:31 +0000 (UTC)
Received: from mail-pd0-x22d.google.com (mail-pd0-x22d.google.com
 [IPv6:2607:f8b0:400e:c02::22d])
 (using TLSv1 with cipher ECDHE-RSA-RC4-SHA (128/128 bits))
 (No client certificate requested)
 by mx1.freebsd.org (Postfix) with ESMTPS id ECF3F1950;
 Sat,  7 Dec 2013 02:41:30 +0000 (UTC)
Received: by mail-pd0-f173.google.com with SMTP id p10so2005296pdj.4
 for <multiple recipients>; Fri, 06 Dec 2013 18:41:29 -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=kl7ZyibFHH6AAa0vBADMOwZFSibYPSjRQOvKdmw+wLI=;
 b=VyfFIQLvmrqf0ZU+8bBZnxel0Q08f74P6kSRNHNsxaROgPVxoitBciPDmrqRJEEynM
 AMgwRfvOGAPG3qBtVFT3DQUE3cHPQOTgURdZGJzjv9RgELotD/+j/pQRDBtXxEcAuqbx
 OcpM6Ruz2WRZLaOxxmHibjWO0HurmHuBm2yWqVmNjY6HLUE6wwfrJLME4t74nyv+fD3W
 U+VeovKyDZQlkv5Nh3PFo3gQxPw+Xp3OIf86vQ72jgs9Kp8ZmrpJhVYArq7Mqek234xH
 zHRdPQx0t+WW7AwcQ33qlOYwakqSkhnLZSy7Jhe3nDNFCQPzqSuYYA6CvdXTHVDnCUf9
 zrvw==
MIME-Version: 1.0
X-Received: by 10.66.139.100 with SMTP id qx4mr7763806pab.141.1386384089867;
 Fri, 06 Dec 2013 18:41:29 -0800 (PST)
Received: by 10.70.92.79 with HTTP; Fri, 6 Dec 2013 18:41:29 -0800 (PST)
In-Reply-To: <20131207021835.GK20078@glenbarber.us>
References: <201312070107.rB717SAW015758@freefall.freebsd.org>
 <CAF6rxgk50a0gL7_O3t=iFM-XGjnwam07ZNkOOgsWV=Tu7OKDXQ@mail.gmail.com>
 <20131207021835.GK20078@glenbarber.us>
Date: Fri, 6 Dec 2013 20:41:29 -0600
Message-ID: <CA+tpaK1=oifQd8Fu7xAVNtw3OTHXDPqUJ8m28GLT3UGsTGMsFA@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:41:31 -0000

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.

-- 
Adam