Date: Sat, 9 Jun 2012 23:02:55 -0600 (MDT) From: Warren Block <wblock@wonkity.com> To: Doug Barton <dougb@freebsd.org> Cc: Dave Hayes <dave@jetcafe.org>, FreeBSD ports list <freebsd-ports@freebsd.org> Subject: Re: Documenting 'make config' options Message-ID: <alpine.BSF.2.00.1206092238420.72835@wonkity.com> In-Reply-To: <alpine.BSF.2.00.1206091902210.71605@wonkity.com> References: <CAOgwaMvsv3e1TxDauV038Pp7LRiYeH7oAODE%2Bw-pxHt9oGrXMA@mail.gmail.com> <201206020012.q520CEcf057568@hugeraid.jetcafe.org> <20120602004230.GA14487@in-addr.com> <201206040224.q542OBqk085897@hugeraid.jetcafe.org> <20120604043233.GB32597@lonesome.com> <201206040841.q548fVHa091169@hugeraid.jetcafe.org> <CADLo83-9jE1zAtdXrA78=K5AE7yR4UsMh=efeC5L4kXijaDFaQ@mail.gmail.com> <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> <201206070527.q575R1sX052893@hugeraid.jetcafe.org> <4FD37B40.2030500@FreeBSD.org> <alpine.BSF.2.00.1206091850110.71605@wonkity.com> <4FD3F149.10602@FreeBSD.org> <alpine.BSF.2.00.1206091902210.71605@wonkity.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, 9 Jun 2012, Warren Block wrote: > On Sat, 9 Jun 2012, Doug Barton wrote: > >> On 06/09/2012 17:54, Warren Block wrote: >>> On Sat, 9 Jun 2012, Doug Barton wrote: >>> >>>> On 06/06/2012 22:27, Dave Hayes wrote: >>>>> Personally, a 'pkg-options-descr' text file would suit me just fine. >>>> >>>> For those on -ports, the context is, "How do we provide more information >>>> about what the various options mean?" This idea seems reasonable to me, >>>> what do others think? >>> >>> The user needs to know what the options mean when they appear, and >>> having to go look them up in another file is just another hassle. >>> Difficult to do in some situations, too. Better to show them when the >>> user scrolls to that option. Here's what I suggested in -stable: >>> http://lists.freebsd.org/pipermail/freebsd-stable/2012-June/068187.html >>> >>> No new files, only one copy of the descriptions so they don't get out of >>> sync. >> >> That's a nice idea, how do you make it work with dialog? > > No idea, this is still the design phase. :) Actually, a message I now can't > find suggested that dialog may be able to do it unchanged. Followup: dialog --item-help \ --checklist "Contrived options description example" 21 70 15 \ "ABC" "Enable ABC encapsulation of convoluted insoluble ..." "on" \ "variations when the complementary quantum reversal feature is undesirable" \ "DOCS" "Build and install documentation" "on" "" \ "XYZ" "Enabling XYZ sets compiler go-fast stripes, defeats ...," "off" \ "all safeguards, and begins a wholesale, awesome, breathtaking data mangling" \ "NLS" "Native Language Support via gettext utilities" "on" "" Now some code is needed to break descriptions too long to fit in the standard option box (preferably on spaces), right-justify "..." or maybe "+" at the end to show the line is continued, and integrate that with bsd.port.mk.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?alpine.BSF.2.00.1206092238420.72835>