Bug 314999 – devmanual wrong coding style in examples

• Product: Documentation
• Status: RESOLVED FIXED

[Description Kanstantsin Shautsou 2010-04-13 14:31:00 UTC]

http://devmanual.gentoo.org/quickstart/index.html
This page has wrong ordering for LICENSE,SLOT,KEYWORDS,IUSE;missed RDEPEND and inherit.
I think it's bad examples for manual :].

[Comment 1 Kanstantsin Shautsou 2010-04-13 14:32:02 UTC]

Created attachment 227603 [details, diff]
my version of patch

[Comment 2 Samuli Suominen (RETIRED) 2010-04-13 14:38:36 UTC]

Comment on attachment 227603 [details, diff]
my version of patch

No need to inherit eutils, if it's not used by anything. Only inherit eclasses when you need them.

[Comment 3 Kanstantsin Shautsou 2010-04-13 14:52:26 UTC]

Created attachment 227609 [details, diff]
patch for devmanual/quickstart/text.xml

Another version :P

[Comment 4 Samuli Suominen (RETIRED) 2010-04-13 15:04:40 UTC]

Created attachment 227611 [details, diff]
a bit more

There's actually no need to specify RDEPEND, if there's only DEPEND in ebuild it becomes both. Specially since all the examples are EAPI=0.

The other changes looked good though, they are included in this a bit more extensive patch

[Comment 5 Peter Volkov (RETIRED) 2010-04-13 15:43:24 UTC]

(In reply to comment #4)
> There's actually no need to specify RDEPEND, if there's only DEPEND in ebuild
> it becomes both. Specially since all the examples are EAPI=0.

Why? AFAIR currently we have different policy:

http://devmanual.gentoo.org/general-concepts/dependencies/index.html#implicit-system-dependency

Runtime Dependencies
====================

...If this variable is not specified, it defaults to the value of DEPEND, but you should always explicitly define RDEPEND="${DEPEND}" (as in the future this setting is planned to be removed from Portage).

[Comment 6 Samuli Suominen (RETIRED) 2010-04-13 15:51:49 UTC]

(In reply to comment #5)
> (In reply to comment #4)
> > There's actually no need to specify RDEPEND, if there's only DEPEND in ebuild
> > it becomes both. Specially since all the examples are EAPI=0.
> 
> Why? AFAIR currently we have different policy:
> 
[ .. ]
> ...If this variable is not specified, it defaults to the value of DEPEND, but
> you should always explicitly define RDEPEND="${DEPEND}" (as in the future this
> setting is planned to be removed from Portage).

Not sure how that slipped in there, very pointless.  Should likely patch it out.  Such change will include EAPI bump, and can be dealt with the bump as normal. Ideally repoman should bail out of if EAPI= is equal-or-higher-than <value> and RDEPEND is absent. As it stands now, there's no technical need to set RDEPEND="${DEPEND}" and as such it should be kept out of any examples.

[Comment 7 Peter Volkov (RETIRED) 2010-04-13 16:14:04 UTC]

(In reply to comment #6)
> Not sure how that slipped in there, very pointless.  Should likely patch it
> out.

Last time it was discussed on -dev it was suggested differently and repoman check was created:

http://archives.gentoo.org/gentoo-dev/msg_1c3b47875b87c9d0a2c93baf98698047.xml

I'm not sure what changed since then...

[Comment 8 Mark Loeser (RETIRED) 2010-04-13 19:57:27 UTC]

Added the patch, thanks guys.  Please open another bug to clean up the inconsistencies that this may have made with a patch, or I'll get to it sometime later this week. (the implicit rdepend issue specifically)

[Comment 9 Peter Volkov (RETIRED) 2010-04-14 13:12:45 UTC]

Mark I've reopened bug 285191. I don't have any strong opinion on this issue, all I want is consistency. Thanks.