Add a note about WITH_DEBUG wrt stripping elf files.

PR:		226382
Reported by:	Mateusz Piotrowski
Sponsored by:	Absolight
This commit is contained in:
Mathieu Arnold 2018-04-12 07:34:45 +00:00
parent c9484b483d
commit 15da0f5680
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=51550

View file

@ -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">