From owner-freebsd-doc  Sun Feb  9 10:20:11 2003
Delivered-To: freebsd-doc@hub.freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 27B8437B401
	for <freebsd-doc@hub.freebsd.org>; Sun,  9 Feb 2003 10:20:09 -0800 (PST)
Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 5521B43FA3
	for <freebsd-doc@hub.freebsd.org>; Sun,  9 Feb 2003 10:20:08 -0800 (PST)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1])
	by freefall.freebsd.org (8.12.6/8.12.6) with ESMTP id h19IK8NS079662
	for <freebsd-doc@freefall.freebsd.org>; Sun, 9 Feb 2003 10:20:08 -0800 (PST)
	(envelope-from gnats@freefall.freebsd.org)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.12.6/8.12.6/Submit) id h19IK8dr079661;
	Sun, 9 Feb 2003 10:20:08 -0800 (PST)
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 77D7337B405
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  9 Feb 2003 10:13:32 -0800 (PST)
Received: from mired.org (ip68-97-54-220.ok.ok.cox.net [68.97.54.220])
	by mx1.FreeBSD.org (Postfix) with SMTP id 5E21F43FB1
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  9 Feb 2003 10:13:31 -0800 (PST)
	(envelope-from mwm@mired.org)
Received: (qmail 16894 invoked by uid 100); 9 Feb 2003 18:13:30 -0000
Message-Id: <20030209181330.16893.qmail@mired.org>
Date: 9 Feb 2003 18:13:30 -0000
From: Mike Meyer <mwm@mired.org>
Reply-To: Mike Meyer <mwm@mired.org>
To: FreeBSD-gnats-submit@FreeBSD.org
X-Send-Pr-Version: 3.113
Subject: docs/48111: [PATCH] Porters handbook uses wrong macro for strip
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-doc.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-doc>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-doc>
X-Loop: FreeBSD.org


>Number:         48111
>Category:       docs
>Synopsis:       [PATCH] Porters handbook uses wrong macro for strip
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Feb 09 10:20:07 PST 2003
>Closed-Date:
>Last-Modified:
>Originator:     Mike Meyer
>Release:        FreeBSD 4.7-STABLE i386
>Organization:
Meyer Consulting
>Environment:
System: FreeBSD guru.mired.org 4.7-STABLE FreeBSD 4.7-STABLE #17: Wed Oct 30 09:13:02 CST 2002 mwm@guru.mired.org:/sharetmp/obj/usr/src/sys/GURU i386

>Description:
	The porters handbook says to use the ${STRIP} macro to strip binaries
	(assuming you aren't using ${INSTALL_PROGRAM} to do it), but it
	really should use $(STRIP_CMD).
>How-To-Repeat:
	Read the porters handbook, and then try using it.
>Fix:

This patch fixes the porters handbook to recommend the proper macro.

--- book.sgml-orig	Sun Feb  9 12:10:13 2003
+++ book.sgml	Sun Feb  9 12:10:46 2003
@@ -4586,12 +4586,12 @@
 
         <para>If you need to strip a file, but do not wish to use the
           <makevar>INSTALL_PROGRAM</makevar> macro,
-          <makevar>${STRIP}</makevar> will strip your program.  This is
+          <makevar>${STRIP_CMD}</makevar> will strip your program.  This is
           typically done within the <literal>post-install</literal>
           target.  For example:</para>
 
         <programlisting>post-install:
-        ${STRIP} ${PREFIX}/bin/xdl</programlisting>
+        ${STRIP_CMD} ${PREFIX}/bin/xdl</programlisting>
 
         <para>Use the &man.file.1; command on the installed executable to
           check whether the binary is stripped or not.  If it does not say



>Release-Note:
>Audit-Trail:
>Unformatted:

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message