svn commit: r51550 - head/en_US.ISO8859-1/books/porters-handbook/makefiles

[Mathieu Arnold]

Author: mat
Date: Thu Apr 12 07:34:45 2018
New Revision: 51550
URL: https://svnweb.freebsd.org/changeset/doc/51550

Log:
  Add a note about WITH_DEBUG wrt stripping elf files.
  
  PR:		226382
  Reported by:	Mateusz Piotrowski
  Sponsored by:	Absolight

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Thu Apr 12 07:23:54 2018	(r51549)
+++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Thu Apr 12 07:34:45 2018	(r51550)
@@ -7840,6 +7840,24 @@ bind910</screen>
 	<literal>not stripped</literal>.  Additionally, &man.strip.1;
 	will detect programs that have already been stripped and exit
 	cleanly.</para>
+
+      <important>
+	<para>When <varname>WITH_DEBUG</varname> is defined, elf files
+	  <emphasis>must not</emphasis> be stripped.</para>
+
+	<para>The variables (<varname>STRIP_CMD</varname>,
+	  <varname>INSTALL_PROGRAM</varname>,
+	  <varname>INSTALL_LIB</varname>, ...) and <link
+	    linkend="uses"><varname>USES</varname></link> provided by the framework
+	  handle this automatically.</para>
+	
+	<para>Some software, add <literal>-s</literal> to their
+	  <varname>LDFLAGS</varname>, in this case, either remove
+	  <literal>-s</literal> if <varname>WITH_DEBUG</varname> is
+	  set, or remove it unconditionally and use
+	  <varname>STRIP_CMD</varname> in
+	  <buildtarget>post-install</buildtarget>.</para>
+      </important>
     </sect2>
 
     <sect2 xml:id="install-copytree">