public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Michał Górny" <mgorny@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Subject: Re: [gentoo-dev] [PATCH] app-portage/eclass-manpages: @DEFAULT_UNSET -> @DEFAULT-UNSET
Date: Sun, 30 Apr 2017 22:56:26 +0200	[thread overview]
Message-ID: <1493585786.1915.1.camel@gentoo.org> (raw)
In-Reply-To: <20170430060303.7036f085@katipo2.lan>

[-- Attachment #1: Type: text/plain, Size: 1919 bytes --]

On nie, 2017-04-30 at 06:03 +1200, Kent Fredric wrote:
> On Fri, 28 Apr 2017 16:39:45 +0200
> Michał Górny <mgorny@gentoo.org> wrote:
> 
> > Change the unset value tag to '@DEFAULT-UNSET' to ensure consistent
> > use of hyphen/underscore throughout eclassdoc. Before, one tag
> > (@ECLASS-VARIABLE) has used hyphen while also one (@DEFAULT_UNSET)
> > used underscore. Unify them to use the former since @ECLASS-VARIABLE
> > tag is more common (and hyphens do not require holding shift).
> > 
> > Fixing all existing uses is perfectly within our power; however, I
> > think it would be reasonable to delay it and combine with other
> > eclass changes to avoid unnecessary cache regen. The script still
> > allows the old tag name for compatibility.
> 
> I have a counter suggestion:
> 
> 1. Leave @ECLASS-VARIABLE as-is
> 2. Leave @DEFAULT_UNSET as is
> 3. Document that underscores are to be used for all new tags

Don't forget to write a complete policy on what names for ebuild
variables should developers use. And then a policy on making new
policies regarding vocabulary. And maybe document some on preferred
words to be used in mailing list messages.

> 4. Add support for @ECLASS_VARIABLE that works the same as
>    @ECLASS-VARIABLE
> 5. Don't go out of our way to migrate to @ECLASS_VARIABLE, just let it
>    occur over time, particularly in conjunction with other major
>    changes.
> 
> Mostly because @FOO_VARIABLE is suspiciously similar syntax to me as
> other ALL CAPS variables used as ENV tokens in Bash.
> 
> And I can't think of a single instance where I've seen a language with
> a convention that used ALL CAPS terms in conjunctions with hyphens,
> ( and regex with _ are ultimately simpler to reason about than ones
> with - )

From now on I'm not going to listen to any suggestions that do not come
with a patch.

-- 
Best regards,
Michał Górny

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 963 bytes --]

  reply	other threads:[~2017-04-30 20:56 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-28 14:39 [gentoo-dev] [PATCH] app-portage/eclass-manpages: @DEFAULT_UNSET -> @DEFAULT-UNSET Michał Górny
2017-04-29  3:41 ` Ulrich Mueller
2017-04-29  5:57   ` Michał Górny
2017-04-29 17:23     ` Davide Pesavento
2017-04-29 17:40       ` Michał Górny
2017-04-29 18:05         ` Davide Pesavento
2017-04-30 21:01           ` Michał Górny
2017-04-29 18:03 ` Kent Fredric
2017-04-30 20:56   ` Michał Górny [this message]
2017-05-01  7:32     ` Ulrich Mueller
2017-05-01 11:20       ` Michał Górny
2017-05-01 13:12         ` Ulrich Mueller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1493585786.1915.1.camel@gentoo.org \
    --to=mgorny@gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox