Fri Mar 20 17:16:34 2020 UTC ()
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.


(rillig)
diff -r1.19 -r1.20 pkgsrc/mk/extract/bsd.extract-vars.mk
cvs diff -r1.19 -r1.20 pkgsrc/mk/extract/bsd.extract-vars.mk (expand / switch to unified diff)

--- pkgsrc/mk/extract/bsd.extract-vars.mk 2020/03/14 00:14:35 1.19
+++ pkgsrc/mk/extract/bsd.extract-vars.mk 2020/03/20 17:16:34 1.20
@@ -1,33 +1,40 @@ @@ -1,33 +1,40 @@
1# $NetBSD: bsd.extract-vars.mk,v 1.19 2020/03/14 00:14:35 gdt Exp $ 1# $NetBSD: bsd.extract-vars.mk,v 1.20 2020/03/20 17:16:34 rillig Exp $
 2#
 3# This file configures how a package extracts its distfiles after
 4# downloading them.
2# 5#
3# This Makefile fragment is included separately by bsd.pkg.mk and 6# This Makefile fragment is included separately by bsd.pkg.mk and
4# defines some variables which must be defined earlier than where 7# defines some variables which must be defined earlier than where
5# bsd.extract.mk is included. 8# bsd.extract.mk is included, which defines the other variables.
 9#
 10# Package-settable variables:
 11#
 12# EXTRACT_SUFX
 13# The suffix for the default distfile to be extracted.
 14# Defaults to ".tar.gz".
6# 15#
7# The following variables may be set by the package Makefile and 16# EXTRACT_ONLY
8# specify how extraction happens: 17# The list of distfiles relative to ${_DISTDIR} that are
 18# extracted. Defaults to ${DISTFILES}.
9# 19#
10# EXTRACT_ONLY is a list of distfiles relative to ${_DISTDIR} to 20# Only few packages need this variable. To extract some of the
11# extract and defaults to ${DISTFILES}. 21# distfiles into separate directories, see EXTRACT_DIR.
12# 22#
13# EXTRACT_SUFX is the suffix for the default distfile to be 23# EXTRACT_USING
14# extracted. The default suffix is ".tar.gz". 24# The tool used to extract tar/ustar-format archives when using
15# 25# EXTRACT_CMD_DEFAULT. The possible values are "bsdtar", "gtar",
16# EXTRACT_USING specifies the tool used to extract tar/ustar-format 26# "nbtar", and "pax". Defaults to "nbtar", which means the value
17# archives when using EXTRACT_CMD_DEFAULT. The possible values are 27# of ${TOOL_PLATFORM.tar}, which is typically an arbitrary
18# "bsdtar", "gtar", "nbtar", and "pax". 
19# By default, we use the "nbtar", which means the value of 
20# ${TOOL_PLATFORM.tar}, which is typically an arbitrary 
21# implementation already found on the platform. 28# implementation already found on the platform.
22# \todo: Decide if this is package-settable or user-settable or both. 29# \todo: Decide if this is package-settable or user-settable or both.
23 30
24_VARGROUPS+= extract 31_VARGROUPS+= extract
25_PKG_VARS.extract= EXTRACT_DIR EXTRACT_ONLY EXTRACT_SUFX EXTRACT_CMD \ 32_PKG_VARS.extract= EXTRACT_DIR EXTRACT_ONLY EXTRACT_SUFX EXTRACT_CMD \
26 EXTRACT_OPTS EXTRACT_USING EXTRACT_ELEMENTS 33 EXTRACT_OPTS EXTRACT_USING EXTRACT_ELEMENTS
27_SYS_VARS.extract= EXTRACT_CMD_DEFAULT 34_SYS_VARS.extract= EXTRACT_CMD_DEFAULT
28_LISTED_VARS.extract= EXTRACT_CMD EXTRACT_CMD_DEFAULT 35_LISTED_VARS.extract= EXTRACT_CMD EXTRACT_CMD_DEFAULT
29 36
30EXTRACT_ONLY?= ${DISTFILES} 37EXTRACT_ONLY?= ${DISTFILES}
31EXTRACT_SUFX?= .tar.gz 38EXTRACT_SUFX?= .tar.gz
32 39
33EXTRACT_USING?= nbtar 40EXTRACT_USING?= nbtar