From owner-freebsd-ports@freebsd.org Sat Sep 17 15:34:07 2016 Return-Path: Delivered-To: freebsd-ports@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id A8453BDE916 for ; Sat, 17 Sep 2016 15:34:07 +0000 (UTC) (envelope-from wblock@wonkity.com) Received: from mailman.ysv.freebsd.org (unknown [127.0.1.3]) by mx1.freebsd.org (Postfix) with ESMTP id 91D30F24 for ; Sat, 17 Sep 2016 15:34:07 +0000 (UTC) (envelope-from wblock@wonkity.com) Received: by mailman.ysv.freebsd.org (Postfix) id 8DBD2BDE915; Sat, 17 Sep 2016 15:34:07 +0000 (UTC) Delivered-To: ports@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 8D5DABDE914 for ; Sat, 17 Sep 2016 15:34:07 +0000 (UTC) (envelope-from wblock@wonkity.com) Received: from wonkity.com (wonkity.com [67.158.26.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "wonkity.com", Issuer "wonkity.com" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 5DD5BF23 for ; Sat, 17 Sep 2016 15:34:06 +0000 (UTC) (envelope-from wblock@wonkity.com) Received: from wonkity.com (localhost [127.0.0.1]) by wonkity.com (8.15.2/8.15.2) with ESMTPS id u8HFXuk6050137 (version=TLSv1.2 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO); Sat, 17 Sep 2016 09:33:56 -0600 (MDT) (envelope-from wblock@wonkity.com) Received: from localhost (wblock@localhost) by wonkity.com (8.15.2/8.15.2/Submit) with ESMTP id u8HFXuB7050134; Sat, 17 Sep 2016 09:33:56 -0600 (MDT) (envelope-from wblock@wonkity.com) Date: Sat, 17 Sep 2016 09:33:56 -0600 (MDT) From: Warren Block To: Margaret cc: FreeBSD ports Subject: Re: Checking port option descriptions In-Reply-To: <4bmqtblq0nl3qmcdomq1koa0n7ic3bqk71@4ax.com> Message-ID: References: <11003591.UQgRz8LoQ6@curlew.lan> <4bmqtblq0nl3qmcdomq1koa0n7ic3bqk71@4ax.com> User-Agent: Alpine 2.20 (BSF 67 2015-01-07) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII; format=flowed X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3 (wonkity.com [127.0.0.1]); Sat, 17 Sep 2016 09:33:56 -0600 (MDT) X-BeenThere: freebsd-ports@freebsd.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Porting software to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 17 Sep 2016 15:34:07 -0000 On Sat, 17 Sep 2016, Margaret wrote: > [Default] On Sat, 17 Sep 2016 09:47:10 +0100, Mike Clarke > wrote: > >> For cases where one line comments won't suffice how about providing the facility >> to include an extra text file in a port (perhaps "pkg-options") containing >> notes about why some particular options would be chosen? >> >> In its simplest form a user would be able to refer to the file before selecting >> an option, A further enhancement could be to modify the way that configure >> works so that the user can select an option and press "?" to see the section >> of text, if any, from pkg-options explaining that option. > > I like that idea! > > The nice thing about good, useful comments is that, like the > software itself, they generally only have to be written from > scratch ONCE. > > It shouldn't be too hard to agree a template for the file you > propose. This already exists, without adding anything at all. There is help text at the bottom of the screen to show these. Unfortunately, I can't think of an example.