ec4d6a7c7f
All variables that are used or defined in the file are now listed in the
_VARGROUPS section.
The "is text file" command variable has been renamed since pkglint
thought the former variable name would specify a filename, not a shell
command.
The "is text file" command has been rewritten to only rely on tr(1)
instead of both tr(1) and wc(1). This makes it both simpler and maybe
also a little faster, since the file only has to be read once.
The SUBST_TARGETS variable has been removed since it is used nowhere
else. To get the list of all subst targets (should that ever be
necessary), use the expression ${SUBST_CLASSES:S,^,subst-,}.
150 lines
5 KiB
Makefile
150 lines
5 KiB
Makefile
# $NetBSD: subst.mk,v 1.61 2019/09/08 09:06:06 rillig Exp $
|
|
#
|
|
# The subst framework replaces text in one or more files in the WRKSRC
|
|
# directory. Packages can define several ``classes'' of replacements.
|
|
# Each such class defines:
|
|
#
|
|
# - in which stage of the build process the replacement happens
|
|
# - which files are affected by the replacement
|
|
# - which text or pattern is replaced by which replacement text
|
|
#
|
|
# A typical example is:
|
|
#
|
|
# SUBST_CLASSES+= prefix
|
|
# SUBST_STAGE.prefix= pre-configure
|
|
# SUBST_FILES.prefix= ./configure doc/*.html
|
|
# SUBST_SED.prefix= -e 's,/usr/local,${PREFIX},g'
|
|
#
|
|
# Package-settable variables:
|
|
#
|
|
# SUBST_CLASSES
|
|
# A list of class names. When adding new classes to this list, be
|
|
# sure to append them (+=) instead of overriding them (=).
|
|
#
|
|
# SUBST_STAGE.<class>
|
|
# "stage" at which we do the text replacement. Should be one of
|
|
# {pre,do,post}-{extract,patch,configure,build,install}.
|
|
#
|
|
# SUBST_MESSAGE.<class>
|
|
# The message to display before doing the substitution.
|
|
#
|
|
# SUBST_FILES.<class>
|
|
# A list of file patterns on which to run the substitution;
|
|
# the filenames are either absolute or relative to ${WRKSRC}.
|
|
#
|
|
# SUBST_SED.<class>
|
|
# List of sed(1) arguments to run on the specified files.
|
|
# Multiple commands can be specified using the -e option of sed.
|
|
# Do not use non-standard sed options (e.g. -E).
|
|
#
|
|
# SUBST_VARS.<class>
|
|
# List of variables that are substituted whenever they appear in
|
|
# the form @VARNAME@. This is basically a shortcut for
|
|
#
|
|
# -e 's,@VARNAME@,${VARNAME},g'
|
|
#
|
|
# that even works when ${VARNAME} contains arbitrary characters.
|
|
# Both SUBST_SED and SUBST_VARS can be used in a single class.
|
|
#
|
|
# SUBST_FILTER_CMD.<class>
|
|
# Filter used to perform the actual substitution on the specified
|
|
# files. Defaults to ${SED} ${SUBST_SED.<class>}.
|
|
#
|
|
# SUBST_SKIP_TEXT_CHECK.<class>
|
|
# By default, each file is checked whether it really is a text file
|
|
# before any substitutions are done to it. Since that test is not
|
|
# perfect, it can be disabled by setting this variable to "yes".
|
|
#
|
|
# SUBST_SHOW_DIFF.<class>
|
|
# During development of a package, this can be set to "yes" to see
|
|
# the actual changes as a unified diff.
|
|
#
|
|
# See also:
|
|
# PLIST_SUBST
|
|
#
|
|
# Keywords: subst
|
|
#
|
|
|
|
_VARGROUPS+= subst
|
|
_PKG_VARS.subst= SUBST_CLASSES
|
|
.for c in ${SUBST_CLASSES}
|
|
. for pv in SUBST_STAGE SUBST_MESSAGE SUBST_FILES SUBST_SED SUBST_VARS \
|
|
SUBST_FILTER_CMD SUBST_SKIP_TEXT_CHECK
|
|
_PKG_VARS.subst+= ${pv}.${c}
|
|
. endfor
|
|
.endfor
|
|
_DEF_VARS.subst= ECHO_SUBST_MSG
|
|
_USE_VARS.subst= WRKDIR WRKSRC
|
|
_IGN_VARS.subst= _SUBST_IS_TEXT_FILE_CMD
|
|
_SORTED_VARS.subst= SUBST_CLASSES SUBST_FILES.* SUBST_VARS.*
|
|
_LISTED_VARS.subst= SUBST_SED.* SUBST_FILTER_CMD.*
|
|
|
|
ECHO_SUBST_MSG?= ${STEP_MSG}
|
|
|
|
# _SUBST_IS_TEXT_FILE_CMD returns 0 if $$file is a text file.
|
|
_SUBST_IS_TEXT_FILE_CMD?= \
|
|
[ -z "`${TR} -cd '\\0' < "$$file" | ${TR} '\\0' 'x'`" ]
|
|
|
|
.for _class_ in ${SUBST_CLASSES}
|
|
_SUBST_COOKIE.${_class_}= ${WRKDIR}/.subst_${_class_}_done
|
|
|
|
SUBST_FILTER_CMD.${_class_}?= ${SED} ${SUBST_SED.${_class_}}
|
|
SUBST_VARS.${_class_}?= # none
|
|
SUBST_MESSAGE.${_class_}?= Substituting "${_class_}" in ${SUBST_FILES.${_class_}}
|
|
. for v in ${SUBST_VARS.${_class_}}
|
|
SUBST_FILTER_CMD.${_class_}+= -e s,@${v:C|[^A-Za-z0-9_]|\\\\&|gW:Q}@,${${v}:S|\\|\\\\|gW:S|,|\\,|gW:S|&|\\\&|gW:S|${.newline}|\\${.newline}|gW:Q},g
|
|
. endfor
|
|
. if !empty(SUBST_SHOW_DIFF.${_class_}:Uno:M[Yy][Ee][Ss])
|
|
_SUBST_KEEP.${_class_}?= ${DIFF} -u "$$file" "$$tmpfile" || true
|
|
. endif
|
|
_SUBST_KEEP.${_class_}?= ${DO_NADA}
|
|
SUBST_SKIP_TEXT_CHECK.${_class_}?= no
|
|
|
|
.if !empty(SUBST_SKIP_TEXT_CHECK.${_class_}:M[Yy][Ee][Ss])
|
|
_SUBST_IS_TEXT_FILE_CMD.${_class_}= ${TRUE}
|
|
.else
|
|
_SUBST_IS_TEXT_FILE_CMD.${_class_}= ${_SUBST_IS_TEXT_FILE_CMD}
|
|
.endif
|
|
|
|
. if defined(SUBST_STAGE.${_class_})
|
|
${SUBST_STAGE.${_class_}}: subst-${_class_}
|
|
. else
|
|
# SUBST_STAGE.* does not need to be defined.
|
|
#PKG_FAIL_REASON+= "SUBST_STAGE missing for ${_class_}."
|
|
. endif
|
|
|
|
.PHONY: subst-${_class_}
|
|
subst-${_class_}: ${_SUBST_COOKIE.${_class_}}
|
|
|
|
${_SUBST_COOKIE.${_class_}}:
|
|
. if !empty(SUBST_MESSAGE.${_class_})
|
|
${RUN} ${ECHO_SUBST_MSG} ${SUBST_MESSAGE.${_class_}:Q}
|
|
. endif
|
|
${RUN} cd ${WRKSRC:Q}; \
|
|
files=${SUBST_FILES.${_class_}:Q}; \
|
|
for file in $$files; do \
|
|
case $$file in /*) ;; *) file="./$$file";; esac; \
|
|
tmpfile="$$file.subst.sav"; \
|
|
if [ ! -f "$$file" ]; then \
|
|
${WARNING_MSG} "[subst.mk:${_class_}] Ignoring non-existent file \"$$file\"."; \
|
|
elif ${_SUBST_IS_TEXT_FILE_CMD.${_class_}}; then \
|
|
${SUBST_FILTER_CMD.${_class_}} \
|
|
< "$$file" \
|
|
> "$$tmpfile"; \
|
|
if ${TEST} -x "$$file"; then \
|
|
${CHMOD} +x "$$tmpfile"; \
|
|
fi; \
|
|
if ${CMP} -s "$$tmpfile" "$$file"; then \
|
|
${INFO_MSG} "[subst.mk:${_class_}] Nothing changed in $$file."; \
|
|
${RM} -f "$$tmpfile"; \
|
|
else \
|
|
${_SUBST_KEEP.${_class_}}; \
|
|
${MV} -f "$$tmpfile" "$$file"; \
|
|
${ECHO} "$$file" >> ${.TARGET}; \
|
|
fi; \
|
|
else \
|
|
${WARNING_MSG} "[subst.mk:${_class_}] Ignoring non-text file \"$$file\"."; \
|
|
fi; \
|
|
done
|
|
${RUN} ${TOUCH} ${TOUCH_FLAGS} ${.TARGET:Q}
|
|
.endfor
|