From owner-freebsd-stable@FreeBSD.ORG Thu Jun 7 05:34:49 2012 Return-Path: Delivered-To: freebsd-stable@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 315BB106566B; Thu, 7 Jun 2012 05:34:49 +0000 (UTC) (envelope-from dave@jetcafe.org) Received: from hugeraid.jetcafe.org (hugeraid.jetcafe.org [205.147.26.109]) by mx1.freebsd.org (Postfix) with ESMTP id E38FA8FC14; Thu, 7 Jun 2012 05:34:48 +0000 (UTC) Received: from hugeraid.jetcafe.org (localhost [127.0.0.1]) by hugeraid.jetcafe.org (8.13.8/8.13.8) with ESMTP id q575R1sX052893; Wed, 6 Jun 2012 22:27:04 -0700 (PDT) Message-Id: <201206070527.q575R1sX052893@hugeraid.jetcafe.org> X-Mailer: exmh version 2.7.2 01/07/2005 with nmh-1.0.4 To: Doug Barton In-reply-to: <4FCFC846.5050508@FreeBSD.org> References: <201206020012.q520CEcf057568@hugeraid.jetcafe.org> <20120602004230.GA14487@in-addr.com> <201206040224.q542OBqk085897@hugeraid.jetcafe.org> <20120604043233.GB32597@lonesome.com> <201206040841.q548fVHa091169@hugeraid.jetcafe.org> <201206041841.q54IfUow001060@hugeraid.jetcafe.org> <20120604191343.GF10783@isuckatdomains.isuckatdomains.net> <201206041932.q54JWONA001600@hugeraid.jetcafe.org> <4FCDA15C.2000700@digsys.bg> <201206061859.q56IxvLx045828@hugeraid.jetcafe.org> <4FCFC846.5050508@FreeBSD.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Date: Wed, 06 Jun 2012 22:27:01 -0700 From: Dave Hayes Cc: freebsd-stable@FreeBSD.org, Daniel Kalchev Subject: Re: Documenting 'make config' options X-BeenThere: freebsd-stable@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Production branch of FreeBSD source code List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 07 Jun 2012 05:34:49 -0000 Doug Barton writes: > On 06/06/2012 11:59, Dave Hayes wrote: >> I'm describing more of a use case here, not attempting to specify an >> implementation. If a user invokes 'make', a window is presented to them >> with various options. It's probably very common that this is met with an >> initial reaction of "what the hell do these do?", even from the most >> seasoned of admins (presuming they are unfamiliar with the software they >> have been asked to install). I claim it would be an improvement to have >> that information at the fingertips of the make invoker. > What manner of providing this information would meet your needs? Personally, a 'pkg-options-descr' text file would suit me just fine. I don't claim this is a good or bad idea from the general perspective of FreeBSD users as a group. ;) From that perspective, the menu example suggested by Warren Block is decent; perhaps with an added button to "reset to defaults". From a quick persual of dialog(1), I'm sure something similar in functionality could be used without having to modify dialog itself. My loose attempt at requirements is that "enough" information about each option be in one place in the port skeleton to make an informed decision about whether to turn that option on or off. There should be a clear paragraph explaining what the option does, what consequences it might have if you enable/disable it, and why the default was chosen. BTW, thank you for changing the subject line. -- Dave Hayes - Consultant - Altadena CA, USA - dave@jetcafe.org >>> The opinions expressed above are entirely my own <<< Never promise, even by implication, without fulfilling your promise. The only acceptable alternative to completing an undertaking is to over-fulfil it. To betray any promise, explicit or otherwise, will harm you more than it can harm anyone else.