Bug 221841 - dns/void-zones-tools: Add pkg-message and install README.md
Summary: dns/void-zones-tools: Add pkg-message and install README.md
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Matthew Seaman
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-08-26 23:11 UTC by Vidar Karlsen
Modified: 2017-08-27 15:09 UTC (History)
1 user (show)

See Also:
vidar: maintainer-feedback+


Attachments
svn diff (3.27 KB, patch)
2017-08-26 23:11 UTC, Vidar Karlsen
no flags Details | Diff
Proposed additions to maintainer's patch (3.16 KB, patch)
2017-08-27 14:49 UTC, Matthew Seaman
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Vidar Karlsen 2017-08-26 23:11:31 UTC
Created attachment 185795 [details]
svn diff

dns/void-zones-tools comes with very little documentation.

This patch adds a pkg-message explaining how to get started, and installs the README.md file in ${DOCSDIR}.

Also: fixes the problem of the /usr/local/etc/my_void_hosts.txt template not getting created[1] by adding a new check to void-zones-update.sh.

[1] void-zones-update.sh checks if the dir /usr/local/etc/void-zones-tools exists, and if not, it creates it and installs the my_void_hosts.txt template into it. Since the port creates that dir during install, the shell script will never create the template.
Comment 1 Matthew Seaman freebsd_committer 2017-08-27 14:49:47 UTC
Created attachment 185816 [details]
Proposed additions to maintainer's patch

Hi,

What do you think about the following?  I just tweaked your patch so that
instead of referring to ${PREFIX} in pkg-message it substitutes in the actual
value of PREFIX the port is built with.  This is the usual practice in the ports.

Otherwise this all looks good.
Comment 2 Vidar Karlsen 2017-08-27 14:55:28 UTC
(In reply to Matthew Seaman from comment #1)

That does indeed look nicer, and I learned something new today (I was looking at some other ports to find out if/how such a substitution could be done, but didn't find anything).
Comment 3 Matthew Seaman freebsd_committer 2017-08-27 15:09:24 UTC
Great.

Commmitted, thanks!
Comment 4 commit-hook freebsd_committer 2017-08-27 15:09:44 UTC
A commit references this bug:

Author: matthew
Date: Sun Aug 27 15:08:57 UTC 2017
New revision: 448825
URL: https://svnweb.freebsd.org/changeset/ports/448825

Log:
  Add additional documentation and a pkg-message with further hints.

  PR:		221841
  Submitted by:	vidar@karlsen.tech (maintainer)

Changes:
  head/dns/void-zones-tools/Makefile
  head/dns/void-zones-tools/files/
  head/dns/void-zones-tools/files/patch-void-zones-update.sh
  head/dns/void-zones-tools/files/pkg-message.in
  head/dns/void-zones-tools/pkg-plist