Documenting 'make config' options

[Charles Sprickman]

On Jun 6, 2012, at 7:43 PM, Warren Block wrote:

> On Wed, 6 Jun 2012, Vincent Hoffman wrote:
> 
>> On 06/06/2012 22:23, Glen Barber wrote:
>>> On Wed, Jun 06, 2012 at 02:14:46PM -0700, Doug Barton wrote:
>>>> 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?
>>>> 
>>> IMHO, something informing what "THAT" is in devel/subversion option
>>> MOD_DONTDOTHAT would be nice.  :)
>>> 
>> Not something I had bothered looking up till now as I hadnt wanted to
>> use it but the 2nd hit on google,
>> http://lists.freebsd.org/pipermail/freebsd-ports-bugs/2009-April/161673.html
>> describes it quite well.
>> I tend to go with, If i dont know what it is, and its not default, I
>> probably dont need it.
>> Unless it looks interesting, then I google it ;)
>> 
>> Maybe an (optional) new file with a longer descriptions of the make
>> options so as not to crowd the make config dialog?
>> I dont mind looking up compile time options for software I am installing
>> but I can see how having a precis available locally might be handy.
> 
> Here's an idea: if the description is too long to show in the very limited space, cut it off, show a "...", and show the entire description in a two- or three-line text box below the main one.  The >< indicate a highlight here:
> 
>  -----------------------------------------------
>  >[ ] GOOFY     Build with support for the...  <
>   [ ] EXAMPLES  Install the examples
> 
>  -----------------------------------------------
>           <  OK  >          <Cancel>
> 
>   ---------------------------------------------
>   Build with support for the GOOFY framework
>   that provides concurrent whoopsies integrated
>   with a Perubython interpreter, and stuff.
>  -----------------------------------------------
> 
> The description at the bottom is from whatever option is currently highlighted, and changes as the user scrolls through the options.  It would be blank if the entire description could be displayed in the space available above.
> 
> The advantage of this is that it would work with existing ports, and give the ability to use longer descriptions.  The disadvantage is that dialog(1) would probably need modifications.

If we're talking about changing dialog(1), let's make sure there's also an "uncheck all"/"check all" option.

I'm looking at you, ghostscript:

        wc -l /var/db/ports/ghostscript9/options
     315 /var/db/ports/ghostscript9/options

Charles

> _______________________________________________
> freebsd-stable at freebsd.org mailing list
> http://lists.freebsd.org/mailman/listinfo/freebsd-stable
> To unsubscribe, send any mail to "freebsd-stable-unsubscribe at freebsd.org"

--
Charles Sprickman
NetEng/SysAdmin
Bway.net - New York's Best Internet www.bway.net
spork at bway.net - 212.655.9344