[gentoo-commits] devmanual r131 - in trunk: ebuild-writing/functions/src_compile/build-environment ebuild-writing/functions/src_compile/building general-concepts/user-environment

[Mark Loeser (halcy0n)]

Author: halcy0n
Date: 2008-09-01 18:32:35 +0000 (Mon, 01 Sep 2008)
New Revision: 131

Modified:
   trunk/ebuild-writing/functions/src_compile/build-environment/text.xml
   trunk/ebuild-writing/functions/src_compile/building/text.xml
   trunk/general-concepts/user-environment/text.xml
Log:
Update documentation for LDFLAGS, thanks to Arfrever Frehtes Taifersar Arahesis <Arfrever DOT FTA AT GMail DOT Com>; bug #236272


Modified: trunk/ebuild-writing/functions/src_compile/build-environment/text.xml
===================================================================
--- trunk/ebuild-writing/functions/src_compile/build-environment/text.xml	2008-08-19 01:30:04 UTC (rev 130)
+++ trunk/ebuild-writing/functions/src_compile/build-environment/text.xml	2008-09-01 18:32:35 UTC (rev 131)
@@ -17,7 +17,7 @@
 </note>
 
 <p>
-Ebuilds must not simply ignore user CFLAGS <d/> see
+Ebuilds must not simply ignore user CFLAGS, CXXFLAGS or LDFLAGS<d/> see
 <uri link="::general-concepts/user-environment#Not Filtering Variables"/>.
 </p>
 </body>

Modified: trunk/ebuild-writing/functions/src_compile/building/text.xml
===================================================================
--- trunk/ebuild-writing/functions/src_compile/building/text.xml	2008-08-19 01:30:04 UTC (rev 130)
+++ trunk/ebuild-writing/functions/src_compile/building/text.xml	2008-09-01 18:32:35 UTC (rev 131)
@@ -43,10 +43,10 @@
 </note>
 
 <p>
-Sometimes a package will not use the user's <c>${CFLAGS}</c>. This must be worked
-around, as sometimes this variable is used for specifying critical ABI options.
-In these cases, the build scripts should be modified (for example, with <c>sed</c>)
-to use <c>${CFLAGS}</c> correctly.
+Sometimes a package will not use the user's <c>${CFLAGS}</c> or <c>${LDFLAGS}</c>.
+This must be worked around, as sometimes these variables are used for specifying
+critical ABI options. In these cases, the build scripts should be modified (for
+example, with <c>sed</c>) to use <c>${CFLAGS}</c> or <c>${LDFLAGS}</c> correctly.
 </p>
 
 <codesample lang="ebuild">
@@ -58,17 +58,24 @@
 
     # We have a weird build.sh to work with which ignores our
     # compiler preferences. yay!
-    sed -i -e "s:cc -O2:$(tc-getCC) ${CFLAGS}:" build.sh \
+    sed -i -e "s:cc -O2:$(tc-getCC) ${CFLAGS} ${LDFLAGS}:" build.sh \
         || die "sed fix failed. Uh-oh..."
     ./build.sh || die "Build failed!"
 }
 </codesample>
 
 <note>
-When using <c>sed</c> with <c>CFLAGS</c>, it is not safe to use a comma or a
-slash as a delimiter. The vapier-recommended character is a colon.
+When using <c>sed</c> with <c>CFLAGS</c> or <c>LDFLAGS</c>, it is not safe to use
+a comma or a slash as a delimiter. The recommended character is a colon.
 </note>
 
+<p>
+Portage performs a QA check which verifies if LDFLAGS are respected. This QA check
+is enabled only when <c>LDFLAGS</c> variable contains <c>-Wl,--hash-style=gnu</c>.
+(This flag can be used only on systems which use <c>sys-libs/glibc</c> except for
+machines with a MIPS CPU.)
+</p>
+
 </body>
 </section>
 </chapter>

Modified: trunk/general-concepts/user-environment/text.xml
===================================================================
--- trunk/general-concepts/user-environment/text.xml	2008-08-19 01:30:04 UTC (rev 130)
+++ trunk/general-concepts/user-environment/text.xml	2008-09-01 18:32:35 UTC (rev 131)
@@ -79,7 +79,7 @@
 Some packages do this by accident. For example, one might see
 <c>CFLAGS=-Wall</c> in <c>Makefile.am</c>. To fix this, either <c>sed</c> in the user's
 <c>CFLAGS</c>, or (the better solution) change the variable to <c>AM_CFLAGS</c>, which
-will automatically be merged with the user's settings.
+will automatically be merged with the user's settings. LDFLAGS also should be respected.
 </p>
 </body>
 </section>