Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 41671 - "Common Ebuild Mistakes"
Summary: "Common Ebuild Mistakes"
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-developer
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All Linux
: High enhancement (vote)
Assignee: Sven Vermeulen (RETIRED)
URL: http://www.gentoo.org/doc/en/ebuild-m...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-02-15 09:11 UTC by Torsten Veller (RETIRED)
Modified: 2004-02-16 11: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 Torsten Veller (RETIRED) gentoo-dev 2004-02-15 09:11:26 UTC
* "Missing/Invalid/Broken Header"

First part doesn't make sense. I think it should be changed to liquidx' guide:
(It's 2004!)

"When you submit your ebuilds, the header should be exactly  the same as the one in /usr/portage/skel.ebuild. Most importantly, do not modify it in anyway and make sure that the "$Header: $" line is intact.

The first three lines must look like this:

# Copyright 1999-2004 Gentoo Technologies, Inc.
# Distributed under the terms of the GNU General Public License v2
# $Header: $"


* Including version numbers in $SRC_URI and $S 

"You should try not to include version numbers in the SRC_URI and $S." 
-> $SRC_URI

BTW: Variables are totally inconsistent:
(with or without $: $P, $PV, $PN, $PF, $SRC_URI, $S ,IUSE, DEPEND, LICENSE, HOMEPAGE, SLOT,... 
with or without {}: ${PV} or ${P}
inside or not of <c> environment).
I think it would be better to change to _one_ way of writing.  


* DEPEND is incomplete 
"...in here. things to look out for ..."
-> T

* Package Updates should have description
-> "Package updates without description of changes"
because all other headlines are described in the negativ way (describe the error).




Reproducible: Always
Steps to Reproduce:
Comment 1 Xavier Neys (RETIRED) gentoo-dev 2004-02-16 02:04:23 UTC
May I add the following issues?

+ One more case of seperate instead of separate
+ Most titles name the problem, some name the right way to do things.
+ Missing <!--$Header$ --> at beginning
+ $Header$ expanded by CVS in the text, specially where we really do not want it to be expanded. Replace trailing $ with &#36; to prevent CVS from expanding.
Comment 2 Sven Vermeulen (RETIRED) gentoo-dev 2004-02-16 11:00:14 UTC
Thanks for reporting the issues. I've committed the fixed version now.