Date: Wed, 30 May 2012 23:17:10 +0200 From: Baptiste Daroussin <bapt@freebsd.org> To: Alberto Villa <avilla@freebsd.org> Cc: ports@freebsd.org Subject: Re: Options name, descriptions and consistency Message-ID: <20120530211709.GB85232@ithaqua.etoilebsd.net> In-Reply-To: <CAJp7RHY_xXBX%2B5nwAwDBR%2Bk%2Bf_Ho9%2BROVCT-3z54hR0b6dFfbA@mail.gmail.com> References: <20120530063334.GD9952@ithaqua.etoilebsd.net> <CAJp7RHY_xXBX%2B5nwAwDBR%2Bk%2Bf_Ho9%2BROVCT-3z54hR0b6dFfbA@mail.gmail.com>
next in thread | previous in thread | raw e-mail | index | archive | help
--2B/JsCI69OhZNC5r Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, May 30, 2012 at 10:46:44PM +0200, Alberto Villa wrote: > On Wed, May 30, 2012 at 8:33 AM, Baptiste Daroussin <bapt@freebsd.org> wr= ote: > > On of the reasons of bsd.options.desc.mk is to be able to share common = options > > and descriptions, to have better consistency between ports and to have = general > > meaning descriptions that make more sense, has anyone can improve the > > description of an option. >=20 > While I really like what bsd.options.desc.mk is supposed to do, I > would like to recommend to any committer/maintainer (and I will > personally submit a patch for the soon-to-come documentation and for > the file itself) to think before always relying on on default option > descriptions. >=20 > Sometimes just saying "Enable XXX support" doesn't mean anything to > the user, and a more explanatory text would be far better, explaining > maybe what feature one is about to enable instead of just what he is > going to depend on. >=20 > So, please, do not hesitate to redefine option descriptions for your > ports if you feel you can add more information for the port specific > case. > --=20 > Alberto Villa, FreeBSD committer <avilla@FreeBSD.org> > http://people.FreeBSD.org/~avilla 100% agree that is why it is _DESC stuff is made to be overwritten :) /me expected for the documentation patch :D regards, Bapt --2B/JsCI69OhZNC5r Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.19 (FreeBSD) iEYEARECAAYFAk/GjlUACgkQ8kTtMUmk6EzfQACfSR0dZScXulQBiBUee+3ABjtY hmoAn2c03zt62hp6P4bInYE0I5VfkbAC =DDA5 -----END PGP SIGNATURE----- --2B/JsCI69OhZNC5r--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20120530211709.GB85232>