From: espie <espie@openbsd.org>
Date: Tue, 16 May 2023 14:04:16 +0000 (+0000)
Subject: document extra parameter that's used by pkg_check
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=f902ef064951c8c38bdc4de1927e4b506c6679b3;p=openbsd

document extra parameter that's used by pkg_check
---

diff --git a/usr.sbin/pkg_add/OpenBSD/Mtree.pod b/usr.sbin/pkg_add/OpenBSD/Mtree.pod
index 55a13aca679..a500da88923 100644
--- a/usr.sbin/pkg_add/OpenBSD/Mtree.pod
+++ b/usr.sbin/pkg_add/OpenBSD/Mtree.pod
@@ -1,4 +1,4 @@
-$OpenBSD: Mtree.pod,v 1.1 2020/12/20 15:30:58 daniel Exp $
+$OpenBSD: Mtree.pod,v 1.2 2023/05/16 14:04:16 espie Exp $
 
 =head1 NAME
 
@@ -10,19 +10,21 @@ OpenBSD::Mtree - simple C<mtree(8)> spec parser
 
     my %hier;
 
-    OpenBSD::Mtree::parse(\%hier, "/", "/etc/mtree/4.4BSD.dist");
+    OpenBSD::Mtree::parse(\%hier, "/", "/etc/mtree/4.4BSD.dist", $extra);
 
 =head1 DESCRIPTION
 
 C<OpenBSD::Mtree> is a parser for C<mtree(8)> specifications that
 can reconstruct directory hierarchies.
 
-The basic function C<OpenBSD::Mtree::parse_fh(\%hash, $basedir, $fh)>
+The basic function C<OpenBSD::Mtree::parse_fh(\%hash, $basedir, $fh, $extra)>
 will populate the hash C<$hash> with defined entries for each directory
 seen while reading from C<$fh>, assuming the specification is to be interpreted
 relative to C<$basedir> (some canonicalization of directory names will
 occur).
 
-C<OpenBSD::Mtree:parse(\%hash, $basedir, $filename)> is a convenience
+If C<$extra> is non null, each entry will itself be an empty hash.
+
+C<OpenBSD::Mtree:parse(\%hash, $basedir, $filename, $extra)> is a convenience
 function which also handles opening the filehandle from C<$filename>
 and closing it after reading the specification.