Date: Sat, 17 Sep 2016 09:33:56 -0600 (MDT) From: Warren Block <wblock@wonkity.com> To: Margaret <scratch65535@att.net> Cc: FreeBSD ports <ports@freebsd.org> Subject: Re: Checking port option descriptions Message-ID: <alpine.BSF.2.20.1609170930390.81829@wonkity.com> In-Reply-To: <4bmqtblq0nl3qmcdomq1koa0n7ic3bqk71@4ax.com> References: <alpine.BSF.2.20.1609160951090.12548@wonkity.com> <ipqotbtp084uvimbt3o360cusgjgn15msd@4ax.com> <CAN6yY1spzzW7Poj=mkgqmR1=fOHyBuTXPLtB47cPnjaqfv-4kQ@mail.gmail.com> <11003591.UQgRz8LoQ6@curlew.lan> <4bmqtblq0nl3qmcdomq1koa0n7ic3bqk71@4ax.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, 17 Sep 2016, Margaret wrote: > [Default] On Sat, 17 Sep 2016 09:47:10 +0100, Mike Clarke > <jmc-freebsd2@milibyte.co.uk> 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.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?alpine.BSF.2.20.1609170930390.81829>