From owner-freebsd-ports@FreeBSD.ORG  Wed May 30 21:17:13 2012
Return-Path: <owner-freebsd-ports@FreeBSD.ORG>
Delivered-To: ports@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52])
	by hub.freebsd.org (Postfix) with ESMTP id 4DE4C106564A;
	Wed, 30 May 2012 21:17:13 +0000 (UTC)
	(envelope-from bapt@freebsd.org)
Received: from freefall.freebsd.org (freefall.freebsd.org
	[IPv6:2001:4f8:fff6::28])
	by mx1.freebsd.org (Postfix) with ESMTP id 16F398FC12;
	Wed, 30 May 2012 21:17:13 +0000 (UTC)
Received: from freefall.freebsd.org (localhost [127.0.0.1])
	by freefall.freebsd.org (8.14.5/8.14.5) with ESMTP id q4ULHCTM087784;
	Wed, 30 May 2012 21:17:12 GMT (envelope-from bapt@freebsd.org)
Received: (from bapt@localhost)
	by freefall.freebsd.org (8.14.5/8.14.5/Submit) id q4ULHCSE087783;
	Wed, 30 May 2012 21:17:12 GMT (envelope-from bapt@freebsd.org)
X-Authentication-Warning: freefall.freebsd.org: bapt set sender to
	bapt@freebsd.org using -f
Date: Wed, 30 May 2012 23:17:10 +0200
From: Baptiste Daroussin <bapt@freebsd.org>
To: Alberto Villa <avilla@freebsd.org>
Message-ID: <20120530211709.GB85232@ithaqua.etoilebsd.net>
References: <20120530063334.GD9952@ithaqua.etoilebsd.net>
	<CAJp7RHY_xXBX+5nwAwDBR+k+f_Ho9+ROVCT-3z54hR0b6dFfbA@mail.gmail.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="2B/JsCI69OhZNC5r"
Content-Disposition: inline
In-Reply-To: <CAJp7RHY_xXBX+5nwAwDBR+k+f_Ho9+ROVCT-3z54hR0b6dFfbA@mail.gmail.com>
User-Agent: Mutt/1.5.21 (2010-09-15)
Cc: ports@freebsd.org
Subject: Re: Options name, descriptions and consistency
X-BeenThere: freebsd-ports@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: Porting software to FreeBSD <freebsd-ports.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-ports>,
	<mailto:freebsd-ports-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-ports>
List-Post: <mailto:freebsd-ports@freebsd.org>
List-Help: <mailto:freebsd-ports-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-ports>,
	<mailto:freebsd-ports-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Wed, 30 May 2012 21:17:13 -0000


--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--