From: espie <espie@openbsd.org>
Date: Wed, 28 Jun 2017 10:33:08 +0000 (+0000)
Subject: document generate-readmes and diagnostic for missing PKGDIR.
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=b16945bdc2ff5c29e86883f1086c7700be4a7ef1;p=openbsd

document generate-readmes and diagnostic for missing PKGDIR.
---

diff --git a/share/man/man5/bsd.port.mk.5 b/share/man/man5/bsd.port.mk.5
index 93b518317ed..90fc52704f5 100644
--- a/share/man/man5/bsd.port.mk.5
+++ b/share/man/man5/bsd.port.mk.5
@@ -1,4 +1,4 @@
-.\" $OpenBSD: bsd.port.mk.5,v 1.462 2017/06/10 10:13:10 espie Exp $
+.\" $OpenBSD: bsd.port.mk.5,v 1.463 2017/06/28 10:33:08 espie Exp $
 .\"
 .\" Copyright (c) 2000-2008 Marc Espie
 .\"
@@ -24,7 +24,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: June 10 2017 $
+.Dd $Mdocdate: June 28 2017 $
 .Dt BSD.PORT.MK 5
 .Os
 .Sh NAME
@@ -355,6 +355,18 @@ but also fetches
 .Ev SUPDISTFILES ,
 for use with e.g.,
 .Cm makesum .
+.It Cm generate-readmes
+Generate READMEs and rc scripts from
+.Pa ${PKGDIR}
+into
+.Pa ${WRKINST} .
+Run after
+.Cm fake
+and before
+.Cm package
+or
+.Cm update-plist .
+Always rerun, as it is cheap enough.
 .It Cm index
 Top-level target, see
 .Xr ports 7 .
@@ -3102,6 +3114,16 @@ commands, but grouped here for convenience: easier to look for in
 .Xr dpb 1 Ns 's
 logs.
 .Bl -diag
+.It "/bin/sh: cd .../pkg - No such file or directory"
+Emitted during
+.Cm generate-readmes.
+.Pa ${PKGDIR}
+must point to an existing directory, so that
+.Nm
+can be certain there are no
+.Pa MESSAGEs
+or
+other files pertinent to the package.
 .It "Discovered old directory in ..."
 This message comes from
 .Xr make-plist 1 .
@@ -3408,8 +3430,10 @@ or
 .Pa ${PKGDIR}/*.rc
 get copied to
 .Pa ${WRKINST}
-at the end of
-.Cm fake
+right after the end of
+.Cm fake ,
+during
+.Cm generate-readmes
 (see the
 .Sx FILES
 section above for details).