From owner-freebsd-ports@freebsd.org Sat Sep 17 09:45:02 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 4338ABDDFDF for ; Sat, 17 Sep 2016 09:45:02 +0000 (UTC) (envelope-from ohauer@gmx.de) Received: from mout.gmx.net (mout.gmx.net [212.227.17.22]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mout.gmx.net", Issuer "TeleSec ServerPass DE-2" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id A9A7879D for ; Sat, 17 Sep 2016 09:45:00 +0000 (UTC) (envelope-from ohauer@gmx.de) Received: from [192.168.100.100] ([87.139.233.65]) by mail.gmx.com (mrgmx102) with ESMTPSA (Nemesis) id 0MGFz9-1booRF2glz-00F7oE; Sat, 17 Sep 2016 11:39:02 +0200 Subject: Re: Checking port option descriptions To: freebsd-ports@freebsd.org References: <11003591.UQgRz8LoQ6@curlew.lan> Cc: Mike Clarke , Warren Block From: olli hauer Message-ID: <547860e5-6511-56f2-13d3-9ec9e3d1db37@gmx.de> Date: Sat, 17 Sep 2016 11:39:07 +0200 User-Agent: Mozilla/5.0 (Windows NT 5.1; rv:45.0) Gecko/20100101 Thunderbird/45.3.0 MIME-Version: 1.0 In-Reply-To: <11003591.UQgRz8LoQ6@curlew.lan> Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 8bit X-Provags-ID: V03:K0:WWKZMD8La5S2NiapfovYku+dQVOOolzTM4FxooOfKXBmmdnTK0o Sy9V7GdBLTVEEzWO9Q0Et67TsLSsU1KKwPRc/JG8sadskZfOJDbj00r5piUpSyZ8l8uZF25 GH6OE/pCgbs/ILl7D5x4xKZhKpnpkSUDo/ghDyC9rtRilFscU+Yg3ChAmD7drLhZs4MLuJ3 6VAtgh2BA+Ev5W8XGGj2Q== X-UI-Out-Filterresults: notjunk:1;V01:K0:eo+mgyCQbr4=:fK10TiF6M4phGYRNRxP+cc TDL0DF2L0nevU9n29HVopgHg6B44mTVQctLf2WkNUrvyxemqZzhkkxYo9Ny3xWvd+ZDDrPeSJ wvYMEmSQFxdxHU6PR8RTiC2FDoPQcBjLK6wxb9/n/hWYHcuOXzvDaReosT80WDqVy56CIzu9o 7H5RNs6BGOiVwTl3JQYx0A7v2h0A6fz9ugQBTEp58bK1BtB5/DCKmH/L3/bLnf2gmmFlBmAn5 YnUu9cBaGafyVNEHlNPC3Z9hojEH9bSF9PKaAXEwy41aKXBJexp57ChvEaNfn9FsOGyPGwufk fw2EVi6A8Z9YBgg0I8Ya9XJ1Ahh8nmrt1KsU7DhAMMjJXJY2skhOljaGU8uUAo23qBY8kvlBc IbeUCR97F/z90zVvPvFNsR3T1IvuH5ToLTQ2sCLZR3/aZagCs4ejH/NrKJP1HfnKiZYfUcy5w NAS1IsbeDbmwwGRVij8jtcjeo7j6S5Qw2s9B2zEct/pS6sRihjneJat42uYT9HklKwbOKs1UY 9cBB48bRFXFX0YP+Ea4uDeZ6hBbUpma5LBsAeeWh4PzGHYNonoOxeIlcUDMOWUuq8t3c+zhX4 hx2YpiUyiblLr7IU2lewjk/ugyF1U+pd691kxGw3W/+qzdurzynTlWiFLYxFRpC68WWrXvaFP rdxjVSZTu6Vpm0y/NoAcw5R7cuHi6qlhnGFuETMVlv4LwznkJ6xJ6IIQKjq1gw5X2YJbFKLl1 BqVnhQQ6OUy5zKrq//NyrZ1tJZRW7j373claZPSeqGF8pbpIps5z13OZzR5S2L7PNDXy1EbIw hsKx4rH 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 09:45:02 -0000 On 2016-09-17 10:47, Mike Clarke wrote: > On Friday 16 Sep 2016 20:09:06 Kevin Oberman wrote: > >> Even when the meaning is clear in global sense, what are the implications >> for an application. E.g. "RTC=on: Add support for kernel real time clock" >> in mplayer. I know exactly what the RTC is, but I have no idea why I might >> or might not want it in mplayer. > > 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. > This is already possible with the pkg-help file, but until now only 17 ports using this to provide additional information I agree with the request from Warren, but looking over optcheck-output.txt we will find many false positives. Sometimes the port defines a descriptive OPTION where it is hard to find a better description, also many ports using Mk/bsd.options.desc.mk, so the same description should match for example to a server or a client port (e.g. KERBEROS) I suspect the list will contain less the 100 issues if reviewed in context of the port and the port category Some samples from the list for "** just adding "enable support" is not a description" audio/decibel-audio-player/Makefile AUDIOCD = AudioCD support deskutils/py-bugwarrior/Makefile BUGZILLA = Enable Bugzilla support PHABRICATOR = Enable Phabricator support dns/gdnsd/Makefile GEOIP = Enable GeoIP Support games/imaze/Makefile JOYSTICK = Joystick support graphics/devil/Makefile JPEG = Enable JPEG support (one example for most every graphic format) ... -- olli