1 DMBS - Dean's Makefile Build System
2 ===================================
8 The CORE module provides the core DMBS infrastructure used by other DMBS
9 modules, and must always be imported. Additionally, this module provides the
12 ## Importing This Module into a Makefile:
14 To use this module in your application makefile, add the following code to your
17 include $(DMBS_PATH)/core.mk
25 The following targets are supported by this module:
31 <td>Show help for the current project, including a list of all available targets, variables and macros from the imported modules.</td>
35 <td>Show a list of all build targets from the imported modules.</td>
39 <td>Show a list of all imported modules.</td>
42 <td>list_mandatory</td>
43 <td>Show a list of all mandatory variables from the imported modules.</td>
46 <td>list_optional</td>
47 <td>Show a list of all optional variables from the imported modules.</td>
50 <td>list_provided</td>
51 <td>Show a list of all variables provided by the imported modules.</td>
55 <td>Show a list of all macros provided by the imported modules.</td>
60 ## Mandatory Variables:
62 The following variables must be defined (with a `NAME = VALUE` syntax, one
63 variable per line) in the user makefile to be able to use this module:
69 <td>This module has no mandatory variables.</td>
74 ## Optional Variables:
76 The following variables may be defined (with a `NAME = VALUE` syntax, one
77 variable per line) in the user makefile. If not specified, a default value will
84 <td>This module has no optional variables.</td>
89 ## Provided Variables:
91 The following variables may be referenced in a user makefile (via `$(NAME)`
92 syntax) if desired, as they are provided by this module.
98 <td>Current version of this DMBS release, as a ISO 8601 integer (such as `20160403` for `2016-04-03`).</td>
105 The following macros may be referenced in a user makefile (via
106 `$(call NAME, ARG1, ARG2, ...)` syntax) if desired, as they are provided by
112 <td>DMBS_CHECK_VERSION</td>
113 <td>Macro to check the current DMBS version against the first argument and abort if the required version is newer than the current version.</td>
116 <td>ERROR_IF_UNSET</td>
117 <td>Macro to check the given makefile variable name passed as the first argument, and abort if it has not been set by any makefile module.</td>
120 <td>ERROR_IF_EMPTY</td>
121 <td>Macro to check the given makefile variable name passed as the first argument, and abort if it has an empty value.</td>
124 <td>ERROR_IF_NONBOOL</td>
125 <td>Macro to check the given makefile variable name passed as the first argument, and abort if it has a value other than `Y` or `N`.</td>
132 The changes to this module since its initial release are listed below, as of the
133 DMBS version where the change was made.