From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id CF228139694 for ; Mon, 1 May 2017 21:26:25 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id EF564E0C48; Mon, 1 May 2017 21:26:17 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 974ADE0C38 for ; Mon, 1 May 2017 21:26:17 +0000 (UTC) Received: from katipo2.lan (unknown [203.86.205.69]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: kentnl) by smtp.gentoo.org (Postfix) with ESMTPSA id 1664A33BF43 for ; Mon, 1 May 2017 21:26:15 +0000 (UTC) Date: Tue, 2 May 2017 09:25:52 +1200 From: Kent Fredric To: gentoo-dev@lists.gentoo.org Subject: Re: [gentoo-dev] [PATCH] app-portage/eclass-manpages: Add support for @DEFAULT-ASSUMED Message-ID: <20170502092552.4d2f96bf@katipo2.lan> In-Reply-To: <1493654576.29015.1.camel@gentoo.org> References: <20170430213801.21789-1-kentnl@gentoo.org> <1493654576.29015.1.camel@gentoo.org> Organization: Gentoo X-Mailer: Claws Mail 3.15.0-dirty (GTK+ 2.24.31; x86_64-pc-linux-gnu) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; boundary="Sig_/PtGg2tbkBiBAEPSnM/al9Vm"; protocol="application/pgp-signature" X-Archives-Salt: 710f8230-b042-4b28-947d-90011299671d X-Archives-Hash: c7a1b7deb827c9191c80fbb5dc54f398 --Sig_/PtGg2tbkBiBAEPSnM/al9Vm Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable On Mon, 01 May 2017 18:02:56 +0200 Micha=C5=82 G=C3=B3rny wrote: > In other words, I don't think that: >=20 > DIST_TEST (UNSET -> "do parallel") >=20 > is more readable than: >=20 > DIST_TEST (UNSET) > ... > If unset, "do parallel" is assumed. >=20 > --=20 (This time on list) If I were to take a second approach, producing a map of specific values for a varible and their interpretations, so that the manpage emitter could elegantly turn them into a bullet-pointed list of some description, would that be a worthwhile alternative? DIST_TEST Values: - UNSET same as "do parallel" - "do ..." enable tests - "parallel ..." enable tests and parallelism - "network ..." don't attempt to suppress network tests - "verbose ..." increase test verbosity GENTOO_DEPEND_ON_PERL Values: - UNSET same as "yes" - "yes" depend on perl, including a slot operator for rebui= ld - "noslotop" depend on perl, but without including the slot oper= ator The main objective here for me is to encourage a more clear convention for documenting the purpose of the variable that is consistent across eclasses, that doesn't require full reading of the DESCRIPTION to cherry pick understandings of various isolated parts. ( Mostly, as they're typically not well structured for skim reading ) You may note the value map for DIST_TEST as stated is more-or-less already in place for perl-module.eclass, albeit its just a hand formatted table. I just figure we could do more with this tree-wide if the data was declared up-front, ( like line-wrapping the description side, using styles for the "key" parts, etc, ) But I won't waste time throwing together such an idea if its not likely to be deemed useful. ( I don't even want to think about what the syntax would be to document it atm, ewww ) --Sig_/PtGg2tbkBiBAEPSnM/al9Vm Content-Type: application/pgp-signature Content-Description: OpenPGP digital signature -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEPZazbI/qrFT1o9rn6FQySxNmqCAFAlkHp/EACgkQ6FQySxNm qCADvQ//X6HUgncDwVdYC0PJtYymqyiddBBm3n+0kcBY6wWJBnv2vAydTvm6u6CB xjMnuH5QsAju7ZPCJ+Z/TAxFwAGVtrUY6C/cdHnqDpz+jdyzFb/dRhB6PEthnNOn k4j7bcVYV7YNfP+i/0zucd+vPKIfNmjNy/Umv89q7gRiX3vDLCOPlJr8nk41Vgau DmJD+jArsxmREIjRFeGxCvsnZqaVjXynknMhTyLw/L9uH9RR7g552Vd35n+nkk2j egfYPq/hV6Klr9yBAlt+6BbxuLHUTg3uWytprTS49t/qNdUvjXdOuzcqA7KEvi+l cVIso6Mfl8c6oCvLRg2ppi3NCQDG+RfcDhLX5DMH9ESB7MZ/O6jc1weJw9Gl0g+H u0k8WdJRIpH4Y9CerANjJTz1y+vsZUR+BpIiz2reYGw218nHKAOb7OtWTWU1P78P DPVYuGkXtYPBk4R+kMczdKrOqtWvbhVQli8MeQTMBYk7f30qrLcXqpH4FfO+82Eh cJ+c9WYoiP/2z9S+toZNFNSfzqGHhRZ/E7dW7RYMwSlQjTKbUa0A/WiPiJca5fvE fTotrz5zF9uK2h6h97jvzGlS1ywmIA/ciua5UwNJbS/gpJnf86Hs87tL/DJFb8ZW OTkwaZqEewJo93zcmZVpHin1Sya+ETJ9tJ0B6V9jtGJb00qsc1U= =sMyt -----END PGP SIGNATURE----- --Sig_/PtGg2tbkBiBAEPSnM/al9Vm--