Gentoo Archives: gentoo-commits

From: "Ulrich Müller" <ulm@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
Date: Tue, 30 Mar 2021 18:15:56
Message-Id: 1617128096.d922c8c08a951c2a5f4c057cf6e1174d0a12f5a9.ulm@gentoo
1 commit: d922c8c08a951c2a5f4c057cf6e1174d0a12f5a9
2 Author: Sam James <sam <AT> gentoo <DOT> org>
3 AuthorDate: Sun Mar 21 02:36:43 2021 +0000
4 Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
5 CommitDate: Tue Mar 30 18:14:56 2021 +0000
6 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d922c8c0
7
8 ebuild-writing/common-mistakes: slight grammar fixes/phrasing changes
9
10 Signed-off-by: Sam James <sam <AT> gentoo.org>
11 Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
12
13 ebuild-writing/common-mistakes/text.xml | 16 ++++++++--------
14 1 file changed, 8 insertions(+), 8 deletions(-)
15
16 diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
17 index 9455688..05380bf 100644
18 --- a/ebuild-writing/common-mistakes/text.xml
19 +++ b/ebuild-writing/common-mistakes/text.xml
20 @@ -93,7 +93,7 @@ There are several ways to fix non-verbose build logs depending on the build syst
21 '--disable-silent-rules' to econf, or use EAPI 5 where that argument is
22 passed automatically. 'emake V=1' should also work.</li>
23
24 - <li>For custom Makefiles you often have to write a patch. Try to get
25 + <li>For custom Makefiles, you often have to write a patch. Try to get
26 upstream to include an option like 'V=1' to enable full verbosity.</li>
27
28 <li>Note that when building Go manually outside of the eclass, you
29 @@ -127,8 +127,8 @@ without purpose, e.g.:
30 </p>
31 <ul>
32 <li>
33 - new warnings on version bumps of GCC/glibc which the developer was not aware
34 - of at the point of coding
35 + new warnings on version bumps of GCC/glibc of which the developer was not
36 + aware at the point of coding
37 </li>
38 <li>
39 some autoconf checks will fail badly
40 @@ -147,9 +147,9 @@ without purpose, e.g.:
41 </li>
42 </ul>
43 <p>
44 -Turning off "-Werror" we will still see the warnings, but there is no reason
45 -that they cause compile failure. Also note that Portage already emits QA
46 -notices about gcc warnings that can cause runtime breakage.
47 +By turning off "-Werror", we will still see the warnings, but there is no reason
48 +that they cause compile failure. Note that Portage already emits QA
49 +notices about GCC warnings that can cause runtime breakage.
50 </p>
51
52 <p><b>How to fix</b></p>
53 @@ -179,8 +179,8 @@ Always check that it's really gone in the build log.
54 The compiler (e.g. GCC) can turn any specific warning into an error. A
55 specific -Werror flag would be "-Werror=implicit-function-declaration" for
56 example and will only affect warnings about implicit function declarations. It's
57 -mostly safe to leave these untouched, cause they are pinned to this issue and
58 -should not cause random build time breakage. Also, we can expect that upstream
59 +mostly safe to leave these untouched, because they are pinned to this issue and
60 +should not cause random build-time breakage. Also, we can expect that upstream
61 did this on purpose to avoid known runtime errors and not just for testing their
62 builds. However, you should check the specified warnings yourself or ask other
63 developers if unsure.