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

106 lines
3.3 KiB
Makefile
Raw Normal View History

Allow absolute filenames for SUBST_FILES. Needed for converters/convmv and maybe some others.
2005-12-06 18:17:30 +01:00
# $NetBSD: subst.mk,v 1.26 2005/12/06 17:17:30 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
#
# The following variables are used:
#
* Document SUBST_CLASSES. * Indent conditionals. Reviewed By: wiz
2004-03-01 10:57:10 +01:00
# SUBST_CLASSES
# A list of class names. A new class name must be appended (+=).
#
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>
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
# The message to display when the substitution is done.
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;
# the filenames are 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>
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
# sed(1) substitution expression to run on the specified files.
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
#
# SUBST_POSTCMD.<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
# Command to clean up after sed(1). Defaults to ${RM} -f
Use _SUBST_BACKUP_SUFFIX instead of hardcoding ".subst.sav" everywhere.
2004-08-23 18:35:11 +02:00
# $$file${_SUBST_BACKUP_SUFFIX}. For debugging, set it to ${DO_NADA}.
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
ECHO_SUBST_MSG?= ${ECHO}
Revert revision 1.5 as binaries and directories are now being substed unintentionally. Also revert revision 1.6 as part of the overall change, as I suspect the change might be unnecessary. While I'm not 100% sure, this does just revert to the previous behaviour.
2003-12-28 18:28:26 +01:00
# _SUBST_IS_TEXT_FILE returns 0 if $${file} is a text file.
_SUBST_IS_TEXT_FILE?= \
Fixed shell quoting. Reviewed by jlam.
2005-05-17 21:01:36 +02:00
{ ${TEST} -f "$$file" \
&& ${FILE_CMD} "$$file" \
| ${EGREP} "(executable .* script|shell script|text)"; \
} >/dev/null 2>&1
Revert revision 1.5 as binaries and directories are now being substed unintentionally. Also revert revision 1.6 as part of the overall change, as I suspect the change might be unnecessary. While I'm not 100% sure, this does just revert to the previous behaviour.
2003-12-28 18:28:26 +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
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_}?= ${SED} ${SUBST_SED.${_class_}}
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
SUBST_POSTCMD.${_class_}?= ${RM} -f "$$tmpfile"
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_}
_SUBST_TARGETS.${_class_}= subst-${_class_}-message
_SUBST_TARGETS.${_class_}+= ${_SUBST_COOKIE.${_class_}}
_SUBST_TARGETS.${_class_}+= subst-${_class_}-cookie
.ORDER: ${_SUBST_TARGETS.${_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_}
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_}
subst-${_class_}: ${_SUBST_TARGETS.${_class_}}
.PHONY: subst-${_class_}-message
subst-${_class_}-message:
* Document SUBST_CLASSES. * Indent conditionals. Reviewed By: wiz
2004-03-01 10:57:10 +01:00
. if defined(SUBST_MESSAGE.${_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
${_PKG_SILENT}${_PKG_DEBUG} \
Removed the quoting for SUBST_MESSAGE.<class>. Most packages unnecessarily define that inside double quotes.
2005-05-18 05:33:51 +02:00
${ECHO_SUBST_MSG} "=> "${SUBST_MESSAGE.${_class_}}
* Document SUBST_CLASSES. * Indent conditionals. Reviewed By: wiz
2004-03-01 10:57:10 +01: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_}-cookie
subst-${_class_}-cookie:
${_PKG_SILENT}${_PKG_DEBUG} \
${TOUCH} ${TOUCH_FLAGS} ${_SUBST_COOKIE.${_class_}}
${_SUBST_COOKIE.${_class_}}:
${_PKG_SILENT}${_PKG_DEBUG} \
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
cd ${WRKSRC:Q}; \
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}; \
if ${_SUBST_IS_TEXT_FILE}; then \
${MV} -f "$$file" "$$tmpfile" || exit 1; \
${CAT} "$$tmpfile" \
| ${SUBST_FILTER_CMD.${_class_}} \
> "$$file"; \
if ${TEST} -x "$$tmpfile"; then \
${CHMOD} +x "$$file"; \
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 \
${MV} -f "$$tmpfile" "$$file"; \
else \
${SUBST_POSTCMD.${_class_}}; \
${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
elif ${TEST} -f "$$file"; then \
A warning is printed for every non-text file. This helps in detecting broken file(1) databases. It also gives an indication of whether this test is necessary at all.
2005-11-18 00:17:02 +01:00
${ECHO_SUBST_MSG} "[subst.mk] WARNING: Ignoring non-text file \"$$file\"." 1>&2; \
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 \
${ECHO_SUBST_MSG} "[subst.mk] WARNING: Ignoring non-existant file \"$$file\"." 1>&2; \
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
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