kpriv/pkgsrc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
pkgsrc/mk/subst.mk

143 lines
4.6 KiB
Makefile
Raw Normal View History

Allow package developers to easily see and check the SUBST changes.
2018-01-02 22:18:48 +01:00
# $NetBSD: subst.mk,v 1.56 2018/01/02 21:18:48 rillig Exp $
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
#
* Document SUBST_CLASSES. * Indent conditionals. Reviewed By: wiz
2004-03-01 10:57:10 +01:00
# This Makefile fragment implements a general text replacement facility.
Fixed a typo.
2005-06-09 21:49:48 +02:00
# Package makefiles define a ``class'', for each of which a particular
* Document SUBST_CLASSES. * Indent conditionals. Reviewed By: wiz
2004-03-01 10:57:10 +01:00
# substitution description can be defined. For each class of files, a
# target subst-<class> is created to perform the text replacement.
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
#
Clarify _who_ is supposed to set the SUBST_* variables.
2006-11-09 03:06:29 +01:00
# Package-settable variables:
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
#
* Document SUBST_CLASSES. * Indent conditionals. Reviewed By: wiz
2004-03-01 10:57:10 +01:00
# SUBST_CLASSES
Made the wording more into an explanation.
2008-01-23 02:44:28 +01:00
# A list of class names. When adding new classes to this list, be
# sure to append them (+=) instead of overriding them (=).
* Document SUBST_CLASSES. * Indent conditionals. Reviewed By: wiz
2004-03-01 10:57:10 +01:00
#
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
# SUBST_STAGE.<class>
Changed the comment for SUBST_STAGE to be more complete. Started the other sentences with an uppercase letter. No code changes.
2005-08-22 00:00:07 +02:00
# "stage" at which we do the text replacement. Should be one of
# {pre,do,post}-{extract,patch,configure,build,install}.
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
#
# SUBST_MESSAGE.<class>
If the package doesn't provide a SUBST_MESSAGE, generate a default one. This way, file modifications cannot go unnoticed and at least appear in the build logs. While here, fixed an ambiguity in the description of SUBST_MESSAGE.
2008-01-18 12:26:11 +01:00
# The message to display before doing the substitution.
Usually there's no need to keep the original version of a file "foo" as "foo.subst.sav". Implement SUBST_POSTCMD, which by default cleans up these leftovers. If you need to keep them around, e.g. while debugging, set it to ${DO_NADA}. Remove superfluous whitespace in a comment.
2004-06-06 06:22:23 +02:00
#
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
# SUBST_FILES.<class>
Changed the comment for SUBST_STAGE to be more complete. Started the other sentences with an uppercase letter. No code changes.
2005-08-22 00:00:07 +02:00
# A list of file patterns on which to run the substitution;
Adjust comment about SUBST_FILES to match reality: absolute file names work as well.
2006-01-06 00:16:01 +01:00
# the filenames are either absolute or relative to ${WRKSRC}.
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
#
# SUBST_SED.<class>
Add note to SUBST_SED noting that -E is not a standard sed option. From Leonardo Taccari in followup to PR 48254.
2013-10-13 23:38:36 +02:00
# 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).
Allow a new variable SUBST_FILTER_CMD.<class> that is a command filter or pipeline that takes stdin, performs the substitions and writes the result to stdout. It defaults to ${SED} ${SUBST_SED.<class>}. Use this variable to replace the sed command with something else, like an awk process.
2003-10-07 12:19:09 +02:00
#
Since there are many cases where the string @FOO@ is replaced with the pkgsrc variable ${FOO}, there is now a shorter variant for it. Instead of defining SUBST_SED.*, just say SUBST_VARS.* = FOO.
2007-01-23 07:05:39 +01:00
# SUBST_VARS.<class>
# List of variables that are substituted whenever they appear in
# the form @VARNAME@. This is basically a short-cut for
#
# -e 's,@VARNAME@,${VARNAME},g'
#
Explicitly mentioned that both SUBST_SED and SUBST_VARS may be used in a class.
2007-11-20 00:38:03 +01:00
# also taking care of (most) quoting issues. You can use both
# SUBST_SED and SUBST_VARS in a single class.
Since there are many cases where the string @FOO@ is replaced with the pkgsrc variable ${FOO}, there is now a shorter variant for it. Instead of defining SUBST_SED.*, just say SUBST_VARS.* = FOO.
2007-01-23 07:05:39 +01:00
#
Allow a new variable SUBST_FILTER_CMD.<class> that is a command filter or pipeline that takes stdin, performs the substitions and writes the result to stdout. It defaults to ${SED} ${SUBST_SED.<class>}. Use this variable to replace the sed command with something else, like an awk process.
2003-10-07 12:19:09 +02:00
# SUBST_FILTER_CMD.<class>
Changed the comment for SUBST_STAGE to be more complete. Started the other sentences with an uppercase letter. No code changes.
2005-08-22 00:00:07 +02:00
# Filter used to perform the actual substitution on the specified
Allow a new variable SUBST_FILTER_CMD.<class> that is a command filter or pipeline that takes stdin, performs the substitions and writes the result to stdout. It defaults to ${SED} ${SUBST_SED.<class>}. Use this variable to replace the sed command with something else, like an awk process.
2003-10-07 12:19:09 +02:00
# files. Defaults to ${SED} ${SUBST_SED.<class>}.
Usually there's no need to keep the original version of a file "foo" as "foo.subst.sav". Implement SUBST_POSTCMD, which by default cleans up these leftovers. If you need to keep them around, e.g. while debugging, set it to ${DO_NADA}. Remove superfluous whitespace in a comment.
2004-06-06 06:22:23 +02:00
#
The new variable SUBST_SKIP_TEXT_CHECK.* can be set to "yes" to do the substitutions in all files, whether or not file(1) says they are text.
2007-01-14 18:05:02 +01:00
# 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".
#
Allow package developers to easily see and check the SUBST changes.
2018-01-02 22:18:48 +01:00
# 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
2008-01-26 16:23:21 +01:00
# See also:
# PLIST_SUBST
#
+ keyword "subst"
2007-01-04 00:35:13 +01:00
# Keywords: subst
#
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
For all those who are interested in the inner workings of pkgsrc, there is a new target "show-all" that fits to the existing "debug", "show-tools", "show-vars" targets. It prints a list of the variables that make up the public interface to pkgsrc. Running this target is especially useful if you want to do some things, you know that they must have been implemented but you don't know what it is called. It also shows the "class" of a variable (user-defined, package-defined, system-defined).
2007-03-15 23:54:24 +01:00
_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 \
Fixed subst.mk not to corrupt files Up to now, using subst.mk may have led to file corruption during active package development. This happened when a sed(1) command had a syntax error, in which case the whole sed(1) command was terminated, leaving an empty original file behind. This commit changes that behavior by applying the sed(1) commands to the original file and saving the result in a temporary file. Only after that succeeded is the original file overwritten. During this rewrite, SUBST_POSTCMD has been removed, since it was only used in one place (mk/wrapper), and since it relied on the exact sequence of the internal commands. No package in either main pkgsrc or pkgsrc-wip uses this variable right now.
2016-01-31 18:27:41 +01:00
SUBST_FILTER_CMD SUBST_SKIP_TEXT_CHECK
For all those who are interested in the inner workings of pkgsrc, there is a new target "show-all" that fits to the existing "debug", "show-tools", "show-vars" targets. It prints a list of the variables that make up the public interface to pkgsrc. Running this target is especially useful if you want to do some things, you know that they must have been implemented but you don't know what it is called. It also shows the "class" of a variable (user-defined, package-defined, system-defined).
2007-03-15 23:54:24 +01:00
_PKG_VARS.subst+= ${pv}.${c}
. endfor
.endfor
Simplified the code by reducing the number of different targets that are evaluated. Now the SUBST_MESSAGE is only printed once when the substitution is actually done. Before this change it had been printed also when the subst-<class> target had been invoked a second time, but the substitution didn't take place again, which had confused me. Also, converted the code to use ${WARNING_MSG} and ${STEP_MSG}.
2006-06-18 00:42:00 +02:00
ECHO_SUBST_MSG?= ${STEP_MSG}
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
Reverted the change from 1.29 to 1.30, as it had led to build failures in the "unwrap" class.
2006-01-08 02:07:35 +01:00
# _SUBST_IS_TEXT_FILE returns 0 if $${file} is a text file.
_SUBST_IS_TEXT_FILE?= \
Don't rely on file(1) to distinguish text files from binary files. This has proven too unreliable in the past. For example, some Makefile.in files were classified as "Quake I or II world or extension", just because they happen to start with the letters "PACK". This method was also subject to subtle differences in the locale. The new method counts the number of NUL bytes in the file. It does not depend on the locale settings. The -c option of wc(1) counts bytes, not characters, and tr(1), which may interpret multibyte sequences, is protected by LC_ALL. It should also work with the historical implementations of tr(1) that could not handle NUL bytes and discarded them, since this is exactly the intention. See also: * http://mail-index.netbsd.org/tech-pkg/2006/07/05/0000.html * PR 37793
2008-01-18 12:16:08 +01:00
{ nchars=`${WC} -c < "$$file"`; \
notnull=`LC_ALL=C ${TR} -d '\\0' < "$$file" | ${WC} -c`; \
[ "$$nchars" = "$$notnull" ] || ${FALSE} ; \
}
Reverted the change from 1.29 to 1.30, as it had led to build failures in the "unwrap" class.
2006-01-08 02:07:35 +01:00
Use _SUBST_BACKUP_SUFFIX instead of hardcoding ".subst.sav" everywhere.
2004-08-23 18:35:11 +02:00
_SUBST_BACKUP_SUFFIX= .subst.sav
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
.for _class_ in ${SUBST_CLASSES}
_SUBST_COOKIE.${_class_}= ${WRKDIR}/.subst_${_class_}_done
Fixed the quoting for SUBST_VARS.*. Now every character gets replaced properly. The regression test passes.
2007-03-07 22:27:59 +01:00
SUBST_FILTER_CMD.${_class_}?= ${SED} ${SUBST_SED.${_class_}}
Since there are many cases where the string @FOO@ is replaced with the pkgsrc variable ${FOO}, there is now a shorter variant for it. Instead of defining SUBST_SED.*, just say SUBST_VARS.* = FOO.
2007-01-23 07:05:39 +01:00
SUBST_VARS.${_class_}?= # none
If the package doesn't provide a SUBST_MESSAGE, generate a default one. This way, file modifications cannot go unnoticed and at least appear in the build logs. While here, fixed an ambiguity in the description of SUBST_MESSAGE.
2008-01-18 12:26:11 +01:00
SUBST_MESSAGE.${_class_}?= Substituting "${_class_}" in ${SUBST_FILES.${_class_}}
Fixed the quoting for SUBST_VARS.*. Now every character gets replaced properly. The regression test passes.
2007-03-07 22:27:59 +01:00
. for v in ${SUBST_VARS.${_class_}}
SUBST_FILTER_CMD.${_class_} += -e s,@${v}@,${${v}:S|\\|\\\\|gW:S|,|\\,|gW:S|&|\\\&|gW:Q},g
. endfor
Allow package developers to easily see and check the SUBST changes.
2018-01-02 22:18:48 +01:00
. if !empty(SUBST_SHOW_DIFF.${_class_}:Uno:M[Yy][Ee][Ss])
_SUBST_KEEP.${_class_}?= ${DIFF} -u "$$file" "$$tmpfile" || true
. endif
Fixed subst.mk not to corrupt files Up to now, using subst.mk may have led to file corruption during active package development. This happened when a sed(1) command had a syntax error, in which case the whole sed(1) command was terminated, leaving an empty original file behind. This commit changes that behavior by applying the sed(1) commands to the original file and saving the result in a temporary file. Only after that succeeded is the original file overwritten. During this rewrite, SUBST_POSTCMD has been removed, since it was only used in one place (mk/wrapper), and since it relied on the exact sequence of the internal commands. No package in either main pkgsrc or pkgsrc-wip uses this variable right now.
2016-01-31 18:27:41 +01:00
_SUBST_KEEP.${_class_}?= ${DO_NADA}
The new variable SUBST_SKIP_TEXT_CHECK.* can be set to "yes" to do the substitutions in all files, whether or not file(1) says they are text.
2007-01-14 18:05:02 +01:00
SUBST_SKIP_TEXT_CHECK.${_class_}?= no
.if !empty(SUBST_SKIP_TEXT_CHECK.${_class_}:M[Yy][Ee][Ss])
_SUBST_IS_TEXT_FILE.${_class_}= ${TRUE}
.else
_SUBST_IS_TEXT_FILE.${_class_}= ${_SUBST_IS_TEXT_FILE}
.endif
Allow a new variable SUBST_FILTER_CMD.<class> that is a command filter or pipeline that takes stdin, performs the substitions and writes the result to stdout. It defaults to ${SED} ${SUBST_SED.<class>}. Use this variable to replace the sed command with something else, like an awk process.
2003-10-07 12:19:09 +02:00
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
SUBST_TARGETS+= subst-${_class_}
Allow a new variable SUBST_FILTER_CMD.<class> that is a command filter or pipeline that takes stdin, performs the substitions and writes the result to stdout. It defaults to ${SED} ${SUBST_SED.<class>}. Use this variable to replace the sed command with something else, like an awk process.
2003-10-07 12:19:09 +02:00
. if defined(SUBST_STAGE.${_class_})
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
${SUBST_STAGE.${_class_}}: subst-${_class_}
Simplified the code by reducing the number of different targets that are evaluated. Now the SUBST_MESSAGE is only printed once when the substitution is actually done. Before this change it had been printed also when the subst-<class> target had been invoked a second time, but the substitution didn't take place again, which had confused me. Also, converted the code to use ${WARNING_MSG} and ${STEP_MSG}.
2006-06-18 00:42:00 +02:00
. else
SUBST_STAGE.* is currently not defined by all SUBST blocks, so disable PKG_FAIL_REASON in that case. It didn't have an effect anyway for normal builds, since subst.mk is included after checking PKG_FAIL_REASON. Discussed with jlam.
2006-06-22 22:45:48 +02:00
# SUBST_STAGE.* does not need to be defined.
#PKG_FAIL_REASON+= "SUBST_STAGE missing for ${_class_}."
Allow a new variable SUBST_FILTER_CMD.<class> that is a command filter or pipeline that takes stdin, performs the substitions and writes the result to stdout. It defaults to ${SED} ${SUBST_SED.<class>}. Use this variable to replace the sed command with something else, like an awk process.
2003-10-07 12:19:09 +02:00
. endif
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
.PHONY: subst-${_class_}
Simplified the code by reducing the number of different targets that are evaluated. Now the SUBST_MESSAGE is only printed once when the substitution is actually done. Before this change it had been printed also when the subst-<class> target had been invoked a second time, but the substitution didn't take place again, which had confused me. Also, converted the code to use ${WARNING_MSG} and ${STEP_MSG}.
2006-06-18 00:42:00 +02:00
subst-${_class_}: ${_SUBST_COOKIE.${_class_}}
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
Simplified the code by reducing the number of different targets that are evaluated. Now the SUBST_MESSAGE is only printed once when the substitution is actually done. Before this change it had been printed also when the subst-<class> target had been invoked a second time, but the substitution didn't take place again, which had confused me. Also, converted the code to use ${WARNING_MSG} and ${STEP_MSG}.
2006-06-18 00:42:00 +02:00
${_SUBST_COOKIE.${_class_}}:
If the package doesn't provide a SUBST_MESSAGE, generate a default one. This way, file modifications cannot go unnoticed and at least appear in the build logs. While here, fixed an ambiguity in the description of SUBST_MESSAGE.
2008-01-18 12:26:11 +01:00
. if !empty(SUBST_MESSAGE.${_class_})
Replaced _PKG_SILENT and _PKG_DEBUG with RUN.
2008-01-18 11:41:05 +01:00
${RUN} ${ECHO_SUBST_MSG} ${SUBST_MESSAGE.${_class_}:Q}
* Document SUBST_CLASSES. * Indent conditionals. Reviewed By: wiz
2004-03-01 10:57:10 +01:00
. endif
Replaced _PKG_SILENT and _PKG_DEBUG with RUN.
2008-01-18 11:41:05 +01:00
${RUN} cd ${WRKSRC:Q}; \
Change instances where we stored `shell command` in a make variable into variables that use the :sh modifier. This still causes expansion to only happen when referenced, and has the advantage of being :Q-safe. Bring back the changes from revision 1.19 of mk/subst.mk now that the problem noted above has been fixed. This passes the buildlink-unwrap regression test.
2005-05-20 23:36:05 +02:00
files=${SUBST_FILES.${_class_}:Q}; \
for file in $$files; do \
Allow absolute filenames for SUBST_FILES. Needed for converters/convmv and maybe some others.
2005-12-06 18:17:30 +01:00
case $$file in /*) ;; *) file="./$$file";; esac; \
Change instances where we stored `shell command` in a make variable into variables that use the :sh modifier. This still causes expansion to only happen when referenced, and has the advantage of being :Q-safe. Bring back the changes from revision 1.19 of mk/subst.mk now that the problem noted above has been fixed. This passes the buildlink-unwrap regression test.
2005-05-20 23:36:05 +02:00
tmpfile="$$file"${_SUBST_BACKUP_SUFFIX:Q}; \
Before running _SUBST_IS_TEXT_FILE on a file, make sure that the file exists.
2007-11-01 14:12:48 +01:00
if [ ! -f "$$file" ]; then \
${WARNING_MSG} "[subst.mk:${_class_}] Ignoring non-existent file \"$$file\"."; \
elif ${_SUBST_IS_TEXT_FILE.${_class_}}; then \
Fixed some cases where the exitcode of child processes has been ignored. This will cause package builds to fail instead of hiding bugs.
2006-01-01 23:52:16 +01:00
${SUBST_FILTER_CMD.${_class_}} \
Fixed subst.mk not to corrupt files Up to now, using subst.mk may have led to file corruption during active package development. This happened when a sed(1) command had a syntax error, in which case the whole sed(1) command was terminated, leaving an empty original file behind. This commit changes that behavior by applying the sed(1) commands to the original file and saving the result in a temporary file. Only after that succeeded is the original file overwritten. During this rewrite, SUBST_POSTCMD has been removed, since it was only used in one place (mk/wrapper), and since it relied on the exact sequence of the internal commands. No package in either main pkgsrc or pkgsrc-wip uses this variable right now.
2016-01-31 18:27:41 +01:00
< "$$file" \
> "$$tmpfile"; \
if ${TEST} -x "$$file"; then \
${CHMOD} +x "$$tmpfile"; \
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
fi; \
Change instances where we stored `shell command` in a make variable into variables that use the :sh modifier. This still causes expansion to only happen when referenced, and has the advantage of being :Q-safe. Bring back the changes from revision 1.19 of mk/subst.mk now that the problem noted above has been fixed. This passes the buildlink-unwrap regression test.
2005-05-20 23:36:05 +02:00
if ${CMP} -s "$$tmpfile" "$$file"; then \
When a SUBST change leaves a file as-is, print an informational message. For all messages, the current SUBST_CLASS is printed, too.
2007-01-11 13:12:12 +01:00
${INFO_MSG} "[subst.mk:${_class_}] Nothing changed in $$file."; \
Fixed subst.mk not to corrupt files Up to now, using subst.mk may have led to file corruption during active package development. This happened when a sed(1) command had a syntax error, in which case the whole sed(1) command was terminated, leaving an empty original file behind. This commit changes that behavior by applying the sed(1) commands to the original file and saving the result in a temporary file. Only after that succeeded is the original file overwritten. During this rewrite, SUBST_POSTCMD has been removed, since it was only used in one place (mk/wrapper), and since it relied on the exact sequence of the internal commands. No package in either main pkgsrc or pkgsrc-wip uses this variable right now.
2016-01-31 18:27:41 +01:00
${RM} -f "$$tmpfile"; \
Change instances where we stored `shell command` in a make variable into variables that use the :sh modifier. This still causes expansion to only happen when referenced, and has the advantage of being :Q-safe. Bring back the changes from revision 1.19 of mk/subst.mk now that the problem noted above has been fixed. This passes the buildlink-unwrap regression test.
2005-05-20 23:36:05 +02:00
else \
Fixed subst.mk not to corrupt files Up to now, using subst.mk may have led to file corruption during active package development. This happened when a sed(1) command had a syntax error, in which case the whole sed(1) command was terminated, leaving an empty original file behind. This commit changes that behavior by applying the sed(1) commands to the original file and saving the result in a temporary file. Only after that succeeded is the original file overwritten. During this rewrite, SUBST_POSTCMD has been removed, since it was only used in one place (mk/wrapper), and since it relied on the exact sequence of the internal commands. No package in either main pkgsrc or pkgsrc-wip uses this variable right now.
2016-01-31 18:27:41 +01:00
${_SUBST_KEEP.${_class_}}; \
${MV} -f "$$tmpfile" "$$file"; \
Change instances where we stored `shell command` in a make variable into variables that use the :sh modifier. This still causes expansion to only happen when referenced, and has the advantage of being :Q-safe. Bring back the changes from revision 1.19 of mk/subst.mk now that the problem noted above has been fixed. This passes the buildlink-unwrap regression test.
2005-05-20 23:36:05 +02:00
${ECHO} "$$file" >> ${.TARGET}; \
fi; \
Added another diagnostic message to distinguish the cases for non-text file and non-existant file.
2005-11-24 21:02:40 +01:00
else \
Before running _SUBST_IS_TEXT_FILE on a file, make sure that the file exists.
2007-11-01 14:12:48 +01:00
${WARNING_MSG} "[subst.mk:${_class_}] Ignoring non-text file \"$$file\"."; \
Change instances where we stored `shell command` in a make variable into variables that use the :sh modifier. This still causes expansion to only happen when referenced, and has the advantage of being :Q-safe. Bring back the changes from revision 1.19 of mk/subst.mk now that the problem noted above has been fixed. This passes the buildlink-unwrap regression test.
2005-05-20 23:36:05 +02:00
fi; \
done
Replaced _PKG_SILENT and _PKG_DEBUG with RUN.
2008-01-18 11:41:05 +01:00
${RUN} ${TOUCH} ${TOUCH_FLAGS} ${.TARGET:Q}
subst.mk is a Makefile fragment that implements a general text replacement facility for different classes of files in ${WRKSRC}. For each class of files, a target <class>-subst is created to perform the text replacement. The following variables are used: SUBST_STAGE.<class> "stage" at which we do the text replacement, e.g. pre-configure, post-build, etc. SUBST_MESSAGE.<class> message to display, noting what is being substituted SUBST_FILES.<class> files on which to run the substitution; these are relative to ${WRKSRC} SUBST_SED.<class> sed(1) substitution expression to run on the specified files This basically extracts a useful piece of code from bsd.buildlink2.mk and puts it in a place that allows it to be more widely used, and so that the functionality doesn't depend on USE_BUILDLINK2 being defined.
2003-08-27 13:24:37 +02:00
.endfor
Reference in a new issue Copy permalink