From owner-freebsd-ports@FreeBSD.ORG Thu May 31 04:43:10 2012 Return-Path: Delivered-To: ports@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 2EC2B1065670; Thu, 31 May 2012 04:43:10 +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 EA4BC8FC0A; Thu, 31 May 2012 04:43:09 +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 q4V4h9Ps062056; Thu, 31 May 2012 04:43:09 GMT (envelope-from bapt@freebsd.org) Received: (from bapt@localhost) by freefall.freebsd.org (8.14.5/8.14.5/Submit) id q4V4h9pQ062032; Thu, 31 May 2012 04:43:09 GMT (envelope-from bapt@freebsd.org) X-Authentication-Warning: freefall.freebsd.org: bapt set sender to bapt@freebsd.org using -f Date: Thu, 31 May 2012 06:43:07 +0200 From: Baptiste Daroussin To: Warren Block Message-ID: <20120531044306.GH85232@ithaqua.etoilebsd.net> References: <20120530063334.GD9952@ithaqua.etoilebsd.net> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="CNfT9TXqV7nd4cfk" Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.5.21 (2010-09-15) Cc: Alberto Villa , 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 31 May 2012 04:43:10 -0000 --CNfT9TXqV7nd4cfk Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, May 30, 2012 at 05:40:08PM -0600, Warren Block wrote: > On Wed, 30 May 2012, Alberto Villa wrote: >=20 > > On Wed, May 30, 2012 at 8:33 AM, Baptiste Daroussin = wrote: > >> 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. > > > > 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. > > > > 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 > Deja vu: >=20 > http://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/makefil= e-options.html#AEN2598 >=20 > Look at the second tip. That's brand new, added because users were=20 > complaining in the forums recently. (And before, but recently got my=20 > attention.) Thank you!! >=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 > Some of the entries in the KNOBS file could use better descriptions=20 > also. Let's focus on bsd.options.desc.mk descriptions improvements as the KNOBS f= ile will die $soon :) ($soon being undefined yet :) regards, Bapt --CNfT9TXqV7nd4cfk Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.19 (FreeBSD) iEYEARECAAYFAk/G9toACgkQ8kTtMUmk6ExqQwCgkZLUKC2QfCLEAhHsxnyEPK2f 2BwAoKbKf4id0Mer4v0U2SBIKyMCdCli =NUQQ -----END PGP SIGNATURE----- --CNfT9TXqV7nd4cfk--