Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 833188 - kernel-2.eclass: incomplete eclassdoc (also breaks QA warnings)
Summary: kernel-2.eclass: incomplete eclassdoc (also breaks QA warnings)
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Eclasses (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Kernel Bug Wranglers and Kernel Maintainers
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-02-12 14:20 UTC by Anna Vyalkova
Modified: 2022-02-20 19:00 UTC (History)
2 users (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 Anna Vyalkova 2022-02-12 14:20:07 UTC
detect_version function in kernel-2.eclass sets some variables, such as:
* OKV
* KV
* KV_MAJOR
* KV_MINOR
* KV_PATCH
* KV_EXTRA
* KV_FULL
* EXTRAVERSION
* ...

without describing them in eclassdoc, e.g.:
# @ECLASS-VARIABLE: KV_MAJOR
# @OUTPUT_VARIABLE

This leads to false positive QA warnings.

Reproducible: Always

Steps to Reproduce:
1. cd sys-kernel/rt-sources
2. pkgcheck scan
Actual Results:  
sys-kernel/rt-sources
  UnstableOnly: for arches: [ amd64, arm64 ], all versions are unstable: [ 4.19.225_p101, 5.4.170_p68, 5.10.90_p61-r1, 5.15.19_p29, 5.16.2_p19 ]
  MissingInherits: version 4.19.225_p101: linux-info: missing inherit usage: 'KV_MAJOR', line 17
  MissingInherits: version 5.4.170_p68: linux-info: missing inherit usage: 'KV_MAJOR', line 18
  MissingInherits: version 5.10.90_p61-r1: linux-info: missing inherit usage: 'KV_MAJOR', line 19
  MissingInherits: version 5.15.19_p29: linux-info: missing inherit usage: 'KV_MAJOR', line 18
  MissingInherits: version 5.16.2_p19: linux-info: missing inherit usage: 'KV_MAJOR', line 18

Expected Results:  
sys-kernel/rt-sources
  UnstableOnly: for arches: [ amd64, arm64 ], all versions are unstable: [ 4.19.225_p101, 5.4.170_p68, 5.10.90_p61-r1, 5.15.19_p29, 5.16.2_p19 ]

(no MissingInherits warnings)
Comment 1 Anna Vyalkova 2022-02-12 14:22:59 UTC
Additionally, variables that should not be used in ebuilds can be made "local".
Comment 2 Larry the Git Cow gentoo-dev 2022-02-20 19:00:18 UTC
The bug has been closed via the following commit(s):

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

commit c74c95c92654e67090e1813c4b067d0260bcc238
Author:     Mike Pagano <mpagano@gentoo.org>
AuthorDate: 2022-02-20 18:59:55 +0000
Commit:     Mike Pagano <mpagano@gentoo.org>
CommitDate: 2022-02-20 18:59:55 +0000

    kernel-2.eclass: Document variables, minor style clean-up
    
    Document variables in the eclass, reorder alphabetically.
    Make spacing consistent in comment lines.
    
    Closes: https://bugs.gentoo.org/833188
    
    Signed-off-by: Mike Pagano <mpagano@gentoo.org>

 eclass/kernel-2.eclass | 243 +++++++++++++++++++++++++++++++++----------------
 1 file changed, 163 insertions(+), 80 deletions(-)