From owner-svn-doc-head@freebsd.org  Thu Apr 12 07:34:46 2018
Return-Path: <owner-svn-doc-head@freebsd.org>
Delivered-To: svn-doc-head@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 7D785F9CFEF;
 Thu, 12 Apr 2018 07:34:46 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org
 [IPv6:2610:1c1:1:606c::19:3])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client CN "mxrelay.nyi.freebsd.org",
 Issuer "Let's Encrypt Authority X3" (verified OK))
 by mx1.freebsd.org (Postfix) with ESMTPS id 324996DB52;
 Thu, 12 Apr 2018 07:34:46 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org (repo.freebsd.org
 [IPv6:2610:1c1:1:6068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 2D2B327FD1;
 Thu, 12 Apr 2018 07:34:46 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org ([127.0.1.37])
 by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w3C7YkgQ042163;
 Thu, 12 Apr 2018 07:34:46 GMT (envelope-from mat@FreeBSD.org)
Received: (from mat@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id w3C7YkRW042162;
 Thu, 12 Apr 2018 07:34:46 GMT (envelope-from mat@FreeBSD.org)
Message-Id: <201804120734.w3C7YkRW042162@repo.freebsd.org>
X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org
 using -f
From: Mathieu Arnold <mat@FreeBSD.org>
Date: Thu, 12 Apr 2018 07:34:46 +0000 (UTC)
To: doc-committers@freebsd.org, svn-doc-all@freebsd.org,
 svn-doc-head@freebsd.org
Subject: svn commit: r51550 -
 head/en_US.ISO8859-1/books/porters-handbook/makefiles
X-SVN-Group: doc-head
X-SVN-Commit-Author: mat
X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/porters-handbook/makefiles
X-SVN-Commit-Revision: 51550
X-SVN-Commit-Repository: doc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-doc-head@freebsd.org
X-Mailman-Version: 2.1.25
Precedence: list
List-Id: SVN commit messages for the doc tree for head
 <svn-doc-head.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/svn-doc-head>,
 <mailto:svn-doc-head-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-doc-head/>
List-Post: <mailto:svn-doc-head@freebsd.org>
List-Help: <mailto:svn-doc-head-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/svn-doc-head>,
 <mailto:svn-doc-head-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 12 Apr 2018 07:34:46 -0000

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