Bug 637866

Summary:	ruby-fakegem.eclass: eclassdoc problems
Product:	Gentoo Linux	Reporter:	Michał Górny <mgorny>
Component:	Eclasses	Assignee:	Gentoo Ruby Team <ruby>
Status:	RESOLVED FIXED
Severity:	normal
Priority:	Normal
Version:	unspecified
Hardware:	All
OS:	Linux
Whiteboard:
Package list:		Runtime testing required:	---

Description Michał Górny archtester

2017-11-16 21:46:27 UTC

ruby-fakegem.eclass:
   warning:22: RUBY_FAKEGEM_NAME: unable to extract default variable content: 
   warning:28: RUBY_FAKEGEM_VERSION: unable to extract default variable content: 
   warning:33: RUBY_FAKEGEM_TASK_DOC: unable to extract default variable content: 
   warning:44: RUBY_FAKEGEM_RECIPE_TEST: unable to extract default variable content: 
   warning:50: RUBY_FAKEGEM_TASK_TEST: unable to extract default variable content: 
   warning:59: RUBY_FAKEGEM_RECIPE_DOC: unable to extract default variable content: 
   warning:67: RUBY_FAKEGEM_DOCDIR: unable to extract default variable content: 
   warning:72: RUBY_FAKEGEM_EXTRADOC: unable to extract default variable content: 
   warning:78: RUBY_FAKEGEM_DOC_SOURCES: unable to extract default variable content: 
   warning:83: RUBY_FAKEGEM_BINWRAP: unable to extract default variable content: 
   warning:89: RUBY_FAKEGEM_BINDIR: unable to extract default variable content: 
   warning:94: RUBY_FAKEGEM_REQUIRE_PATHS: unable to extract default variable content: 
   warning:99: RUBY_FAKEGEM_GEMSPEC: unable to extract default variable content: 
   warning:106: RUBY_FAKEGEM_EXTRAINSTALL: unable to extract default variable content:

Comment 1 Hans de Graaff gentoo-dev

2017-11-18 08:05:14 UTC

As far as I can tell all of these variables have a proper default value specified in @DESCRIPTION, in accordance with the documentation in app-portage/eclass-manpages/files/eclass-to-manpage.awk, e.g.

# @ECLASS-VARIABLE: RUBY_FAKEGEM_BINDIR
# @DESCRIPTION:
# Path that contains binaries to be binwrapped. Equivalent to the
# gemspec bindir option.
# RUBY_FAKEGEM_BINDIR="bin"

Is either the code or the documentation of eclass-to-manpage.awk wrong? Or am I missing the point completely?

Comment 2 Michał Górny archtester

2017-11-18 09:24:41 UTC

I've seen the same problem with git-r3.eclass and I don't really know what's exactly wrong. Feel free to ignore it untill someone figures it out.

Comment 3 Hans de Graaff gentoo-dev

2017-11-19 08:23:12 UTC

(In reply to Michał Górny from comment #2)
> I've seen the same problem with git-r3.eclass and I don't really know what's
> exactly wrong. Feel free to ignore it untill someone figures it out.

The documentation seems to suggest that the documented default values are part of the commented documentation, but the script actually expect the real variable to be set there. That makes sense, better to document the actual code rather than a possibly outdated comment.

Comment 4 Larry the Git Cow gentoo-dev

2017-11-19 10:35:02 UTC

The bug has been closed via the following commit(s):

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

commit aff41b810f5b789172a7d18d9928c708014a6eac
Author:     Hans de Graaff <graaff@gentoo.org>
AuthorDate: 2017-11-19 08:20:33 +0000
Commit:     Hans de Graaff <graaff@gentoo.org>
CommitDate: 2017-11-19 10:34:54 +0000

    ruby-fakegem.eclass: Fix eclass doc warnings
    
    Move eclass variable definitions to the right place just behind their
    documentation or declare them as default unset.
    
    Closes: https://bugs.gentoo.org/637866

 eclass/ruby-fakegem.eclass | 40 +++++++++++++++-------------------------
 1 file changed, 15 insertions(+), 25 deletions(-)