Attachment 331540 Details for Bug 415979 – text.xml.diff

[patch] text.xml.diff

text.xml.diff (text/plain), 3.14 KB, created by Julian Ospald on 2012-12-05 14:13:47 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Julian Ospald

Created: 2012-12-05 14:13:47 UTC

Size: 3.14 KB

patch

obsolete

>From: Julian Ospald <hasufell@gentoo.org>
>Date: Wed Dec 5 14:12:08 UTC 2012
>Subject: document handling of -Werror set by build systems wrt #415979
>
>--- ebuild-writing/common-mistakes/text.xml
>+++ ebuild-writing/common-mistakes/text.xml
>@@ -94,6 +94,56 @@
> </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.
>+
>+Rationale
>+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.
>+
>+
>+How to fix
>+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.
>+
>+
>+Specific -Werror=... flags
>+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.
>+
>+
>+Exceptions
>+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&amp;aid=2959749&amp;group_id=204462&amp;atid=989708">app-emulation/open-vm-tools bug</uri>. But even then we remove it from the resulting Makefile.
>+
>+</body>
>+</subsection>
>+
>+<subsection>
> <title>Missing/Invalid/Broken Header</title>
> <body>
>

Actions: View | Diff

Attachments on bug 415979: 331540