From owner-freebsd-doc@FreeBSD.ORG  Sun May 23 12:48:09 2004
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP
	id E8A0116A4CE; Sun, 23 May 2004 12:48:09 -0700 (PDT)
Received: from Kain.sumuk.de (Kain.sumuk.de [213.221.86.114])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id DAD3F43D46; Sun, 23 May 2004 12:48:08 -0700 (PDT)
	(envelope-from vincent@sumuk.de)
Received: from Goliath.earth.sol (Goliath.earth.sol [192.168.1.6])
	by Kain.sumuk.de (8.12.10/8.12.10) with ESMTP id i4NJlst5065305;
	Sun, 23 May 2004 21:47:54 +0200 (CEST)
	(envelope-from vincent@sumuk.de)
Received: from Goliath.earth.sol (localhost.earth.sol [127.0.0.1])
	by Goliath.earth.sol (8.12.11/8.12.10) with ESMTP id i4NJlrO4030212;
	Sun, 23 May 2004 21:47:53 +0200 (CEST)
	(envelope-from vincent@Goliath.earth.sol)
Received: (from vincent@localhost)
	by Goliath.earth.sol (8.12.11/8.12.11/Submit) id i4NJlrxE030211;
	Sun, 23 May 2004 21:47:53 +0200 (CEST)
	(envelope-from vincent)
Date: Sun, 23 May 2004 21:47:53 +0200
From: Martin Heinen <martin@sumuk.de>
To: Mark Linimon <linimon@lonesome.com>
Message-ID: <20040523194753.GC29120@sumuk.de>
References: <Pine.LNX.4.44.0405221355320.15322-100000@pancho>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <Pine.LNX.4.44.0405221355320.15322-100000@pancho>
User-Agent: Mutt/1.4.1i
cc: freebsd-doc@freebsd.org
cc: freebsd-ports@freebsd.org
Subject: Re: RFC: minor change to Porter's Handbook
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sun, 23 May 2004 19:48:10 -0000

On Sat, May 22, 2004 at 01:57:13PM -0500, Mark Linimon wrote:

> +	<example id="dot-error-breaks-index"><title></title>
> +	  <para>Assume that someone has the line 
> +	    <programlisting>USE_POINTYHAT=yes</programlisting>
> +	    in <filename>make.conf</filename>.  The first of
> +	    the next two <filename>Makefile</filename> snippets will
> +	    cause <command>make index</command> to fail, while the
> +	    second one will not:
> +	    <programlisting>
> +.if USE_POINTYHAT
> +.error "POINTYHAT is not supported"
> +.endif
> +	    </programlisting>
> +	    <programlisting>
> +.if USE_POINTYHAT
> +IGNORE=POINTYHAT is not supported
> +.endif
> +	    </programlisting>
> +	  </para>
> +	</example>

As Simon already noted, white space is significant inside
programlisting and content should immediately follow the
opening tag.

The programlisting element is a block element which should
not be used inside other block elements.  I replaced
programlisting with literal in the running text, using
an option element would be an option too :-)

+	<example id="dot-error-breaks-index"><title></title>
+	  <para>Assume that someone has the line 
+	    <literal>USE_POINTYHAT=yes</literal>
+	    in <filename>make.conf</filename>.  The first of
+	    the next two <filename>Makefile</filename> snippets will
+	    cause <command>make index</command> to fail, while the
+	    second one will not:</para>
+
+	  <programlisting>.if USE_POINTYHAT
+.error "POINTYHAT is not supported"
+.endif</programlisting>
+
+	  <programlisting>.if USE_POINTYHAT
+IGNORE=POINTYHAT is not supported
+.endif</programlisting>
+	</example>

-- 
Marxpitn