Date: Sat, 17 Sep 2016 10:58:40 -0400 From: Margaret <scratch65535@att.net> To: FreeBSD ports <ports@freebsd.org> Subject: Re: Checking port option descriptions Message-ID: <4bmqtblq0nl3qmcdomq1koa0n7ic3bqk71@4ax.com> In-Reply-To: <11003591.UQgRz8LoQ6@curlew.lan> References: <alpine.BSF.2.20.1609160951090.12548@wonkity.com> <ipqotbtp084uvimbt3o360cusgjgn15msd@4ax.com> <CAN6yY1spzzW7Poj=mkgqmR1=fOHyBuTXPLtB47cPnjaqfv-4kQ@mail.gmail.com> <11003591.UQgRz8LoQ6@curlew.lan>
next in thread | previous in thread | raw e-mail | index | archive | help
[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.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?4bmqtblq0nl3qmcdomq1koa0n7ic3bqk71>