From owner-p4-projects@FreeBSD.ORG  Fri Jul 28 17:09:15 2006
Return-Path: <owner-p4-projects@FreeBSD.ORG>
X-Original-To: p4-projects@freebsd.org
Delivered-To: p4-projects@freebsd.org
Received: by hub.freebsd.org (Postfix, from userid 32767)
	id 0790D16A4DF; Fri, 28 Jul 2006 17:09:15 +0000 (UTC)
X-Original-To: perforce@FreeBSD.org
Delivered-To: perforce@FreeBSD.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id D8C9616A4DD
	for <perforce@FreeBSD.org>; Fri, 28 Jul 2006 17:09:14 +0000 (UTC)
	(envelope-from gabor@FreeBSD.org)
Received: from repoman.freebsd.org (repoman.freebsd.org [216.136.204.115])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 5E7C443D5F
	for <perforce@FreeBSD.org>; Fri, 28 Jul 2006 17:09:14 +0000 (GMT)
	(envelope-from gabor@FreeBSD.org)
Received: from repoman.freebsd.org (localhost [127.0.0.1])
	by repoman.freebsd.org (8.13.6/8.13.6) with ESMTP id k6SH9EfI064819
	for <perforce@FreeBSD.org>; Fri, 28 Jul 2006 17:09:14 GMT
	(envelope-from gabor@FreeBSD.org)
Received: (from perforce@localhost)
	by repoman.freebsd.org (8.13.6/8.13.4/Submit) id k6SH9EDR064816
	for perforce@freebsd.org; Fri, 28 Jul 2006 17:09:14 GMT
	(envelope-from gabor@FreeBSD.org)
Date: Fri, 28 Jul 2006 17:09:14 GMT
Message-Id: <200607281709.k6SH9EDR064816@repoman.freebsd.org>
X-Authentication-Warning: repoman.freebsd.org: perforce set sender to
	gabor@FreeBSD.org using -f
From: Gabor Kovesdan <gabor@FreeBSD.org>
To: Perforce Change Reviews <perforce@FreeBSD.org>
Cc: 
Subject: PERFORCE change 102664 for review
X-BeenThere: p4-projects@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: p4 projects tree changes <p4-projects.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/p4-projects>,
	<mailto:p4-projects-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/p4-projects>
List-Post: <mailto:p4-projects@freebsd.org>
List-Help: <mailto:p4-projects-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/p4-projects>,
	<mailto:p4-projects-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Fri, 28 Jul 2006 17:09:15 -0000

http://perforce.freebsd.org/chv.cgi?CH=102664

Change 102664 by gabor@gabor_spitfire on 2006/07/28 17:08:30

	Document WITH_DEBUG.

Affected files ...

.. //depot/projects/soc2006/gabor_docs/porters-handbook/book.sgml#11 edit

Differences ...

==== //depot/projects/soc2006/gabor_docs/porters-handbook/book.sgml#11 (text+ko) ====

@@ -4117,6 +4117,25 @@
     <sect1 id="building">
       <title>Building mechanisms</title>
 
+      <sect2 id="with-debug">
+        <title>Building binaries for debugging purposes with
+	  <makevar>WITH_DEBUG</makevar></title>
+
+	<para>If you need to build binaries with debug symbols, you can set
+	  <makevar>WITH_DEBUG</makevar>.  This adds <makevar>DEBUG_FLAGS</makevar>
+	  to <makevar>CFLAGS</makevar> and prevents <makevar>INSTALL_PROGRAM</makevar>
+	  from stripping binaries when installing.  <makevar>DEBUG_FLAGS</makevar> is
+	  set to "-g" at default, but you can override this if necessary.  Furthermore,
+	  ports could (and should) add their own specific things to build for
+	  debugging.</para>
+
+	<para>Note, that there are ports that do not respect our
+	  <makevar>INSTALL_PROGRAM</makevar> variable, so they will be still
+	  stripped even if <makevar>WITH_DEBUG</makevar> is set.  In these
+	  cases, you have to manually patch the port to work as intended.</para>
+
+      </sect2>
+
       <sect2 id="using-make">
 	<title><command>make</command>, <command>gmake</command>, and
 	  <command>imake</command></title>