From owner-freebsd-doc@FreeBSD.ORG Sat Mar 31 20:10:13 2012 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 90BCD1065676 for ; Sat, 31 Mar 2012 20:10:13 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 678AE8FC14 for ; Sat, 31 Mar 2012 20:10:13 +0000 (UTC) Received: from freefall.freebsd.org (localhost [127.0.0.1]) by freefall.freebsd.org (8.14.5/8.14.5) with ESMTP id q2VKAAQI002062 for ; Sat, 31 Mar 2012 20:10:10 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.5/8.14.5/Submit) id q2VKAAVq002061; Sat, 31 Mar 2012 20:10:10 GMT (envelope-from gnats) Resent-Date: Sat, 31 Mar 2012 20:10:10 GMT Resent-Message-Id: <201203312010.q2VKAAVq002061@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Mel Flynn Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 0D67F1065670 for ; 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 ; 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 ; 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 To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 Cc: Subject: docs/166541: [patch] Clarification for configuration file handling X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: Mel Flynn List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 31 Mar 2012 20:10:13 -0000 >Number: 166541 >Category: docs >Synopsis: [patch] Clarification for configuration file handling >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: change-request >Submitter-Id: current-users >Arrival-Date: Sat Mar 31 20:10:10 UTC 2012 >Closed-Date: >Last-Modified: >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 - Example of the pkg-plist part: + For each configuration file create the following tuple in + pkg-plist: @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 - For information on the above variables see - &man.pkg.create.1; + 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; If there is a very good reason not to install a working configuration file by default, use a Release-Note: >Audit-Trail: >Unformatted: