* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2011-03-09 16:42 Jeremy Olexa
0 siblings, 0 replies; 46+ messages in thread
From: Jeremy Olexa @ 2011-03-09 16:42 UTC (permalink / raw
To: gentoo-commits
commit: 4d025023b322d0f82f49143a3164a3d0c176485d
Author: Jeremy Olexa <darkside <AT> gentoo <DOT> org>
AuthorDate: Wed Mar 9 16:37:45 2011 +0000
Commit: Jeremy Olexa <darkside <AT> gentoo <DOT> org>
CommitDate: Wed Mar 9 16:37:45 2011 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=4d025023
common-mistakes: Add section about ROOT
Patch by Thilo Bangert, bug 258125
---
ebuild-writing/common-mistakes/text.xml | 16 ++++++++++++++++
1 files changed, 16 insertions(+), 0 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 8fda324..d2f5fcf 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -21,6 +21,22 @@ the dynamic and static libraries.
</section>
<section>
+<title>Invalid use of <c>ROOT</c></title>
+<body>
+<p>
+The usage of <c>ROOT</c> is only designed to influence the way the package is
+installed (ie. into <c>ROOT</c>) - building and compiling should not depend on
+<c>ROOT</c>. As a consequence of this the usage of <c>ROOT</c> in <c>src_*</c>
+functions is not allowed.
+</p>
+
+<p>
+See also <uri link="::ebuild-writing/variables#ROOT"/>.
+</p>
+</body>
+</section>
+
+<section>
<title>Referencing the full path to documentation files that could be
compressed</title>
<body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2012-08-08 19:20 Markos Chandras
0 siblings, 0 replies; 46+ messages in thread
From: Markos Chandras @ 2012-08-08 19:20 UTC (permalink / raw
To: gentoo-commits
commit: a3ac99ece5056880cb0ad1a64ef39d59b574af7d
Author: Julian Ospald <hasufell <AT> gentoo <DOT> org>
AuthorDate: Sat Aug 4 00:33:15 2012 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Wed Aug 8 19:20:04 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=a3ac99ec
devmanual
document necessity to force all build logs verbose
---
ebuild-writing/common-mistakes/text.xml | 31 +++++++++++++++++++++++++++++++
1 files changed, 31 insertions(+), 0 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index d2f5fcf..fb4f0d2 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -57,6 +57,37 @@ elog "They are listed in the INSTALL file in /usr/share/doc/${PF}"
</body>
</section>
+<section>
+<title>Build log not verbose</title>
+<body>
+When writing ebuilds, you should always check the build log, because the build
+system might ignore CC/CXX/LD/CFLAGS/LDFLAGS and such or add undesired flags
+by default. In order to analyze this and have complete information, in case
+someone reports a bug for your package, the <b>build log must always be verbose.</b>
+<p>
+There are several ways to fix non-verbose build logs depending on the build system:
+</p>
+<p>
+For <c>cmake</c> based build systems it should be sufficient that the ebuild calls
+cmake-utils_src_compile which picks up the cmake-utils.eclass variable 'CMAKE_VERBOSE=1'
+by default. If you call emake directly for whatever reason, you can do 'emake VERBOSE=1'
+(note that cmake-utils_src_compile takes arguments as well which are passed to make).
+</p>
+
+<p>
+For <c>autotools</c> based build systems you can pass '--disable-silent-rules' to econf
+until a new EAPI does that automatically. 'emake V=1' should also work.
+</p>
+
+<p>
+For custom Makefiles you often have to write a patch. Try to get upstream to include an
+option like 'V=1' to enable full verbosity.
+</p>
+<note> If you notice non-verbose build log in any package open a bug and make it block the
+tracker bug #429308</note>
+</body>
+</section>
+
</chapter>
</guide>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2012-11-07 13:25 Michael Palimaka
0 siblings, 0 replies; 46+ messages in thread
From: Michael Palimaka @ 2012-11-07 13:25 UTC (permalink / raw
To: gentoo-commits
commit: 431701fc66d9b9cc0619400df1ec1f89f21d2eb1
Author: Michael Palimaka <kensington <AT> gentoo <DOT> org>
AuthorDate: Wed Nov 7 13:20:12 2012 +0000
Commit: Michael Palimaka <kensington <AT> gentoo <DOT> org>
CommitDate: Wed Nov 7 13:21:26 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=431701fc
bug #394863: update policy wrt USE="static-libs".
---
ebuild-writing/common-mistakes/text.xml | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index fb4f0d2..f2cef2c 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -75,8 +75,8 @@ by default. If you call emake directly for whatever reason, you can do 'emake VE
</p>
<p>
-For <c>autotools</c> based build systems you can pass '--disable-silent-rules' to econf
-until a new EAPI does that automatically. 'emake V=1' should also work.
+For <c>autotools</c> based build systems you can pass '--disable-silent-rules' to econf,
+or use EAPI 5 where that argument is passed automatically. 'emake V=1' should also work.
</p>
<p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2012-11-07 13:27 Michael Palimaka
0 siblings, 0 replies; 46+ messages in thread
From: Michael Palimaka @ 2012-11-07 13:27 UTC (permalink / raw
To: gentoo-commits
commit: 1a5c2ec04c467fdb32a4d916ce7850bb7e791614
Author: Michael Palimaka <kensington <AT> gentoo <DOT> org>
AuthorDate: Wed Nov 7 13:24:15 2012 +0000
Commit: Michael Palimaka <kensington <AT> gentoo <DOT> org>
CommitDate: Wed Nov 7 13:25:17 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=1a5c2ec0
bug #394863: revert previous commit and apply the correct patch.
---
ebuild-writing/common-mistakes/text.xml | 9 ++++-----
1 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index f2cef2c..3a4d1e9 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -14,9 +14,8 @@ writing ebuilds.
<title>Invalid use of <c>static</c> use-flag</title>
<body>
The <c>static</c> use-flag should only be used to make a binary use static
-linking instead of dynamic linking. It should not be used to make a library
-install static libraries. The package should always (if possible) install both
-the dynamic and static libraries.
+linking instead of dynamic linking. It should not be used to make a library
+install static libraries. Instead, the <c>static-libs</c> use-flag is used for this.
</body>
</section>
@@ -75,8 +74,8 @@ by default. If you call emake directly for whatever reason, you can do 'emake VE
</p>
<p>
-For <c>autotools</c> based build systems you can pass '--disable-silent-rules' to econf,
-or use EAPI 5 where that argument is passed automatically. 'emake V=1' should also work.
+For <c>autotools</c> based build systems you can pass '--disable-silent-rules' to econf
+until a new EAPI does that automatically. 'emake V=1' should also work.
</p>
<p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2012-11-11 19:33 Markos Chandras
0 siblings, 0 replies; 46+ messages in thread
From: Markos Chandras @ 2012-11-11 19:33 UTC (permalink / raw
To: gentoo-commits
commit: bbfe8ec744931b552a1cfe2538a0fef7b5c47b46
Author: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
AuthorDate: Sat Nov 3 21:55:48 2012 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sun Nov 11 19:32:24 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=bbfe8ec7
common-mistakes: Add more 'common-mistakes' from the devrel handbook
---
ebuild-writing/common-mistakes/text.xml | 376 ++++++++++++++++++++++++++++++-
1 files changed, 370 insertions(+), 6 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 3a4d1e9..cc15e34 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -11,15 +11,19 @@ writing ebuilds.
</body>
<section>
+<title>Common Ebuild Writing Mistakes</title>
+<body>
+
+<subsection>
<title>Invalid use of <c>static</c> use-flag</title>
<body>
The <c>static</c> use-flag should only be used to make a binary use static
linking instead of dynamic linking. It should not be used to make a library
install static libraries. Instead, the <c>static-libs</c> use-flag is used for this.
</body>
-</section>
+</subsection>
-<section>
+<subsection>
<title>Invalid use of <c>ROOT</c></title>
<body>
<p>
@@ -33,9 +37,9 @@ functions is not allowed.
See also <uri link="::ebuild-writing/variables#ROOT"/>.
</p>
</body>
-</section>
+</subsection>
-<section>
+<subsection>
<title>Referencing the full path to documentation files that could be
compressed</title>
<body>
@@ -54,9 +58,9 @@ Do something like:
elog "They are listed in the INSTALL file in /usr/share/doc/${PF}"
</codesample>
</body>
-</section>
+</subsection>
-<section>
+<subsection>
<title>Build log not verbose</title>
<body>
When writing ebuilds, you should always check the build log, because the build
@@ -85,6 +89,366 @@ option like 'V=1' to enable full verbosity.
<note> If you notice non-verbose build log in any package open a bug and make it block the
tracker bug #429308</note>
</body>
+</subsection>
+
+<subsection>
+<title>Missing/Invalid/Broken Header</title>
+<body>
+
+<p>
+When you submit your ebuilds, the header should be <e>exactly</e> the same as
+the one in <path>/usr/portage/skel.ebuild</path>. Most importantly, do not
+modify it in any way and make sure that the <c>$Header: $</c> line is
+intact.
+</p>
+
+<p>
+The first three lines <e>must</e> look like this:
+</p>
+
+<pre caption="Valid Header">
+# Copyright 1999-2004 Gentoo Foundation
+# Distributed under the terms of the GNU General Public License v2
+# $Header: $
+</pre>
+
+<p>
+Only if you are submitting a patched or version bumped ebuild, should you not
+need to modify the <c>$Header: $</c> line. But the line must be present.
+When we check the ebuild into CVS, it will modify that header with the
+appropriate version and date information. So there is no need for you to
+manually modify it.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>IUSE Missing</title>
+<body>
+
+<p>
+By far the most common omission is the IUSE variable. You must (according to the
+<uri link="::ebuild-writing/variables#iuse">Ebuild Writing tutorial</uri>) include the IUSE
+variable even if there are no USE flags in use. If there are no USE flags
+supported, then just add the following:
+</p>
+
+<pre caption="Empty IUSE">
+IUSE=""
+</pre>
+
+</body>
+</subsection>
+<subsection>
+<title>Redefined P, PV, PN, PF</title>
+<body>
+
+<p>
+You should never redefine those variables. Always use MY_P, MY_PN, MY_PV,
+P0, etc. See other ebuilds that do it in portage for more information. Most
+ebuilds use bash "Parameter Expansion". Please read the man page for bash to
+understand how "Parameter Expansion" works.
+</p>
+
+<p>
+By the way, if you find a package that re-defines it, don't copy it. Submit a
+bug about that ebuild.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Including version numbers in SRC_URI and S</title>
+<body>
+
+<p>
+You should try not to include version numbers in the SRC_URI and S. Always try
+to use ${PV} or ${P}. It makes maintaining the ebuild much easier. If a version
+number is not consistent with the tarball/source, then use MY_P. An example
+dev-python/pyopenal fetches a tarball called PyOpenAL, so we redefine it like:
+</p>
+
+<pre caption="Example versioning redefinition">
+MY_P=${P/pyopenal/PyOpenAL}
+SRC_URI="http://oomadness.tuxfamily.org/downloads/${MY_P}.tar.gz"
+S=${WORKDIR}/${MY_P}
+</pre>
+
+</body>
+</subsection>
+<subsection>
+<title>DEPEND has syntactical errors</title>
+<body>
+
+<p>
+There are many things that go wrong with user submitted DEPEND and RDEPEND
+fields. Here are some important points to follow when you write the dependency
+part.
+</p>
+
+<ul>
+ <li>
+ <e>Always include the CATEGORY.</e><br />
+ For example, use <c>>=x11-libs/gtk+-2</c> and not <c>>=gtk+-2</c>.
+ </li>
+ <li>
+ <e>Do not put an asterisk (*) for >= dependencies.</e><br />
+ For example, it should be <c>>=x11-libs/gtk+-2</c> rather than
+ <c>>=x11-libs/gtk+-2*</c>.
+ </li>
+ <li><e>GTK specific. Always use =x11-libs/gtk+-1.2* for GTK+1 apps.</e></li>
+ <li>
+ <e>Never depend on a meta package.</e><br />
+ So don't depend on gnome-base/gnome, always depend on the specific
+ libraries like libgnome.
+ </li>
+ <li>
+ <e>One dependency per line.</e><br />
+ Don't put multiple dependency on the same line. It makes it ugly to read
+ and hard to follow.
+ </li>
+</ul>
+
+</body>
+</subsection>
+<subsection>
+<title>DEPEND is incomplete</title>
+<body>
+
+<p>
+This is another very common error. The ebuild submitter submits an ebuild
+that "just works" without checking if the dependencies are correct. Here are
+some tips on how to find the correct dependencies.
+</p>
+
+<ul>
+ <li>
+ <e>Look in configure.in or configure.ac</e><br />
+ Look for checks for packages in here. Things to look out for are pkg-config
+ checks or AM_* functions that check for a specific version.
+ </li>
+ <li>
+ <e>Look at included .spec files</e><br />
+ A good indication of dependencies is to look at the included .spec files
+ for relevant deps. However, do not trust them to be the definitive complete
+ list of dependencies
+ </li>
+ <li>
+ <e>Look at the application/library website</e><br />
+ Check the application website for possible dependencies that they suggest
+ are needed.
+ </li>
+ <li>
+ <e>Read the README and INSTALL for the package</e><br />
+ They usually also contain useful information about building and installing
+ packages.
+ </li>
+ <li>
+ <e>Remember non-binary dependencies such as pkg-config, doc generation
+ programs, etc.</e><br />
+ Usually the build process requires some dependencies such as intltool,
+ libtool, pkg-config, doxygen, scrollkeeper, gtk-doc, etc. Make sure those
+ are clearly stated.
+ </li>
+</ul>
+
+</body>
+</subsection>
+<subsection>
+<title>LICENSE Invalid</title>
+<body>
+
+<p>
+Another common mistake users make when submitting ebuilds is supplying an
+invalid license. For example, <c>GPL</c> is not a valid license. You need to
+specify <c>GPL-1</c> or <c>GPL-2</c>. Same with <c>LGPL</c>. Make sure the
+license you use in the <c>LICENSE</c> field is something that exists in
+<path>/usr/portage/licenses</path>. As a tip, check the <path>COPYING</path>
+in a source tarball for the license. If a package does not specify it
+uses <c>GPL-1</c> or <c>GPL-2</c>, it is very likely it uses <c>GPL-2</c>.
+</p>
+
+<p>
+If the license for the package you submit is unique and not in
+<path>/usr/portage/licenses/</path>, then you must submit the new license in a
+separate file.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Untested ARCHs in KEYWORDS</title>
+<body>
+
+<p>
+Please do not add other ARCHs into KEYWORDS unless the ebuild has been tested on
+that ARCH. Also all new ebuilds should be ~x86 or whatever architecture it is.
+Make sure when you bump a version, the stable KEYWORDS are all marked as
+<c>~</c>.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>SLOT missing</title>
+<body>
+
+<p>
+Make sure you have the SLOT variable in the ebuild. If you don't plan to use it,
+don't remove it. Put in:
+</p>
+
+<pre caption="Default SLOT variable">
+SLOT="0"
+</pre>
+
+</body>
+</subsection>
+<subsection>
+<title>DESCRIPTION and HOMEPAGE wrong</title>
+<body>
+
+<p>
+Please check if the HOMEPAGE variable is right and leads users to the right
+page if they want to find out more about the package. And make sure the
+DESCRIPTION is not overly long. Good descriptions will describe the main
+function of the package in a sentence.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Wrongfully used spaces instead of TABS</title>
+<body>
+
+<p>
+It is no fun reformatting lines of ebuilds because the submitter did not follow
+the guidelines to use TABS rather than spaces. So <e>please</e> use tabs!
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Trailing whitespace</title>
+<body>
+
+<p>
+I'm often guilty of this. Remember to run repoman over your ebuilds so it can
+tell you if there is trailing whitespace at the end of lines or on empty lines.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Adding redundant S=${WORKDIR}/${P}</title>
+<body>
+
+<p>
+If <c>S=${WORKDIR}/${P}</c>, then you should not add it to your ebuild. This is
+implied already, you should only add it if it is something other than
+<c>${WORKDIR}/${P}</c>.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Documentation missing</title>
+<body>
+
+<p>
+If your package has documentation, make sure you install it using <c>dodoc</c>
+or in <path>/usr/share/doc/${PF}</path>. Remember to check for errors when
+running <c>dodoc</c>/<c>doins</c>.
+</p>
+
+</body>
+</subsection>
+
+</body>
+</section>
+
+
+<section>
+<title>Common Ebuild Submission Mistakes</title>
+<subsection>
+<title>Introduction</title>
+<body>
+
+<p>
+Please submit ebuilds properly by following the <uri
+link="::ebuild-writing/ebuild-maintenance#adding-a-new-ebuild">Adding new Ebuild</uri> tutorial.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Tarball'ing an ebuild</title>
+<body>
+
+<p>
+Please please please do not attach ebuilds as tarballs. Attach patches
+separately as well so we can easily examine them.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Inlining Ebuilds</title>
+<body>
+
+<p>
+Don't cut and paste an ebuild into bugzilla's comment field.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>No description on what the package is</title>
+<body>
+
+<p>
+Please let us know what the package is, and fill in the URL with the home page
+of the application, if any exists.
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Package updates without changing the ChangeLog</title>
+<body>
+
+<p>
+If you submit a package update, then make sure you explain what changes you made
+to the ebuild. For example if a package introduces a new features/option and you
+use a USE flag, list it in your bug. Don't make us hunt for it.
+</p>
+
+<p>
+It is wise to submit a diff for a package update rather than the whole ebuild.
+The best way to generate it would be:
+</p>
+
+<pre caption="Creating a diff">
+$ <i>diff -u some-package-0.1.0.ebuild some-package-0.2.0.ebuild > ~/some-package-0.2.0.diff</i>
+</pre>
+
+</body>
+</subsection>
+<subsection>
+<title>Submitting unchanged ebuilds for version bumps</title>
+<body>
+
+<p>
+If you are submitting a new version for a package in portage, make sure the
+existing ebuild works and make sure changes are incorporated in the new ebuild
+(such as added documentation.) If there are no required changes to the ebuild
+from the previous version, then don't attach the ebuild. Just say so in the bug
+report that you copied the ebuild over and verified that the package works and
+installs properly.
+</p>
+
+</body>
+</subsection>
</section>
</chapter>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2012-11-17 19:00 Markos Chandras
0 siblings, 0 replies; 46+ messages in thread
From: Markos Chandras @ 2012-11-17 19:00 UTC (permalink / raw
To: gentoo-commits
commit: 3f814bfe506038ff41d8e12d2afdbedb6b2a3e66
Author: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
AuthorDate: Sat Nov 17 19:00:23 2012 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sat Nov 17 19:00:23 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=3f814bfe
common-mistakes: Add note about EAPI5 and --disable-silent-rules
Thanks to Michael Palimaka (kensington). Bug #438338
---
ebuild-writing/common-mistakes/text.xml | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index cc15e34..5443a98 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -78,8 +78,8 @@ by default. If you call emake directly for whatever reason, you can do 'emake VE
</p>
<p>
-For <c>autotools</c> based build systems you can pass '--disable-silent-rules' to econf
-until a new EAPI does that automatically. 'emake V=1' should also work.
+For <c>autotools</c> based build systems you can pass '--disable-silent-rules' to econf,
+or use EAPI 5 where that argument is passed automatically. 'emake V=1' should also work.
</p>
<p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2012-11-23 18:02 Julian Ospald
0 siblings, 0 replies; 46+ messages in thread
From: Julian Ospald @ 2012-11-23 18:02 UTC (permalink / raw
To: gentoo-commits
commit: b373edb4fbb2f619b0f153985a9e1b5d8c8f3220
Author: hasufell <julian.ospald <AT> googlemail <DOT> com>
AuthorDate: Fri Nov 23 18:02:37 2012 +0000
Commit: Julian Ospald <julian.ospald <AT> googlemail <DOT> com>
CommitDate: Fri Nov 23 18:02:37 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=b373edb4
clarify verbose-build log part of common mistakes
people should not randomly report bugs if the affected package
uses a build system controllable by portage or an eclass
wrt bug #444354
---
ebuild-writing/common-mistakes/text.xml | 6 ++++--
1 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 5443a98..fbe9a0a 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -86,8 +86,10 @@ or use EAPI 5 where that argument is passed automatically. 'emake V=1' should al
For custom Makefiles you often have to write a patch. Try to get upstream to include an
option like 'V=1' to enable full verbosity.
</p>
-<note> If you notice non-verbose build log in any package open a bug and make it block the
-tracker bug #429308</note>
+<note>In case you encounter an affected package which uses a build system not
+controllable by portage or eclasses you should file a bug (preferably with a patch)
+and make it block the tracker bug #429308. Solutions above ebuild level are
+preferred.</note>
</body>
</subsection>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2012-12-04 19:26 Julian Ospald
0 siblings, 0 replies; 46+ messages in thread
From: Julian Ospald @ 2012-12-04 19:26 UTC (permalink / raw
To: gentoo-commits
commit: b0a519807f82c2190129dfa662922c8b061eb368
Author: hasufell <julian.ospald <AT> googlemail <DOT> com>
AuthorDate: Tue Dec 4 19:26:22 2012 +0000
Commit: Julian Ospald <julian.ospald <AT> googlemail <DOT> com>
CommitDate: Tue Dec 4 19:26:22 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=b0a51980
add "Pkgconfig files" section wrt #445130
related discussion [RFC: new eclass - pkgconfig.eclass] at -dev ML
---
ebuild-writing/common-mistakes/text.xml | 17 +++++++++++++++++
1 files changed, 17 insertions(+), 0 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 6855cf2..b486a7e 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -349,6 +349,23 @@ running <c>dodoc</c>/<c>doins</c>.
</body>
</subsection>
+<subsection>
+<title>Pkgconfig files</title>
+<body>
+
+<p>
+Pkgconfig files (foo.pc) are common interfaces to standardize access to libraries
+across distros. It is important that these are never modified, created or renamed
+anywhere except upstream. Report bugs, write patches and send them upstream, but
+don't mess with them in your ebuild unless it's a trivial (like adding libsuffix)
+or unavoidable fix (which should be discussed with other devs first).</p>
+<p>
+Ignoring this policy can result in breakage for other distros and also breaks
+the purpose of this interface, because it is not reliable anymore.
+</p>
+</body>
+</subsection>
+
</body>
</section>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2012-12-30 14:21 Julian Ospald
0 siblings, 0 replies; 46+ messages in thread
From: Julian Ospald @ 2012-12-30 14:21 UTC (permalink / raw
To: gentoo-commits
commit: dab546b74d223852bf2d6bec3ad9918d353c9859
Author: hasufell <julian.ospald <AT> googlemail <DOT> com>
AuthorDate: Sun Dec 30 14:21:03 2012 +0000
Commit: Julian Ospald <julian.ospald <AT> googlemail <DOT> com>
CommitDate: Sun Dec 30 14:21:03 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=dab546b7
document handling of -Werror wrt #415979
---
ebuild-writing/common-mistakes/text.xml | 50 +++++++++++++++++++++++++++++++
1 files changed, 50 insertions(+), 0 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index b486a7e..549cb00 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -94,6 +94,56 @@ preferred.</note>
</subsection>
<subsection>
+<title>-Werror compiler flag not removed</title>
+<body>
+"-Werror" is a flag which turns all warnings into errors and thus will abort compiling if any warning is encountered.
+
+<p><b>Rationale</b><p />
+This flag is not recommended for releases and should always be disabled when encountered in build-logs, because there are numerous cases where this breaks without purpose, e.g.:
+<ul>
+ <li>
+ new warnings on version bumps of GCC/GLIBC the developer was not aware of at the point of coding
+ </li>
+ <li>
+ some autoconf checks will fail badly
+ </li>
+ <li>
+ libraries adding deprecated API warnings although that API is still working/supported
+ </li>
+ <li>
+ on less known architectures we may get different/more warnings than on common ones
+ </li>
+ <li>
+ random breakage depending on what distro/architecture/library version/kernel/userland the developer was testing "-Werror" on
+ </li>
+</ul>
+Turning off "-Werror" we will still see the warnings, but there is no reason that they cause compile failure. Also note that portage already emits QA notices about gcc warnings that can cause runtime breakage.
+</p>
+
+<p><b>How to fix</b><p />
+To fix the affected build system you should try the following methods:
+<ul>
+ <li>
+ remove the compiler flag from the build system, <e>e.g. Makefile.am or configure.ac</e> or even provide a switch (for autotools based build systems that could be "--disable-werror", which is good for sending a patch upstream)
+ </li>
+ <li>
+ use <e>append-flags -Wno-error</e> (needs flag-o-matic.eclass); for this to work the environment flags have to be respected and placed after build system flags; this method is not preferred as it will disable all "-Werror=specific-warning" flags as well, see next section
+ </li>
+</ul>
+Always check that it's really gone in the build log.
+</p>
+
+<p><b>Specific -Werror=... flags</b><p />
+GCC can turn any specific warning into an error. A specific -Werror flag would be "-Werror=implicit-function-declaration" for example and will only affect warnings about implicit function declarations. It's mostly safe to leave these untouched, cause they are pinned to this issue and should not cause random build time breakage. Also, we can expect that upstream did this on purpose to avoid known runtime errors and not just for testing their builds. However you should check the specified warnings yourself or ask other developers if unsure.
+</p>
+
+<p><b>Exceptions</b><p />
+Removing "-Werror" from configure.ac can cause breakage in very rare cases where the configure phase relies on the exit code. See <uri link="http://sourceforge.net/tracker/?func=detail&aid=2959749&group_id=204462&atid=989708">app-emulation/open-vm-tools bug</uri>. But even then we remove it from the resulting Makefile.
+</p>
+</body>
+</subsection>
+
+<subsection>
<title>Missing/Invalid/Broken Header</title>
<body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2013-09-28 12:19 Markos Chandras
0 siblings, 0 replies; 46+ messages in thread
From: Markos Chandras @ 2013-09-28 12:19 UTC (permalink / raw
To: gentoo-commits
commit: 4eb1dc77d0de1e3902ff5887fddc93129bc4d3e4
Author: Julian Ospald <hasufell <AT> gentoo <DOT> org>
AuthorDate: Sat Sep 28 10:41:13 2013 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sat Sep 28 12:17:37 2013 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=4eb1dc77
common-mistakes: add 'Masking unsupported/broken useflags' section
Bug #483388
---
ebuild-writing/common-mistakes/text.xml | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 549cb00..3663eea 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -416,6 +416,19 @@ the purpose of this interface, because it is not reliable anymore.
</body>
</subsection>
+<subsection>
+<title>Masking unsupported/broken USE flags</title>
+<body>
+<p>
+Exceptionally, a package may have an unsupported/broken USE flag
+(this can happen with <e>vanilla</e> or <e>custom-cflags</e>).
+Then the USE flag must be masked for that ebuild
+(usually in <e>profiles/base/package.use.mask</e>),
+at least when the ebuild hits the stable branch.
+</p>
+</body>
+</subsection>
+
</body>
</section>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2014-05-13 19:32 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2014-05-13 19:32 UTC (permalink / raw
To: gentoo-commits
commit: 41e625daa4be537f934ba50276a97c97b7f3fd85
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue May 13 19:30:44 2014 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue May 13 19:30:44 2014 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=41e625da
Revert "add "Pkgconfig files" section wrt #445130"
This reverts commit b0a519807f82c2190129dfa662922c8b061eb368.
Per 2014-05-13 council decision.
Conflicts:
ebuild-writing/common-mistakes/text.xml
---
ebuild-writing/common-mistakes/text.xml | 17 -----------------
1 file changed, 17 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 3663eea..db851a2 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -400,23 +400,6 @@ running <c>dodoc</c>/<c>doins</c>.
</subsection>
<subsection>
-<title>Pkgconfig files</title>
-<body>
-
-<p>
-Pkgconfig files (foo.pc) are common interfaces to standardize access to libraries
-across distros. It is important that these are never modified, created or renamed
-anywhere except upstream. Report bugs, write patches and send them upstream, but
-don't mess with them in your ebuild unless it's a trivial (like adding libsuffix)
-or unavoidable fix (which should be discussed with other devs first).</p>
-<p>
-Ignoring this policy can result in breakage for other distros and also breaks
-the purpose of this interface, because it is not reliable anymore.
-</p>
-</body>
-</subsection>
-
-<subsection>
<title>Masking unsupported/broken USE flags</title>
<body>
<p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2014-10-18 17:36 Markos Chandras
0 siblings, 0 replies; 46+ messages in thread
From: Markos Chandras @ 2014-10-18 17:36 UTC (permalink / raw
To: gentoo-commits
commit: a4ada1b4f1e37f189a38d4d5bc06a2c3503e77c9
Author: W. Trevor King <wking <AT> tremily <DOT> us>
AuthorDate: Sun Sep 14 18:31:38 2014 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sun Sep 14 21:22:55 2014 +0000
URL: http://sources.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=a4ada1b4
ebuild-writing/common-mistakes: Mention the 'doc' USE flag
When reminding folks to install the docs, also remind them that they
should be using the 'doc' USE flag for serious docs. This USE flag is
the standard way to enable/disable doc installation, and we don't want
ebuilds blindly pulling in doc depenencies regardless of how it's set.
Use some of Ulrich Müller's wording [1].
[1]: https://bugs.gentoo.org/show_bug.cgi?id=522800#c3
Thanks-to: Ulrich Müller <ulm <AT> gentoo.org>
---
ebuild-writing/common-mistakes/text.xml | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index db851a2..ff906fd 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -391,11 +391,19 @@ implied already, you should only add it if it is something other than
<body>
<p>
-If your package has documentation, make sure you install it using <c>dodoc</c>
-or in <path>/usr/share/doc/${PF}</path>. Remember to check for errors when
+If your package has documentation, make sure you install it using <c>dodoc</c>
+or in <path>/usr/share/doc/${PF}</path>. Remember to check for errors when
running <c>dodoc</c>/<c>doins</c>.
</p>
+<p>
+If the package documentation is large or requires additional
+dependencies to build, you should make it optional with the <c>doc</c>
+USE flag. If the documentation is small and does not require
+additional dependencies (e.g. <c>README</c> files), install it
+unconditionally.
+</p>
+
</body>
</subsection>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: 8801a95310ec5e7d553a0a8285612a8a7cbee144
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:32 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:19 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=8801a953
general-concepts/tree: replace the mention of ChangeLog #558642
Package updates do not require changing of the ChangeLog file. Package
updates by users that do not mention what has changed is still
considered a common mistake however.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-writing/common-mistakes/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 1718d55..1716e5d 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -468,7 +468,7 @@ of the application, if any exists.
</body>
</subsection>
<subsection>
-<title>Package updates without changing the ChangeLog</title>
+<title>Package updates without explaining what has changed</title>
<body>
<p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2016-10-28 17:13 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2016-10-28 17:13 UTC (permalink / raw
To: gentoo-commits
commit: 3607b7a4e355a2421321f2dfccc24f40f1d0d48e
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Fri Oct 28 17:13:30 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Oct 28 17:13:30 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3607b7a4
Whitespace fixes.
ebuild-writing/common-mistakes/text.xml | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 8293bc8..1a2ef85 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -237,7 +237,7 @@ part.
</li>
<li>
<e>One dependency per line.</e><br />
- Don't put multiple dependency on the same line. It makes it ugly to read
+ Don't put multiple dependency on the same line. It makes it ugly to read
and hard to follow.
</li>
</ul>
@@ -293,17 +293,17 @@ some tips on how to find the correct dependencies.
<p>
Another common mistake users make when submitting ebuilds is supplying an
-invalid license. For example, <c>GPL</c> is not a valid license. You need to
-specify <c>GPL-1</c> or <c>GPL-2</c>. Same with <c>LGPL</c>. Make sure the
-license you use in the <c>LICENSE</c> field is something that exists in
-<path>/usr/portage/licenses</path>. As a tip, check the <path>COPYING</path>
+invalid license. For example, <c>GPL</c> is not a valid license. You need to
+specify <c>GPL-1</c> or <c>GPL-2</c>. Same with <c>LGPL</c>. Make sure the
+license you use in the <c>LICENSE</c> field is something that exists in
+<path>/usr/portage/licenses</path>. As a tip, check the <path>COPYING</path>
in a source tarball for the license. If a package does not specify it
uses <c>GPL-1</c> or <c>GPL-2</c>, it is very likely it uses <c>GPL-2</c>.
</p>
<p>
If the license for the package you submit is unique and not in
-<path>/usr/portage/licenses/</path>, then you must submit the new license in a
+<path>/usr/portage/licenses/</path>, then you must submit the new license in a
separate file.
</p>
@@ -377,8 +377,8 @@ tell you if there is trailing whitespace at the end of lines or on empty lines.
<body>
<p>
-If <c>S=${WORKDIR}/${P}</c>, then you should not add it to your ebuild. This is
-implied already, you should only add it if it is something other than
+If <c>S=${WORKDIR}/${P}</c>, then you should not add it to your ebuild. This is
+implied already, you should only add it if it is something other than
<c>${WORKDIR}/${P}</c>.
</p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2017-01-21 19:21 Göktürk Yüksek
0 siblings, 0 replies; 46+ messages in thread
From: Göktürk Yüksek @ 2017-01-21 19:21 UTC (permalink / raw
To: gentoo-commits
commit: 1ad3d23d6d061b3bfe5849804a1efbe0aaa1e5cd
Author: Jonas Stein <news <AT> jonasstein <DOT> de>
AuthorDate: Sat Jan 21 12:03:27 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Sat Jan 21 19:21:03 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1ad3d23d
ebuild-writing/common-mistakes: shortened to facts and made it more objective
The user who reads this does not need 3x please. Well sorted and
readable attachments are good for everyone. Gentoo-devs, bug reporter,
proxy-maintainer, packagers from other distributions looking for
solutions...
ebuild-writing/common-mistakes/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 1a2ef85..e9bcf5c 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -440,8 +440,8 @@ link="::ebuild-maintenance#adding-a-new-ebuild">Adding new Ebuild</uri> tutorial
<body>
<p>
-Please please please do not attach ebuilds as tarballs. Attach patches
-separately as well so we can easily examine them.
+Please do not attach ebuilds or patches as tarballs. It avoids extra
+operations when reviewing.
</p>
</body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2017-01-25 5:31 Göktürk Yüksek
0 siblings, 0 replies; 46+ messages in thread
From: Göktürk Yüksek @ 2017-01-25 5:31 UTC (permalink / raw
To: gentoo-commits
commit: 4ab265a32b85e372328c11f16911e845197c18ee
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed Jan 25 05:29:50 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Jan 25 05:29:50 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4ab265a3
ebuild-writing/common-mistakes: update the ebuild header copyright
ebuild-writing/common-mistakes/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index bc98089..e3ee42d 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -159,7 +159,7 @@ The first three lines <e>must</e> look like this:
</p>
<pre caption="Valid Header">
-# Copyright 1999-2016 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Id$
</pre>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2017-01-25 5:31 Göktürk Yüksek
0 siblings, 0 replies; 46+ messages in thread
From: Göktürk Yüksek @ 2017-01-25 5:31 UTC (permalink / raw
To: gentoo-commits
commit: b76359b3dad438a347e97b1a57c4be3011efceae
Author: Jonas Stein <news <AT> jonasstein <DOT> de>
AuthorDate: Mon Jan 23 21:47:09 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Jan 25 05:29:42 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b76359b3
ebuild-writing/common-mistakes: improve the text with links
* add link to skel.ebuild header
* add link to No_homepage
Major changes to the text have been made by the committer.
ebuild-writing/common-mistakes/text.xml | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index e9bcf5c..bc98089 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -148,9 +148,10 @@ Removing "-Werror" from configure.ac can cause breakage in very rare cases where
<body>
<p>
-When you submit your ebuilds, the header should be <e>exactly</e> the same as
-the one in <path>/usr/portage/skel.ebuild</path>. Most importantly, do not
-modify it in any way and make sure that the <c>$Id$</c> line is intact.
+When you submit your ebuilds, the header must be <e>exactly</e> the same as
+the one in
+<uri link="https://gitweb.gentoo.org/repo/gentoo.git/tree/skel.ebuild">
+skel.ebuild</uri>.
</p>
<p>
@@ -345,7 +346,9 @@ SLOT="0"
Please check if the HOMEPAGE variable is right and leads users to the right
page if they want to find out more about the package. And make sure the
DESCRIPTION is not overly long. Good descriptions will describe the main
-function of the package in a sentence.
+function of the package in a sentence. Set HOMEPAGE to
+<uri link="::ebuild-maintenance#Homepage unavailable">No_homepage wiki page</uri>,
+if there is none.
</p>
</body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-02-06 10:35 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-02-06 10:35 UTC (permalink / raw
To: gentoo-commits
commit: 36b6a8d9cfd1f44a76b4b117f2dfee45a552c8d5
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Mon Feb 1 09:25:54 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Mon Feb 1 09:35:09 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=36b6a8d9
ebuild-writing/common-mistakes: Drop note on Header/Id line
This is no longer a common mistake. Exactly the same note is still
present in ebuild-writing/file-format.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 7 -------
1 file changed, 7 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 67be337..85c0e3f 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -184,13 +184,6 @@ The first two lines <e>must</e> look like this:
# Distributed under the terms of the GNU General Public License v2
</pre>
-<note>
-The header previously included a third line with a CVS <c>$Id$</c>
-or <c>$Header$</c> keyword. That line was abolished after conversion
-to Git by <uri link="https://bugs.gentoo.org/611234">decision of the Gentoo
-Council on 28 February 2017</uri> and <e>must not</e> be added any more.
-</note>
-
</body>
</subsection>
<subsection>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-21 6:06 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-21 6:06 UTC (permalink / raw
To: gentoo-commits
commit: 557f3dbd124b34928e4e11d8e51d8822e281f240
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 06:02:20 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Mar 21 06:06:13 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=557f3dbd
ebuild-writing/common-mistakes: Reformat paragraphs in the -Werror section
No change of wording.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 44 ++++++++++++++++++++++++---------
1 file changed, 33 insertions(+), 11 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 0d3d441..dcdc969 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -19,7 +19,8 @@ writing ebuilds.
<p>
The <c>static</c> use-flag should only be used to make a binary use static
linking instead of dynamic linking. It should not be used to make a library
-install static libraries. Instead, the <c>static-libs</c> use-flag is used for this.
+install static libraries. Instead, the <c>static-libs</c> use-flag is used for
+this.
</p>
</body>
</subsection>
@@ -104,32 +105,41 @@ preferred.</note>
<title>-Werror compiler flag not removed</title>
<body>
<p>
-"-Werror" is a flag which turns all warnings into errors and thus will abort compiling if any warning is encountered.
+"-Werror" is a flag which turns all warnings into errors and thus will abort
+compiling if any warning is encountered.
</p>
<p><b>Rationale</b></p>
<p>
-This flag is not recommended for releases and should always be disabled when encountered in build-logs, because there are numerous cases where this breaks without purpose, e.g.:
+This flag is not recommended for releases and should always be disabled when
+encountered in build-logs, because there are numerous cases where this breaks
+without purpose, e.g.:
</p>
<ul>
<li>
- new warnings on version bumps of GCC/GLIBC the developer was not aware of at the point of coding
+ new warnings on version bumps of GCC/GLIBC the developer was not aware of
+ at the point of coding
</li>
<li>
some autoconf checks will fail badly
</li>
<li>
- libraries adding deprecated API warnings although that API is still working/supported
+ libraries adding deprecated API warnings although that API is still
+ working/supported
</li>
<li>
- on less known architectures we may get different/more warnings than on common ones
+ on less known architectures we may get different/more warnings than on
+ common ones
</li>
<li>
- random breakage depending on what distro/architecture/library version/kernel/userland the developer was testing "-Werror" on
+ random breakage depending on what distro/architecture/library
+ version/kernel/userland the developer was testing "-Werror" on
</li>
</ul>
<p>
-Turning off "-Werror" we will still see the warnings, but there is no reason that they cause compile failure. Also note that Portage already emits QA notices about gcc warnings that can cause runtime breakage.
+Turning off "-Werror" we will still see the warnings, but there is no reason
+that they cause compile failure. Also note that Portage already emits QA
+notices about gcc warnings that can cause runtime breakage.
</p>
<p><b>How to fix</b></p>
@@ -138,10 +148,16 @@ To fix the affected build system you should try the following methods:
</p>
<ul>
<li>
- remove the compiler flag from the build system, <e>e.g. Makefile.am or configure.ac</e> or even provide a switch (for autotools based build systems that could be "--disable-werror", which is good for sending a patch upstream)
+ remove the compiler flag from the build system, <e>e.g. Makefile.am or
+ configure.ac</e> or even provide a switch (for autotools based build
+ systems that could be "--disable-werror", which is good for sending a patch
+ upstream)
</li>
<li>
- use <e>append-flags -Wno-error</e> (needs flag-o-matic.eclass); for this to work the environment flags have to be respected and placed after build system flags; this method is not preferred as it will disable all "-Werror=specific-warning" flags as well, see next section
+ use <e>append-flags -Wno-error</e> (needs flag-o-matic.eclass); for this
+ to work the environment flags have to be respected and placed after build
+ system flags; this method is not preferred as it will disable all
+ "-Werror=specific-warning" flags as well, see next section
</li>
</ul>
<p>
@@ -150,7 +166,13 @@ Always check that it's really gone in the build log.
<p><b>Specific -Werror=... flags</b></p>
<p>
-GCC can turn any specific warning into an error. A specific -Werror flag would be "-Werror=implicit-function-declaration" for example and will only affect warnings about implicit function declarations. It's mostly safe to leave these untouched, cause they are pinned to this issue and should not cause random build time breakage. Also, we can expect that upstream did this on purpose to avoid known runtime errors and not just for testing their builds. However you should check the specified warnings yourself or ask other developers if unsure.
+GCC can turn any specific warning into an error. A specific -Werror flag would
+be "-Werror=implicit-function-declaration" for example and will only affect
+warnings about implicit function declarations. It's mostly safe to leave these
+untouched, cause they are pinned to this issue and should not cause random
+build time breakage. Also, we can expect that upstream did this on purpose to
+avoid known runtime errors and not just for testing their builds. However you
+should check the specified warnings yourself or ask other developers if unsure.
</p>
<p><b>Exceptions</b></p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-29 20:44 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-29 20:44 UTC (permalink / raw
To: gentoo-commits
commit: b487288add4b6a7ecc8a9674fe8e500ab7d8306a
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sat Mar 20 15:21:57 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Mon Mar 29 20:41:39 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b487288a
ebuild-writing/common-mistakes: extend 'DEPEND is incomplete'
Emphasise that the tips/information applies to all dependency
classes.
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index dcdc969..91eca66 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -284,6 +284,11 @@ part.
<title>DEPEND is incomplete</title>
<body>
+<note>
+The tips in this section apply to all dependency classes, not just
+<c>DEPEND</c>.
+</note>
+
<p>
This is another very common error. The ebuild submitter submits an ebuild
that "just works" without checking if the dependencies are correct. Here are
@@ -317,7 +322,7 @@ some tips on how to find the correct dependencies.
programs, etc.</e>
Usually the build process requires some dependencies such as intltool,
libtool, pkg-config, doxygen, scrollkeeper, gtk-doc, etc. Make sure those
- are clearly stated.
+ are clearly stated, usually in <c>BDEPEND</c>.
</li>
</ul>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 16:10 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 16:10 UTC (permalink / raw
To: gentoo-commits
commit: 2d6f348dda36f01bb240e06b38c5a894e6dce7aa
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 04:36:02 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 16:00:53 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2d6f348d
ebuild-writing/common-mistakes: mention pkgcheck
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 91eca66..b178209 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -409,8 +409,9 @@ the guidelines to use TABS rather than spaces. So <e>please</e> use tabs!
<body>
<p>
-I'm often guilty of this. Remember to run repoman over your ebuilds so it can
-tell you if there is trailing whitespace at the end of lines or on empty lines.
+I'm often guilty of this. Remember to run <c>repoman</c> or <c>pkgcheck</c>
+over your ebuilds so it can tell you if there is trailing whitespace at the end
+of lines or on empty lines.
</p>
</body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 16:10 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 16:10 UTC (permalink / raw
To: gentoo-commits
commit: 74c5a670a8e25b07893ee7533e69259cbe806e6d
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 30 09:56:41 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 16:00:55 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=74c5a670
ebuild-writing/common-mistakes: fix 1st->3rd person per style
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index b178209..d77b143 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -409,9 +409,8 @@ the guidelines to use TABS rather than spaces. So <e>please</e> use tabs!
<body>
<p>
-I'm often guilty of this. Remember to run <c>repoman</c> or <c>pkgcheck</c>
-over your ebuilds so it can tell you if there is trailing whitespace at the end
-of lines or on empty lines.
+Remember to run <c>repoman</c> or <c>pkgcheck</c> over your ebuilds so it can
+tell you if there is trailing whitespace at the end of lines or on empty lines.
</p>
</body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: 7e6a5e6ae276413702c4dc93245e724944c1ab52
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:45:11 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:55 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7e6a5e6a
ebuild-writing/common-mistakes: linkify bug reference for non-verbose builds
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 0dc7b5b..481eadb 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -101,9 +101,11 @@ There are several ways to fix non-verbose build logs depending on the build syst
</ul>
<note>In case you encounter an affected package which uses a build system not
-controllable by Portage or eclasses you should file a bug (preferably with a patch)
-and make it block the tracker bug #429308. Solutions above ebuild level are
-preferred.</note>
+controllable by Portage or eclasses, you should file a bug (preferably with
+a patch) and make it block the tracker
+<uri link="https://bugs.gentoo.org/429308">bug 429308</uri>. Solutions above
+ebuild level are preferred.</note>
+
</body>
</subsection>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: eb65d74e2ad8428672c7e4d944beaa483a1df6d1
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:36:03 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:53 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=eb65d74e
ebuild-writing/common-mistakes: s/cmake-utils/cmake/
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 9ff6608..fba6bac 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -83,11 +83,11 @@ There are several ways to fix non-verbose build logs depending on the build syst
</p>
<ul>
- <li>For <c>cmake</c> based build systems it should be sufficient that
- the ebuild calls cmake-utils_src_compile which picks up the cmake-utils.eclass
+ <li>For <c>cmake</c>-based build systems, it should be sufficient that
+ the ebuild calls cmake_src_compile which picks up the cmake.eclass
variable 'CMAKE_VERBOSE=1' by default. If you call emake directly for
whatever reason, you can do 'emake VERBOSE=1' (note that
- cmake-utils_src_compile takes arguments as well which are passed to make).</li>
+ cmake_src_compile takes arguments as well which are passed to make).</li>
<li>For <c>autotools</c> based build systems you can pass
'--disable-silent-rules' to econf, or use EAPI 5 where that argument is
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: 51452b8d8f452053086e03c1bf35061cc6c1caa9
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:43:05 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:54 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=51452b8d
ebuild-writing/common-mistakes: build-log -> build log
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 3bbda05..0dc7b5b 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -120,7 +120,7 @@ for more information and real-life examples/fixes in the Gentoo tree.
<p><b>Rationale</b></p>
<p>
This flag is not recommended for releases and should always be disabled when
-encountered in build-logs, because there are numerous cases where this breaks
+encountered in build logs, because there are numerous cases where this breaks
without purpose, e.g.:
</p>
<ul>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: fd90736ea1141e95c63a9634d424aa843454ca45
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:31:00 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:52 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fd90736e
ebuild-writing/common-mistakes: give more information on invalid ${ROOT} usage
Bug: https://bugs.gentoo.org/775191
Signed-off-by: Sam James <sam <AT> gentoo.org>
[Add bug number to link text.]
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index d77b143..c92813f 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -31,8 +31,11 @@ this.
<p>
The usage of <c>ROOT</c> is only designed to influence the way the package is
installed (ie. into <c>ROOT</c>) <d/> building and compiling should not depend
-on <c>ROOT</c>. As a consequence of this the usage of <c>ROOT</c> in
-<c>src_*</c> functions is not allowed.
+on <c>ROOT</c>. As a consequence of this, the usage of <c>ROOT</c> in
+<c>src_*</c> functions is not allowed. <c>pkgcheck</c> can now detect some
+such cases via its <c>MisplacedVariable</c> check.
+See <uri link="https://bugs.gentoo.org/775191">bug 775191</uri> for more
+information.
</p>
<p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: 0ba65e82f048d69ee2d9e72131a245c63acdc133
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:39:51 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:54 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=0ba65e82
ebuild-writing/common-mistakes: add -Werror tracker link
Bug: https://bugs.gentoo.org/show_bug.cgi?id=werror
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 2d8695f..3bbda05 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -113,6 +113,8 @@ preferred.</note>
<p>
"-Werror" is a flag which turns all warnings into errors and thus will abort
compiling if any warning is encountered.
+See <uri link="https://bugs.gentoo.org/show_bug.cgi?id=werror">bug 260867</uri>
+for more information and real-life examples/fixes in the Gentoo tree.
</p>
<p><b>Rationale</b></p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: 196e48b1418b58a2d32efd21cec47af1b6bd8f1c
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:34:53 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:52 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=196e48b1
ebuild-writing/common-mistakes: convert 'build log not verbose' to list
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index c92813f..9ff6608 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -81,22 +81,22 @@ someone reports a bug for your package, the <b>build log must always be verbose.
<p>
There are several ways to fix non-verbose build logs depending on the build system:
</p>
-<p>
-For <c>cmake</c> based build systems it should be sufficient that the ebuild calls
-cmake-utils_src_compile which picks up the cmake-utils.eclass variable 'CMAKE_VERBOSE=1'
-by default. If you call emake directly for whatever reason, you can do 'emake VERBOSE=1'
-(note that cmake-utils_src_compile takes arguments as well which are passed to make).
-</p>
-<p>
-For <c>autotools</c> based build systems you can pass '--disable-silent-rules' to econf,
-or use EAPI 5 where that argument is passed automatically. 'emake V=1' should also work.
-</p>
+<ul>
+ <li>For <c>cmake</c> based build systems it should be sufficient that
+ the ebuild calls cmake-utils_src_compile which picks up the cmake-utils.eclass
+ variable 'CMAKE_VERBOSE=1' by default. If you call emake directly for
+ whatever reason, you can do 'emake VERBOSE=1' (note that
+ cmake-utils_src_compile takes arguments as well which are passed to make).</li>
+
+ <li>For <c>autotools</c> based build systems you can pass
+ '--disable-silent-rules' to econf, or use EAPI 5 where that argument is
+ passed automatically. 'emake V=1' should also work.</li>
+
+ <li>For custom Makefiles you often have to write a patch. Try to get
+ upstream to include an option like 'V=1' to enable full verbosity.</li>
+</ul>
-<p>
-For custom Makefiles you often have to write a patch. Try to get upstream to include an
-option like 'V=1' to enable full verbosity.
-</p>
<note>In case you encounter an affected package which uses a build system not
controllable by Portage or eclasses you should file a bug (preferably with a patch)
and make it block the tracker bug #429308. Solutions above ebuild level are
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: 63d617e00118af7bf23814fa324dce4bc9ed2e95
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:37:56 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:53 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=63d617e0
ebuild-writing/common-mistakes: mention manual Go compiles (verbose builds)
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 3 +++
1 file changed, 3 insertions(+)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index fba6bac..2d8695f 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -95,6 +95,9 @@ There are several ways to fix non-verbose build logs depending on the build syst
<li>For custom Makefiles you often have to write a patch. Try to get
upstream to include an option like 'V=1' to enable full verbosity.</li>
+
+ <li>Note that when building Go manually outside of the eclass, you
+ will need GOFLAGS="-x".</li>
</ul>
<note>In case you encounter an affected package which uses a build system not
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: 225b6e2260e0e34523cb793de23cee8d78023764
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 30 09:52:44 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:57 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=225b6e22
ebuild-writing/common-mistakes: modernise autotools/econf advice on verbose log
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 7b47c2c..8afe2a5 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -91,9 +91,10 @@ There are several ways to fix non-verbose build logs depending on the build syst
takes arguments as well which are passed to make).
</li>
<li>
- For <c>autotools</c> based build systems you can pass
- '--disable-silent-rules' to econf, or use EAPI 5 where that argument is
- passed automatically. <c>emake V=1</c> should also work.
+ For <c>autotools</c> based build systems, <c>econf</c> automatically
+ passes '--disable-silent-rules' to <c>./configure</c>. If necessary,
+ <c>emake V=1</c> should also work. Note that <c>V=1</c> is not a universal
+ parameter so may not always work.
</li>
<li>
For custom Makefiles, you often have to write a patch. Try to get
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: f72795c60b475cc36501ed03b7b3a03c38bcf851
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:50:27 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:56 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f72795c6
ebuild-writing/common-mistakes: mention "the compiler", not only GCC
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 6f33248..9455688 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -176,13 +176,14 @@ Always check that it's really gone in the build log.
<p><b>Specific -Werror=... flags</b></p>
<p>
-GCC can turn any specific warning into an error. A specific -Werror flag would
-be "-Werror=implicit-function-declaration" for example and will only affect
-warnings about implicit function declarations. It's mostly safe to leave these
-untouched, cause they are pinned to this issue and should not cause random
-build time breakage. Also, we can expect that upstream did this on purpose to
-avoid known runtime errors and not just for testing their builds. However you
-should check the specified warnings yourself or ask other developers if unsure.
+The compiler (e.g. GCC) can turn any specific warning into an error. A
+specific -Werror flag would be "-Werror=implicit-function-declaration" for
+example and will only affect warnings about implicit function declarations. It's
+mostly safe to leave these untouched, cause they are pinned to this issue and
+should not cause random build time breakage. Also, we can expect that upstream
+did this on purpose to avoid known runtime errors and not just for testing their
+builds. However, you should check the specified warnings yourself or ask other
+developers if unsure.
</p>
<p><b>Exceptions</b></p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: d922c8c08a951c2a5f4c057cf6e1174d0a12f5a9
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:36:43 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:56 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d922c8c0
ebuild-writing/common-mistakes: slight grammar fixes/phrasing changes
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 9455688..05380bf 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -93,7 +93,7 @@ There are several ways to fix non-verbose build logs depending on the build syst
'--disable-silent-rules' to econf, or use EAPI 5 where that argument is
passed automatically. 'emake V=1' should also work.</li>
- <li>For custom Makefiles you often have to write a patch. Try to get
+ <li>For custom Makefiles, you often have to write a patch. Try to get
upstream to include an option like 'V=1' to enable full verbosity.</li>
<li>Note that when building Go manually outside of the eclass, you
@@ -127,8 +127,8 @@ without purpose, e.g.:
</p>
<ul>
<li>
- new warnings on version bumps of GCC/glibc which the developer was not aware
- of at the point of coding
+ new warnings on version bumps of GCC/glibc of which the developer was not
+ aware at the point of coding
</li>
<li>
some autoconf checks will fail badly
@@ -147,9 +147,9 @@ without purpose, e.g.:
</li>
</ul>
<p>
-Turning off "-Werror" we will still see the warnings, but there is no reason
-that they cause compile failure. Also note that Portage already emits QA
-notices about gcc warnings that can cause runtime breakage.
+By turning off "-Werror", we will still see the warnings, but there is no reason
+that they cause compile failure. Note that Portage already emits QA
+notices about GCC warnings that can cause runtime breakage.
</p>
<p><b>How to fix</b></p>
@@ -179,8 +179,8 @@ Always check that it's really gone in the build log.
The compiler (e.g. GCC) can turn any specific warning into an error. A
specific -Werror flag would be "-Werror=implicit-function-declaration" for
example and will only affect warnings about implicit function declarations. It's
-mostly safe to leave these untouched, cause they are pinned to this issue and
-should not cause random build time breakage. Also, we can expect that upstream
+mostly safe to leave these untouched, because they are pinned to this issue and
+should not cause random build-time breakage. Also, we can expect that upstream
did this on purpose to avoid known runtime errors and not just for testing their
builds. However, you should check the specified warnings yourself or ask other
developers if unsure.
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: 05a0ec105e50d6f67a02020bac969474ec6a3ef3
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Mon Mar 29 23:06:16 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:57 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=05a0ec10
ebuild-writing/common-mistakes: adjust XML style for build systems list
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 35 +++++++++++++++++++--------------
1 file changed, 20 insertions(+), 15 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 05380bf..7b47c2c 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -83,21 +83,26 @@ There are several ways to fix non-verbose build logs depending on the build syst
</p>
<ul>
- <li>For <c>cmake</c>-based build systems, it should be sufficient that
- the ebuild calls cmake_src_compile which picks up the cmake.eclass
- variable 'CMAKE_VERBOSE=1' by default. If you call emake directly for
- whatever reason, you can do 'emake VERBOSE=1' (note that
- cmake_src_compile takes arguments as well which are passed to make).</li>
-
- <li>For <c>autotools</c> based build systems you can pass
- '--disable-silent-rules' to econf, or use EAPI 5 where that argument is
- passed automatically. 'emake V=1' should also work.</li>
-
- <li>For custom Makefiles, you often have to write a patch. Try to get
- upstream to include an option like 'V=1' to enable full verbosity.</li>
-
- <li>Note that when building Go manually outside of the eclass, you
- will need GOFLAGS="-x".</li>
+ <li>
+ For <c>cmake</c>-based build systems, it should be sufficient that the
+ ebuild calls cmake_src_compile which picks up the cmake.eclass variable
+ <c>CMAKE_VERBOSE=1</c> by default. If you call emake directly for whatever
+ reason, you can do <c>emake VERBOSE=1</c> (note that 'cmake_src_compile'
+ takes arguments as well which are passed to make).
+ </li>
+ <li>
+ For <c>autotools</c> based build systems you can pass
+ '--disable-silent-rules' to econf, or use EAPI 5 where that argument is
+ passed automatically. <c>emake V=1</c> should also work.
+ </li>
+ <li>
+ For custom Makefiles, you often have to write a patch. Try to get
+ upstream to include an option like 'V=1' to enable full verbosity.
+ </li>
+ <li>
+ Note that when building Go manually outside of the eclass, you
+ will need GOFLAGS="-x".
+ </li>
</ul>
<note>In case you encounter an affected package which uses a build system not
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:15 UTC (permalink / raw
To: gentoo-commits
commit: 7b3a50bdcef9968c1c894ab8ce55f0436d576327
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 02:48:36 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:14:55 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7b3a50bd
ebuild-writing/common-mistakes: s/GLIBC/glibc/
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 481eadb..6f33248 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -127,8 +127,8 @@ without purpose, e.g.:
</p>
<ul>
<li>
- new warnings on version bumps of GCC/GLIBC the developer was not aware of
- at the point of coding
+ new warnings on version bumps of GCC/glibc which the developer was not aware
+ of at the point of coding
</li>
<li>
some autoconf checks will fail badly
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-03-30 18:20 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-03-30 18:20 UTC (permalink / raw
To: gentoo-commits
commit: aa2dd537f393f9c90b4bdef06f1478d0a09d8635
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 30 18:17:02 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 18:17:02 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=aa2dd537
ebuild-writing/common-mistakes: Fix Gentoo Bugzilla URL
Warning on previous git push:
remote: WARNING: invalid Gentoo Bugzilla URL: https://bugs.gentoo.org/show_bug.cgi?id=werror
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 8afe2a5..2313c50 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -121,8 +121,8 @@ ebuild level are preferred.</note>
<p>
"-Werror" is a flag which turns all warnings into errors and thus will abort
compiling if any warning is encountered.
-See <uri link="https://bugs.gentoo.org/show_bug.cgi?id=werror">bug 260867</uri>
-for more information and real-life examples/fixes in the Gentoo tree.
+See <uri link="https://bugs.gentoo.org/260867">bug 260867</uri> for more
+information and real-life examples/fixes in the Gentoo tree.
</p>
<p><b>Rationale</b></p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-08-01 2:38 Sam James
0 siblings, 0 replies; 46+ messages in thread
From: Sam James @ 2021-08-01 2:38 UTC (permalink / raw
To: gentoo-commits
commit: 8efea8b918e6b9f12d8612ed4c9bb498fcdbd33a
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Fri Jun 18 05:03:31 2021 +0000
Commit: Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sun Aug 1 02:38:39 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=8efea8b9
ebuild-writing/common-mistakes: reformat 'DESCRIPTION and HOMEPAGE'
Closes: https://github.com/gentoo/devmanual/pull/223
Signed-off-by: Sam James <sam <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index cc87d74..e46a36c 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -413,11 +413,12 @@ SLOT="0"
<body>
<p>
+Make sure the <c>DESCRIPTION</c> is not overly long. Good descriptions will
+describe the main function of the package in a sentence.
+
Please check if the <c>HOMEPAGE</c> variable is right and leads users to the
-right page if they want to find out more about the package. And make sure
-the <c>DESCRIPTION</c> is not overly long. Good descriptions will describe
-the main function of the package in a sentence. If no homepage for the package
-is available, set the <c>HOMEPAGE</c> variable to
+right page if they want to find out more about the package. If no homepage for
+the package is available, set the <c>HOMEPAGE</c> variable to
<c>https://wiki.gentoo.org/wiki/No_homepage</c>. Please also strive to test
HTTPS support for the site used in <c>HOMEPAGE</c>.
</p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-08-01 2:38 Sam James
0 siblings, 0 replies; 46+ messages in thread
From: Sam James @ 2021-08-01 2:38 UTC (permalink / raw
To: gentoo-commits
commit: cb01338bb42175efee3af2aeca1055c544b33140
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sat Apr 10 01:41:53 2021 +0000
Commit: Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sun Aug 1 02:38:39 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=cb01338b
ebuild-writing/common-mistakes: add 'Calling pkg-config directly'
Quite a lot of ebuilds do this. We should instead use the tc-getPKG_CONFIG
helper from toolchain-funcs.eclass which respects ${PKG_CONFIG} - useful
for e.g. cross-compiling.
Signed-off-by: Sam James <sam <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 23 ++++++++++++++++++++++-
1 file changed, 22 insertions(+), 1 deletion(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 1969efe..cc87d74 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -505,8 +505,29 @@ the ebuild's quality and ease review.
</p>
</body>
</subsection>
-</section>
+<subsection>
+<title>Calling pkg-config directly</title>
+<body>
+
+<p>
+You should not call <c>pkg-config</c> directly in ebuilds because this is
+problematic for e.g. cross-compiling. The correct helper respects
+<c>${PKG_CONFIG}</c>. Instead, use <c>tc-getPKG_CONFIG</c> from
+<c>toolchain-funcs.eclass</c>, e.g.
+</p>
+
+<codesample lang="ebuild">
+sed -i -e "s:-lncurses:$($(tc-getPKG_CONFIG) --libs ncurses):" || die
+</codesample>
+
+<p>
+Don't then forget to add <c>virtual/pkgconfig</c> to BDEPEND!
+</p>
+
+</body>
+</subsection>
+</section>
<section>
<title>Common Ebuild Submission Mistakes</title>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-08-01 2:38 Sam James
0 siblings, 0 replies; 46+ messages in thread
From: Sam James @ 2021-08-01 2:38 UTC (permalink / raw
To: gentoo-commits
commit: b27290e15d077e852be76bdf4e9627c9a84653a9
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sat Apr 10 01:57:35 2021 +0000
Commit: Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sun Aug 1 02:38:37 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b27290e1
ebuild-writing/common-mistakes: mention using latest EAPI
Signed-off-by: Sam James <sam <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 2313c50..23935be 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -477,6 +477,20 @@ at least when the ebuild hits the stable branch.
</p>
</body>
</subsection>
+
+<subsection>
+<title>Not using latest EAPI</title>
+<body>
+
+<p>
+Often, user-submitted ebuilds do not use the latest EAPI and may even
+be several versions behind. EAPIs bring new helper functions and improved
+methods for completing common tasks. It's recommended that submitted ebuilds
+use the latest EAPI possible (subject to eclass constraints) to improve
+the ebuild's quality and ease review.
+</p>
+</body>
+</subsection>
</section>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-08-01 2:38 Sam James
0 siblings, 0 replies; 46+ messages in thread
From: Sam James @ 2021-08-01 2:38 UTC (permalink / raw
To: gentoo-commits
commit: 2c6c0026d80b3d6c34bc1c70a12debfa7dfdc30f
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sat Apr 10 01:58:38 2021 +0000
Commit: Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sun Aug 1 02:38:37 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2c6c0026
ebuild-writing/common-mistakes: mention HTTPS for HOMEPAGE
Signed-off-by: Sam James <sam <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 23935be..ce4bc95 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -405,7 +405,8 @@ right page if they want to find out more about the package. And make sure
the <c>DESCRIPTION</c> is not overly long. Good descriptions will describe
the main function of the package in a sentence. If no homepage for the package
is available, set the <c>HOMEPAGE</c> variable to
-<c>https://wiki.gentoo.org/wiki/No_homepage</c>.
+<c>https://wiki.gentoo.org/wiki/No_homepage</c>. Please also strive to test
+HTTPS support for the site used in <c>HOMEPAGE</c>.
</p>
</body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-08-01 2:38 Sam James
0 siblings, 0 replies; 46+ messages in thread
From: Sam James @ 2021-08-01 2:38 UTC (permalink / raw
To: gentoo-commits
commit: 3a00a5fc63342e1a2a5e01ce2db232e5d21f2c3f
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sat Apr 10 02:16:27 2021 +0000
Commit: Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sun Aug 1 02:38:38 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3a00a5fc
ebuild-writing/common-mistakes: mention leftover USE flags, inherits
Suggested-by: Joonas Niilola <juippis <AT> gentoo.org> (inherits)
Signed-off-by: Sam James <sam <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index ce4bc95..1969efe 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -378,6 +378,19 @@ Make sure when you bump a version, the stable KEYWORDS are all marked as
<c>~</c>.
</p>
+</body>
+</subsection>
+<subsection>
+<title>Unused flags and eclass inherits</title>
+<body>
+
+<p>
+Sometimes obsolete USE flags remain in IUSE despite having no function, e.g. a
+dependency may have become mandatory but the USE flag remains in IUSE and *DEPEND.
+Similarly, eclasses often become redundant due to changes in the ebuild, or new EAPIs,
+e.g. <c>eutils.eclass</c> should be obsolete in modern EAPIs. Remember to prune these.
+</p>
+
</body>
</subsection>
<subsection>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-08-01 2:43 Sam James
0 siblings, 0 replies; 46+ messages in thread
From: Sam James @ 2021-08-01 2:43 UTC (permalink / raw
To: gentoo-commits
commit: 947a4714250dfb5d614bce6ef3689b655f235234
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Aug 1 02:43:16 2021 +0000
Commit: Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sun Aug 1 02:43:16 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=947a4714
ebuild-writing/common-mistakes: rewrap paragraph
Signed-off-by: Sam James <sam <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index e46a36c..a179ef7 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -386,9 +386,10 @@ Make sure when you bump a version, the stable KEYWORDS are all marked as
<p>
Sometimes obsolete USE flags remain in IUSE despite having no function, e.g. a
-dependency may have become mandatory but the USE flag remains in IUSE and *DEPEND.
-Similarly, eclasses often become redundant due to changes in the ebuild, or new EAPIs,
-e.g. <c>eutils.eclass</c> should be obsolete in modern EAPIs. Remember to prune these.
+dependency may have become mandatory but the USE flag remains in IUSE and
+*DEPEND. Similarly, eclasses often become redundant due to changes in the ebuild,
+or new EAPIs, e.g. <c>eutils.eclass</c> should be obsolete in modern EAPIs.
+Remember to prune these.
</p>
</body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-08-14 10:00 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-08-14 10:00 UTC (permalink / raw
To: gentoo-commits
commit: 719a4484b8c02dd2d69872c08b76a7cd850ffcff
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sat Aug 14 09:53:42 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sat Aug 14 09:53:42 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=719a4484
ebuild-writing/common-mistakes: Rewrap a long line
Fixes: 947a4714250dfb5d614bce6ef3689b655f235234
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index a179ef7..cd37eb8 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -385,11 +385,11 @@ Make sure when you bump a version, the stable KEYWORDS are all marked as
<body>
<p>
-Sometimes obsolete USE flags remain in IUSE despite having no function, e.g. a
-dependency may have become mandatory but the USE flag remains in IUSE and
-*DEPEND. Similarly, eclasses often become redundant due to changes in the ebuild,
-or new EAPIs, e.g. <c>eutils.eclass</c> should be obsolete in modern EAPIs.
-Remember to prune these.
+Sometimes obsolete USE flags remain in IUSE despite having no function, e.g.
+a dependency may have become mandatory but the USE flag remains in IUSE and
+*DEPEND. Similarly, eclasses often become redundant due to changes in the
+ebuild, or new EAPIs, e.g. <c>eutils.eclass</c> should be obsolete in modern
+EAPIs. Remember to prune these.
</p>
</body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-09-17 9:09 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-09-17 9:09 UTC (permalink / raw
To: gentoo-commits
commit: bd11b6fbeaeb84ce87177e0524b712a61e5a08de
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Fri Sep 17 03:35:56 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Sep 17 09:09:23 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bd11b6fb
ebuild-writing/common-mistakes: fix formatting of DESCRIPTION/HOMEPAGE note
Reported-by: Ulrich Müller <ulm <AT> gentoo.org>
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index cd37eb8..e0cdd12 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -416,7 +416,9 @@ SLOT="0"
<p>
Make sure the <c>DESCRIPTION</c> is not overly long. Good descriptions will
describe the main function of the package in a sentence.
+</p>
+<p>
Please check if the <c>HOMEPAGE</c> variable is right and leads users to the
right page if they want to find out more about the package. If no homepage for
the package is available, set the <c>HOMEPAGE</c> variable to
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2021-12-22 15:38 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2021-12-22 15:38 UTC (permalink / raw
To: gentoo-commits
commit: 7ce5e147a7ef3b776cb3910c0c21b999f7e2839b
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Aug 1 02:50:13 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Dec 22 15:36:22 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7ce5e147
ebuild-writing/common-mistakes: add calling external tools without die
Suggested-by: Joonas Niilola <juippis <AT> gentoo.org>
Signed-off-by: Sam James <sam <AT> gentoo.org>
[Internal cross reference fixed]
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index e0cdd12..4e26462 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -13,6 +13,19 @@ writing ebuilds.
<section>
<title>Common Ebuild Writing Mistakes</title>
+<subsection>
+<title>Unguarded external calls</title>
+<body>
+
+<p>
+Calls to external tools should be guarded with <c>|| die</c> (or use
+<c>assert</c>) in almost all cases to allow failure to be detected.
+See <uri link="::ebuild-writing/error-handling/"/>.
+</p>
+
+</body>
+</subsection>
+
<subsection>
<title>Invalid use of <c>static</c> use-flag</title>
<body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2022-01-22 23:43 Sam James
0 siblings, 0 replies; 46+ messages in thread
From: Sam James @ 2022-01-22 23:43 UTC (permalink / raw
To: gentoo-commits
commit: 1827baaac60d39987c44a791fde73b186c19844f
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sat Jan 22 23:41:34 2022 +0000
Commit: Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sat Jan 22 23:43:45 2022 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1827baaa
ebuild-writing/common-mistakes: .diff -> .patch
We usually use .patch nowadays so reflect that in the docs.
Signed-off-by: Sam James <sam <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 4e26462..63c44d3 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -607,7 +607,7 @@ The best way to generate it would be:
</p>
<pre>
-$ diff -u some-package-0.1.0.ebuild some-package-0.2.0.ebuild > ~/some-package-0.2.0.diff
+$ diff -u some-package-0.1.0.ebuild some-package-0.2.0.ebuild > ~/some-package-0.2.0.patch
</pre>
</body>
^ permalink raw reply related [flat|nested] 46+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
@ 2024-07-24 14:15 Ulrich Müller
0 siblings, 0 replies; 46+ messages in thread
From: Ulrich Müller @ 2024-07-24 14:15 UTC (permalink / raw
To: gentoo-commits
commit: 1bb6533cefdf26958aa2500f6a31fb5f8a584985
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Jul 24 14:14:30 2024 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Jul 24 14:14:30 2024 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1bb6533c
ebuild-writing/common-mistakes: Delete P0 from list of custom variables
As discussed in #gentoo-qa.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/common-mistakes/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 134990c..e39e2e6 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -244,7 +244,7 @@ The first two lines <e>must</e> look like this:
<p>
You should never redefine those variables. Always use MY_P, MY_PN, MY_PV,
-P0, etc. See other ebuilds that do it in Portage for more information. Most
+etc. See other ebuilds that do it in Portage for more information. Most
ebuilds use bash "Parameter Expansion". Please read the man page for bash to
understand how "Parameter Expansion" works.
</p>
^ permalink raw reply related [flat|nested] 46+ messages in thread
end of thread, other threads:[~2024-07-24 14:15 UTC | newest]
Thread overview: 46+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-08-01 2:43 [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/ Sam James
-- strict thread matches above, loose matches on Subject: below --
2024-07-24 14:15 Ulrich Müller
2022-01-22 23:43 Sam James
2021-12-22 15:38 Ulrich Müller
2021-09-17 9:09 Ulrich Müller
2021-08-14 10:00 Ulrich Müller
2021-08-01 2:38 Sam James
2021-08-01 2:38 Sam James
2021-08-01 2:38 Sam James
2021-08-01 2:38 Sam James
2021-08-01 2:38 Sam James
2021-03-30 18:20 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 18:15 Ulrich Müller
2021-03-30 16:10 Ulrich Müller
2021-03-30 16:10 Ulrich Müller
2021-03-29 20:44 Ulrich Müller
2021-03-21 6:06 Ulrich Müller
2021-02-06 10:35 Ulrich Müller
2017-01-25 5:31 Göktürk Yüksek
2017-01-25 5:31 Göktürk Yüksek
2017-01-21 19:21 Göktürk Yüksek
2016-10-28 17:13 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2014-10-18 17:36 Markos Chandras
2014-05-13 19:32 Ulrich Müller
2013-09-28 12:19 Markos Chandras
2012-12-30 14:21 Julian Ospald
2012-12-04 19:26 Julian Ospald
2012-11-23 18:02 Julian Ospald
2012-11-17 19:00 Markos Chandras
2012-11-11 19:33 Markos Chandras
2012-11-07 13:27 Michael Palimaka
2012-11-07 13:25 Michael Palimaka
2012-08-08 19:20 Markos Chandras
2011-03-09 16:42 Jeremy Olexa
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox