CVS commit: pkgsrc/mk/extract

["Roland Illig" <rillig%netbsd.org@localhost>]

Module Name:    pkgsrc
Committed By:   rillig
Date:           Fri Mar 20 17:16:34 UTC 2020

Modified Files:
        pkgsrc/mk/extract: bsd.extract-vars.mk

Log Message:
mk/extract/bsd.extract-vars.mk: make documentation more user-friendly

The variables are now sorted chronologically instead of alphabetically,
to express the order in which the actions happen. The sentences are a bit
shorter than before.

The visual layout has been changed to make the whole variable name stick
out more. Before, the part that was easily visible was the same "EXTRACT_"
for all of them.


To generate a diff of this commit:
cvs rdiff -u -r1.19 -r1.20 pkgsrc/mk/extract/bsd.extract-vars.mk

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: pkgsrc/mk/extract/bsd.extract-vars.mk
diff -u pkgsrc/mk/extract/bsd.extract-vars.mk:1.19 pkgsrc/mk/extract/bsd.extract-vars.mk:1.20
--- pkgsrc/mk/extract/bsd.extract-vars.mk:1.19  Sat Mar 14 00:14:35 2020
+++ pkgsrc/mk/extract/bsd.extract-vars.mk       Fri Mar 20 17:16:34 2020
@@ -1,23 +1,30 @@
-# $NetBSD: bsd.extract-vars.mk,v 1.19 2020/03/14 00:14:35 gdt Exp $
+# $NetBSD: bsd.extract-vars.mk,v 1.20 2020/03/20 17:16:34 rillig Exp $
+#
+# This file configures how a package extracts its distfiles after
+# downloading them.
 #
 # This Makefile fragment is included separately by bsd.pkg.mk and
 # defines some variables which must be defined earlier than where
-# bsd.extract.mk is included.
+# bsd.extract.mk is included, which defines the other variables.
+#
+# Package-settable variables:
+#
+# EXTRACT_SUFX
+#      The suffix for the default distfile to be extracted.
+#      Defaults to ".tar.gz".
 #
-# The following variables may be set by the package Makefile and
-# specify how extraction happens:
+# EXTRACT_ONLY
+#      The list of distfiles relative to ${_DISTDIR} that are
+#      extracted.  Defaults to ${DISTFILES}.
 #
-#    EXTRACT_ONLY is a list of distfiles relative to ${_DISTDIR} to
-#      extract and defaults to ${DISTFILES}.
+#      Only few packages need this variable. To extract some of the
+#      distfiles into separate directories, see EXTRACT_DIR.
 #
-#    EXTRACT_SUFX is the suffix for the default distfile to be
-#       extracted.  The default suffix is ".tar.gz".
-#
-#    EXTRACT_USING specifies the tool used to extract tar/ustar-format
-#      archives when using EXTRACT_CMD_DEFAULT.  The possible values are
-#      "bsdtar", "gtar", "nbtar", and "pax".
-#      By default, we use the "nbtar", which means the value of
-#      ${TOOL_PLATFORM.tar}, which is typically an arbitrary
+# EXTRACT_USING
+#      The tool used to extract tar/ustar-format archives when using
+#      EXTRACT_CMD_DEFAULT. The possible values are "bsdtar", "gtar",
+#      "nbtar", and "pax". Defaults to "nbtar", which means the value
+#      of ${TOOL_PLATFORM.tar}, which is typically an arbitrary
 #      implementation already found on the platform.
 #    \todo: Decide if this is package-settable or user-settable or both.