From 4070b125519e180a901b0c14d163885f3c375957 Mon Sep 17 00:00:00 2001
From: Bryan Drewery <bdrewery@FreeBSD.org>
Date: Sat, 12 Apr 2014 03:39:02 +0000
Subject: - Add a @sample plist keyword

  It accepts a file (must end in .sample, this is not configurable):

    @sample file.conf.sample

  This will install file.conf.sample and copy it to file.conf. The file.conf
  will be removed if it matches file.conf.sample on deinstall.

  This replaces older patterns of:

    @unexec if cmp -s %D/etc/pkgtools.conf %D/etc/pkgtools.conf.sample; then rm -f %D/etc/pkgtools.conf; fi
    etc/pkgtools.conf.sample
    @exec [ -f %B/pkgtools.conf ] || cp %B/%f %B/pkgtools.conf

  [1] This somewhat obsoletes work in ports/157168 which added CONF_FILES,
      but we have been moving towards more logic in pkg-plist where possible
      and less magical macros. Though this thinking does clash with autoplist
      ideas. We may still want CONF_FILES, which just drops a list of
      @sample entries into the plist anyway.
- Add a Keywords/pkg_install.awk and hook it into generate-plist. This is
  for pkg_install compatibility since it does not know how to read
  Keywords/sample.yaml.
  This file gives us a strategy to implement more keywords before
  pkg_install is EOL.
  Keywords are documented here:
  https://github.com/freebsd/pkg/commit/bffc31420b1fd6146a43c9abcd45109dd901198a
- This needs to be documented in PH and portlint support added still.

PR:		ports/157168 [1]
Discussed with:	bapt
Reviewed by:	bapt
Requested by:	many
With hat:	portmgr
---
 Keywords/pkg_install.awk | 31 +++++++++++++++++++++++++++++++
 Keywords/sample.yaml     | 29 +++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 Keywords/pkg_install.awk
 create mode 100644 Keywords/sample.yaml

(limited to 'Keywords')

diff --git a/Keywords/pkg_install.awk b/Keywords/pkg_install.awk
new file mode 100644
index 000000000000..e4207d744d03
--- /dev/null
+++ b/Keywords/pkg_install.awk
@@ -0,0 +1,31 @@
+# $FreeBSD$
+#
+# MAINTAINER: portmgr@FreeBSD.org
+#
+# This file handles converting keywords to pkg_install compatible format.
+# It will be removed once pkg_install is EOL.
+#
+
+#  @sample somefile.conf.sample
+# ->
+#  @comment begin @sample somefile.conf.sample
+#  @unexec if cmp -s %D/etc/somefile.conf %D/etc/somefile.conf.sample; then rm -f %D/etc/somefile.conf; fi
+#  etc/somefile.conf.sample
+#  @exec if ! [ -f %D/etc/somefile.conf ]; then cp %D/etc/somefile.conf.sample %D/etc/somefile.conf; fi
+#  @comment end @sample somefile.conf.sample
+# 
+$1 == "@sample" {
+  sample_file=$2
+  # Take out .sample
+  target_file=substr(sample_file, 0, length(sample_file) - 7)
+  print "@comment begin " $0
+  print "@unexec if cmp -s '%D/" target_file "' '%D/" sample_file "'; then rm -f '%D/" target_file "'; fi"
+  print sample_file
+  print "@exec if ! [ -f '%D/" target_file "' ]; then /bin/cp -p '%D/" sample_file "' '%D/" target_file "'; fi"
+  print "@comment end " $0
+  next
+}
+# Print everything else as-is
+{
+  print $0
+}
diff --git a/Keywords/sample.yaml b/Keywords/sample.yaml
new file mode 100644
index 000000000000..4d56793acca1
--- /dev/null
+++ b/Keywords/sample.yaml
@@ -0,0 +1,29 @@
+# $FreeBSD$
+#
+# MAINTAINER: portmgr@FreeBSD.org
+#
+# @sample etc/somefile.conf.sample
+#
+# This will install the somefile.conf.sample and automatically copy to
+# somefile.conf if it doesn't exist. On deinstall it will remove the
+# somefile.conf if it still matches the sample, otherwise it is
+# kept.
+#
+# This replaces the old pattern:
+#  @unexec if cmp -s %D/etc/pkgtools.conf %D/etc/pkgtools.conf.sample; then rm -f %D/etc/pkgtools.conf; fi
+#  etc/pkgtools.conf.sample
+#  @exec [ -f %B/pkgtools.conf ] || cp %B/%f %B/pkgtools.conf
+
+actions: [file]
+post-install: |
+  sample_file="%D/%@"
+  target_file="${sample_file%.sample}"
+  if ! [ -f "${target_file}" ]; then
+    /bin/cp -p "${sample_file}" "${target_file}"
+  fi
+pre-deinstall: |
+  sample_file="%D/%@"
+  target_file="${sample_file%.sample}"
+  if cmp -s "${target_file}" "${sample_file}"; then
+    rm -f "${target_file}"
+  fi
-- 
cgit v1.2.3