From mel@datakitty.lan.rachie.is-a-geek.net  Sat Mar 31 20:09:09 2012
Return-Path: <mel@datakitty.lan.rachie.is-a-geek.net>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 0D67F1065670
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 31 Mar 2012 20:09:09 +0000 (UTC)
	(envelope-from mel@datakitty.lan.rachie.is-a-geek.net)
Received: from datakitty.lan.rachie.is-a-geek.net (rachie.is-a-geek.net [66.230.99.27])
	by mx1.freebsd.org (Postfix) with ESMTP id 894138FC0A
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 31 Mar 2012 20:09:06 +0000 (UTC)
Received: from datakitty.lan.rachie.is-a-geek.net (localhost [127.0.0.1])
	by datakitty.lan.rachie.is-a-geek.net (8.14.5/8.14.5) with ESMTP id q2VK8xKs096192
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 31 Mar 2012 12:08:59 -0800 (AKDT)
	(envelope-from mel@datakitty.lan.rachie.is-a-geek.net)
Received: (from mel@localhost)
	by datakitty.lan.rachie.is-a-geek.net (8.14.5/8.14.5/Submit) id q2VK8wEx096191;
	Sat, 31 Mar 2012 12:08:58 -0800 (AKDT)
	(envelope-from mel)
Message-Id: <201203312008.q2VK8wEx096191@datakitty.lan.rachie.is-a-geek.net>
Date: Sat, 31 Mar 2012 12:08:58 -0800 (AKDT)
From: Mel Flynn <rflynn@acsalaska.net>
Reply-To: Mel Flynn <rflynn@acsalaska.net>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [patch] Clarification for configuration file handling
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         166541
>Category:       docs
>Synopsis:       [patch] Clarification for configuration file handling
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    wblock
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Sat Mar 31 20:10:10 UTC 2012
>Closed-Date:    Mon Apr 02 20:33:45 UTC 2012
>Last-Modified:  Mon Apr  2 20:40:01 UTC 2012
>Originator:     Mel Flynn
>Release:        FreeBSD 8.2-STABLE amd64
>Organization:
>Environment:
System: FreeBSD datakitty.lan.rachie.is-a-geek.net 8.2-STABLE FreeBSD 8.2-STABLE #6 r230977: Sun Feb 5 06:20:11 AKST 2012 mel@datakitty.lan.rachie.is-a-geek.net:/data/obj/data/RELENG_8/src/sys/GENERIC amd64


>Description:
Section in the porter's handbook could use a bit more clarification
and most importantly what the common mistakes are and how to handle them.

>How-To-Repeat:
D.N.A.

>Fix:

--- configfiles-clarification.patch begins here ---
Index: en_US.ISO8859-1/books/porters-handbook/book.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v
retrieving revision 1.1173
diff -u -r1.1173 book.sgml
--- en_US.ISO8859-1/books/porters-handbook/book.sgml	22 Mar 2012 04:09:20 -0000	1.1173
+++ en_US.ISO8859-1/books/porters-handbook/book.sgml	31 Mar 2012 19:49:36 -0000
@@ -9378,14 +9378,19 @@
 		${CP} -p ${PREFIX}/etc/orbit.conf.sample ${PREFIX}/etc/orbit.conf ; \
 	fi</programlisting>
 
-      <para>Example of the <filename>pkg-plist</filename> part:</para>
+      <para>For each configuration file create the following tuple in
+      <filename>pkg-plist</filename>:</para>
 
       <programlisting>@unexec if cmp -s %D/etc/orbit.conf.sample %D/etc/orbit.conf; then rm -f %D/etc/orbit.conf; fi
 etc/orbit.conf.sample
 @exec if [ ! -f %D/etc/orbit.conf ] ; then cp -p %D/%F %B/orbit.conf; fi</programlisting>
 
-      <para>For information on the above variables see
-	&man.pkg.create.1;</para>
+      <para>The ordering is important, since the sample file still has
+      to exist in order to be compared upon deinstallation. Upon
+      installation, the sample file has to be extracted before it can be
+      copied. To debug any issues, temporarily remove the -s flag to
+      &man.cmp.1;. For information on the above variables see
+      &man.pkg.create.1;</para>
 
       <para>If there is a very good reason not to install a working
 	configuration file by default, use a <link
--- configfiles-clarification.patch ends here ---

>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->wblock 
Responsible-Changed-By: wblock 
Responsible-Changed-When: Sun Apr 1 00:05:16 UTC 2012 
Responsible-Changed-Why:  
Take. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=166541 
State-Changed-From-To: open->closed 
State-Changed-By: wblock 
State-Changed-When: Mon Apr 2 20:32:35 UTC 2012 
State-Changed-Why:  
Extended version of the provided patch committed. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=166541 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/166541: commit references a PR
Date: Mon,  2 Apr 2012 20:32:10 +0000 (UTC)

 wblock      2012-04-02 20:31:56 UTC
 
   FreeBSD doc repository
 
   Modified files:
     en_US.ISO8859-1/books/porters-handbook book.sgml 
   Log:
   Clarify the configuration files section.
   
   PR:             docs/166541
   Submitted by:   Mel Flynn
   
   Revision  Changes    Path
   1.1175    +25 -6     doc/en_US.ISO8859-1/books/porters-handbook/book.sgml
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
>Unformatted:
