Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 835396 - @ECLASS-VARIABLE should be written with an underscore
Summary: @ECLASS-VARIABLE should be written with an underscore
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Eclasses (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Quality Assurance Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-03-16 07:20 UTC by Ulrich Müller
Modified: 2022-05-09 07:40 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ulrich Müller gentoo-dev 2022-03-16 07:20:11 UTC
Tags @USER_VARIABLE, @OUTPUT_VARIABLE, and a couple more use an underscore, so it should really be spelled @ECLASS_VARIABLE.

Updating eclass-to-manpage.awk and possible other tools (pkgcore?) is trivial. The old variant should be kept for as an alternative for backwards compatibility.
Comment 1 Ulrich Müller gentoo-dev 2022-03-17 05:55:38 UTC
For pkgcore, the relevant code is in src/pkgcore/ebuild/eclass.py:

class EclassVarBlock(ParseEclassDoc):
    """ECLASS-VARIABLE doc block."""

    tag = '@ECLASS-VARIABLE:'
    key = 'variables'
    default = True

    def __init__(self):
        tags = {
            '@ECLASS-VARIABLE:': ('name', True, self._tag_inline_arg, None),
            [...]
        }
        super().__init__(tags)

The obvious solution would be to duplicate that subclass, but maybe something more elegant is possible (are "tag" and "tags" regular expressions?).

There are also some tests in both pkgcore and pkgcheck but update of these is trivial.
Comment 2 Larry the Git Cow gentoo-dev 2022-03-23 14:10:28 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=108416f08c8e241b57c05ab4dbce6212eb2a6d87

commit 108416f08c8e241b57c05ab4dbce6212eb2a6d87
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2022-03-17 11:28:33 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
CommitDate: 2022-03-23 14:06:36 +0000

    eclass-writing: @ECLASS-VARIABLE renamed to @ECLASS_VARIABLE
    
    Bug: https://bugs.gentoo.org/835396
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>

 eclass-writing/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Comment 3 Larry the Git Cow gentoo-dev 2022-03-24 04:01:13 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=d7317785d04e7de172de3bff05852fca3cd15af2

commit d7317785d04e7de172de3bff05852fca3cd15af2
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2022-03-18 20:29:29 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
CommitDate: 2022-03-24 03:58:34 +0000

    *.eclass: @ECLASS-VARIABLE renamed to @ECLASS_VARIABLE
    
    Bug: https://bugs.gentoo.org/835396
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>

 eclass/acct-group.eclass          |  6 +--
 eclass/acct-user.eclass           | 20 ++++-----
 eclass/ada.eclass                 |  4 +-
 eclass/alternatives.eclass        |  4 +-
 eclass/ant-tasks.eclass           | 10 ++---
 eclass/apache-2.eclass            | 10 ++---
 eclass/aspell-dict-r1.eclass      |  6 +--
 eclass/autotools.eclass           | 24 +++++------
 eclass/bzr.eclass                 | 32 +++++++--------
 eclass/cargo.eclass               | 10 ++---
 eclass/cdrom.eclass               |  2 +-
 eclass/check-reqs.eclass          | 12 +++---
 eclass/chromium-2.eclass          |  2 +-
 eclass/cmake-multilib.eclass      |  4 +-
 eclass/cmake-utils.eclass         | 26 ++++++------
 eclass/cmake.eclass               | 22 +++++-----
 eclass/common-lisp-3.eclass       |  8 ++--
 eclass/cuda.eclass                |  4 +-
 eclass/cvs.eclass                 | 36 ++++++++--------
 eclass/depend.apache.eclass       | 26 ++++++------
 eclass/distutils-r1.eclass        | 22 +++++-----
 eclass/docs.eclass                | 12 +++---
 eclass/dotnet.eclass              |  2 +-
 eclass/dune.eclass                |  2 +-
 eclass/ecm.eclass                 | 28 ++++++-------
 eclass/elisp-common.eclass        | 16 ++++----
 eclass/elisp.eclass               | 10 ++---
 eclass/emboss-r2.eclass           |  4 +-
 eclass/emboss-r3.eclass           |  2 +-
 eclass/fcaps.eclass               |  2 +-
 eclass/font.eclass                | 10 ++---
 eclass/fortran-2.eclass           |  6 +--
 eclass/freedict.eclass            |  2 +-
 eclass/git-r3.eclass              | 24 +++++------
 eclass/gkrellm-plugin.eclass      |  6 +--
 eclass/gnome.org.eclass           |  6 +--
 eclass/gnome2-utils.eclass        | 18 ++++----
 eclass/gnome2.eclass              | 12 +++---
 eclass/go-module.eclass           |  8 ++--
 eclass/golang-base.eclass         |  2 +-
 eclass/golang-build.eclass        |  4 +-
 eclass/golang-vcs-snapshot.eclass |  2 +-
 eclass/golang-vcs.eclass          |  8 ++--
 eclass/gstreamer-meson.eclass     | 12 +++---
 eclass/gstreamer.eclass           | 10 ++---
 eclass/haskell-cabal.eclass       | 18 ++++----
 eclass/java-ant-2.eclass          | 18 ++++----
 eclass/java-osgi.eclass           |  2 +-
 eclass/java-pkg-2.eclass          |  2 +-
 eclass/java-pkg-opt-2.eclass      |  2 +-
 eclass/java-pkg-simple.eclass     | 38 ++++++++---------
 eclass/java-utils-2.eclass        | 22 +++++-----
 eclass/java-vm-2.eclass           |  8 ++--
 eclass/kde.org.eclass             | 20 ++++-----
 eclass/kernel-2.eclass            | 86 +++++++++++++++++++--------------------
 eclass/kernel-install.eclass      |  2 +-
 eclass/latex-package.eclass       |  4 +-
 eclass/libretro-core.eclass       |  6 +--
 eclass/linux-info.eclass          | 28 ++++++-------
 eclass/linux-mod.eclass           | 26 ++++++------
 eclass/llvm.eclass                |  4 +-
 eclass/llvm.org.eclass            | 22 +++++-----
 eclass/lua-single.eclass          | 14 +++----
 eclass/lua-utils.eclass           |  8 ++--
 eclass/lua.eclass                 | 14 +++----
 eclass/mate-desktop.org.eclass    |  8 ++--
 eclass/mate.eclass                |  4 +-
 eclass/mercurial.eclass           | 22 +++++-----
 eclass/meson.eclass               |  6 +--
 eclass/mozcoreconf-v5.eclass      |  2 +-
 eclass/mozcoreconf-v6.eclass      |  2 +-
 eclass/mozextension.eclass        |  2 +-
 eclass/mozlinguas-v2.eclass       | 34 ++++++++--------
 eclass/multibuild.eclass          |  8 ++--
 eclass/multilib-build.eclass      | 12 +++---
 eclass/myspell-r2.eclass          |  6 +--
 eclass/ninja-utils.eclass         |  2 +-
 eclass/office-ext-r1.eclass       |  8 ++--
 eclass/opam.eclass                |  4 +-
 eclass/optfeature.eclass          |  6 +--
 eclass/pax-utils.eclass           |  2 +-
 eclass/perl-module.eclass         | 24 +++++------
 eclass/php-ext-pecl-r3.eclass     |  4 +-
 eclass/php-ext-source-r3.eclass   | 24 +++++------
 eclass/php-pear-r2.eclass         | 10 ++---
 eclass/plocale.eclass             |  4 +-
 eclass/postgres-multi.eclass      |  4 +-
 eclass/postgres.eclass            | 12 +++---
 eclass/prefix.eclass              |  2 +-
 eclass/python-any-r1.eclass       | 12 +++---
 eclass/python-r1.eclass           | 16 ++++----
 eclass/python-single-r1.eclass    | 14 +++----
 eclass/python-utils-r1.eclass     | 10 ++---
 eclass/qt5-build.eclass           | 20 ++++-----
 eclass/readme.gentoo-r1.eclass    |  8 ++--
 eclass/rebar.eclass               |  2 +-
 eclass/ros-catkin.eclass          | 20 ++++-----
 eclass/ruby-fakegem.eclass        | 34 ++++++++--------
 eclass/ruby-ng-gnome2.eclass      |  2 +-
 eclass/ruby-ng.eclass             | 10 ++---
 eclass/ruby-single.eclass         |  4 +-
 eclass/ruby-utils.eclass          |  2 +-
 eclass/rust-toolchain.eclass      |  2 +-
 eclass/scons-utils.eclass         | 10 ++---
 eclass/selinux-policy-2.eclass    | 14 +++----
 eclass/ssl-cert.eclass            |  6 +--
 eclass/subversion.eclass          | 30 +++++++-------
 eclass/sword-module.eclass        |  4 +-
 eclass/texlive-module.eclass      | 16 ++++----
 eclass/tmpfiles.eclass            |  2 +-
 eclass/tree-sitter-grammar.eclass |  2 +-
 eclass/unpacker.eclass            |  4 +-
 eclass/vala.eclass                |  6 +--
 eclass/vdr-plugin-2.eclass        | 10 ++---
 eclass/verify-sig.eclass          |  8 ++--
 eclass/vim-spell.eclass           | 10 ++---
 eclass/virtualx.eclass            |  4 +-
 eclass/waf-utils.eclass           |  4 +-
 eclass/webapp.eclass              |  6 +--
 eclass/wxwidgets.eclass           |  2 +-
 eclass/xdg-utils.eclass           |  4 +-
 eclass/xemacs-packages.eclass     |  4 +-
 eclass/xorg-3.eclass              | 18 ++++----
 123 files changed, 687 insertions(+), 687 deletions(-)
Comment 4 Ulrich Müller gentoo-dev 2022-03-24 04:05:01 UTC
All done. Closing.
Comment 5 Larry the Git Cow gentoo-dev 2022-03-25 19:42:12 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/kde.git/commit/?id=6f9549ca8ae59e7c6d38d686ce356f04f91e9318

commit 6f9549ca8ae59e7c6d38d686ce356f04f91e9318
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2022-03-18 20:29:29 +0000
Commit:     Andreas Sturmlechner <asturm@gentoo.org>
CommitDate: 2022-03-25 19:41:41 +0000

    *.eclass: @ECLASS-VARIABLE renamed to @ECLASS_VARIABLE
    
    Bug: https://bugs.gentoo.org/835396
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>
    Signed-off-by: Andreas Sturmlechner <asturm@gentoo.org>

 eclass/cmake.eclass   | 22 +++++++++++-----------
 eclass/ecm.eclass     | 28 ++++++++++++++--------------
 eclass/kde.org.eclass | 20 ++++++++++----------
 3 files changed, 35 insertions(+), 35 deletions(-)
Comment 6 Larry the Git Cow gentoo-dev 2022-03-25 19:46:07 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/qt.git/commit/?id=4777a2c149b3fd6298b6f49ea5591537d62e2bc2

commit 4777a2c149b3fd6298b6f49ea5591537d62e2bc2
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2022-03-18 20:29:29 +0000
Commit:     Andreas Sturmlechner <asturm@gentoo.org>
CommitDate: 2022-03-25 19:45:39 +0000

    *.eclass: @ECLASS-VARIABLE renamed to @ECLASS_VARIABLE
    
    Bug: https://bugs.gentoo.org/835396
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>
    Signed-off-by: Andreas Sturmlechner <asturm@gentoo.org>

 eclass/qt5-build.eclass | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
Comment 7 Ulrich Müller gentoo-dev 2022-05-09 07:40:12 UTC
For the record, using an underscore was first suggested by kentnl here:
https://archives.gentoo.org/gentoo-dev/message/ade67ee188f06c8aa30ba62d4dab4f65