diff options
| author | Rüdiger Timm <rt@openoffice.org> | 2007-07-03 10:30:28 +0000 |
|---|---|---|
| committer | Rüdiger Timm <rt@openoffice.org> | 2007-07-03 10:30:28 +0000 |
| commit | 356711b5cf2ad42a14b3c3d93cc5684498de6470 (patch) | |
| tree | c8156519a34aea17b6c002c12cd8bcfcedc7e19c | |
| parent | 923416a04fb9e81bea067e5e69fbc8b99d70c569 (diff) | |
INTEGRATION: CWS dmake49 (1.8.2); FILE MERGED
2007/06/25 22:11:44 vq 1.8.2.4: #i78508# Release dmake 4.9.
2007/06/22 20:47:09 vq 1.8.2.3: #i78061# Add testcase and documentation.
2007/06/22 17:36:45 vq 1.8.2.2: #i74007# Add documentation to manpage.
2007/06/18 03:56:01 vq 1.8.2.1: #i78033# Document :i macro expansion.
| -rw-r--r-- | dmake/man/dmake.nc | 2162 |
1 files changed, 1076 insertions, 1086 deletions
diff --git a/dmake/man/dmake.nc b/dmake/man/dmake.nc index 6be22ee78057..de42d193cf1a 100644 --- a/dmake/man/dmake.nc +++ b/dmake/man/dmake.nc @@ -61,7 +61,7 @@ OPTIONS -Dmake Version 4.8 2007-04-24 1 +Dmake Version 4.9 2007-06-25 1 @@ -127,7 +127,7 @@ DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 2 +Dmake Version 4.9 2007-06-25 2 @@ -194,7 +194,7 @@ DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 3 +Dmake Version 4.9 2007-06-25 3 @@ -261,7 +261,7 @@ INDEX -Dmake Version 4.8 2007-04-24 4 +Dmake Version 4.9 2007-06-25 4 @@ -328,7 +328,7 @@ DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 5 +Dmake Version 4.9 2007-06-25 5 @@ -395,7 +395,7 @@ STARTUP -Dmake Version 4.8 2007-04-24 6 +Dmake Version 4.9 2007-06-25 6 @@ -462,7 +462,7 @@ DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 7 +Dmake Version 4.9 2007-06-25 7 @@ -529,7 +529,7 @@ SYNTAX -Dmake Version 4.8 2007-04-24 8 +Dmake Version 4.9 2007-06-25 8 @@ -596,7 +596,7 @@ DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 9 +Dmake Version 4.9 2007-06-25 9 @@ -663,7 +663,7 @@ DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 10 +Dmake Version 4.9 2007-06-25 10 @@ -732,7 +732,7 @@ ATTRIBUTES -Dmake Version 4.8 2007-04-24 11 +Dmake Version 4.9 2007-06-25 11 @@ -801,7 +801,7 @@ DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 12 +Dmake Version 4.9 2007-06-25 12 @@ -870,7 +870,7 @@ DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 13 +Dmake Version 4.9 2007-06-25 13 @@ -939,7 +939,7 @@ MACROS -Dmake Version 4.8 2007-04-24 14 +Dmake Version 4.9 2007-06-25 14 @@ -1008,7 +1008,7 @@ DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 15 +Dmake Version 4.9 2007-06-25 15 @@ -1055,65 +1055,76 @@ DMAKE(1) DMAKE(1) name less the final directory separator string. Thus successive pairs of :d modifiers each remove a level of directory in the token string. - The map escape codes modifier changes the following escape codes \a => - <bel>, \b => <backspace>, \f => <formfeed>, \n => <nl>, \r => <cr>, \t + The infered names of targets :i modifier returnes the actual filename + associated to the target, see BINDING TARGETS. If the value is not a + target or prerequisite the value is returned unchanged. For the follow- + ing example: + test = aprog bprog + If aprog and bprog are targets or prerequisits and they are bound to + /tmp/aprog and bprog (see .SOURCE special target) the macro expansion + has the following effect: + + $(test:i) -> /tmp/aprog bprog + + The map escape codes modifier changes the following escape codes \a => + <bel>, \b => <backspace>, \f => <formfeed>, \n => <nl>, \r => <cr>, \t => <tab>, \v => <vertical tab>, \" => ", and \xxx => <xxx> where xxx is - the octal representation of a character into the corresponding ASCII + the octal representation of a character into the corresponding ASCII value. - The tokenization, prepend and append modifier may use the same escape + The tokenization, prepend and append modifier may use the same escape codes that are supported by the map escape codes modifier in the string - that is inserted, prepended or added by the respective macro modifier. - These modifiers may quote this string to include otherwise problematic - characters. E.g. spaces, colons and parentheses. - The tokenization modifier takes all white space separated tokens from - the macro value and separates them by the separator string. Thus the - expansion: - $(test:f:t"+\n") - produces: - a.out+ +Dmake Version 4.9 2007-06-25 16 -Dmake Version 4.8 2007-04-24 16 +DMAKE(1) DMAKE(1) -DMAKE(1) DMAKE(1) + that is inserted, prepended or added by the respective macro modifier. + These modifiers may quote this string to include otherwise problematic + characters. E.g. spaces, colons and parentheses. + The tokenization modifier takes all white space separated tokens from + the macro value and separates them by the separator string. Thus the + expansion: + $(test:f:t"+\n") + produces: + a.out+ f.out+ k.out - The prefix operator ^ takes all white space separated tokens from the + The prefix operator ^ takes all white space separated tokens from the macro value and prepends string to each. $(test:f:^mydir/) produces: mydir/a.out mydir/f.out mydir/k.out - The suffix operator + takes all white space separated tokens from the + The suffix operator + takes all white space separated tokens from the macro value and appends string to each. $(test:b:+.c) produces: a.c f.c k.c - The next non-standard form of macro expansion allows for recursive - macros. It is possible to specify a $(macro_name) or ${macro_name} - expansion where macro_name contains more $( ... ) or ${ ... } macro + The next non-standard form of macro expansion allows for recursive + macros. It is possible to specify a $(macro_name) or ${macro_name} + expansion where macro_name contains more $( ... ) or ${ ... } macro expansions itself. - For example $(CC$(_HOST)$(_COMPILER)) will first expand - CC$(_HOST)$(_COMPILER) to get a result and use that result as the name + For example $(CC$(_HOST)$(_COMPILER)) will first expand + CC$(_HOST)$(_COMPILER) to get a result and use that result as the name of the macro to expand. This is useful for writing a makefile for more - than one target environment. As an example consider the following - hypothetical case. Suppose that _HOST and _COMPILER are imported from - the environment and are set to represent the host machine type and the + than one target environment. As an example consider the following + hypothetical case. Suppose that _HOST and _COMPILER are imported from + the environment and are set to represent the host machine type and the host compiler respectively. CFLAGS_VAX_CC = -c -O # _HOST == "_VAX", _COMPILER == "_CC" @@ -1123,45 +1134,45 @@ DMAKE(1) DMAKE(1) CFLAGS := $(CFLAGS$(_HOST)$(_COMPILER)) - This causes CFLAGS to take on a value that corresponds to the environ- + This causes CFLAGS to take on a value that corresponds to the environ- ment in which the make is being invoked. The final non-standard macro expansion is of the form: string1{token_list}string2 - where string1, string2 and token_list are expanded. After expansion, - string1 is prepended to each token found in token_list and string2 is - appended to each resulting token from the previous prepend. string1 - and string2 are not delimited by white space whereas the tokens in - token_list are. A null token in the token list is specified using "". - Thus using another example we have: + where string1, string2 and token_list are expanded. After expansion, + string1 is prepended to each token found in token_list and string2 is - test/{f1 f2}.o --> test/f1.o test/f2.o - test/ {f1 f2}.o --> test/ f1.o f2.o - test/{f1 f2} .o --> test/f1 test/f2 .o - test/{"f1" ""}.o --> test/f1.o test/.o - and +Dmake Version 4.9 2007-06-25 17 -Dmake Version 4.8 2007-04-24 17 +DMAKE(1) DMAKE(1) + appended to each resulting token from the previous prepend. string1 + and string2 are not delimited by white space whereas the tokens in + token_list are. A null token in the token list is specified using "". + Thus using another example we have: -DMAKE(1) DMAKE(1) + test/{f1 f2}.o --> test/f1.o test/f2.o + test/ {f1 f2}.o --> test/ f1.o f2.o + test/{f1 f2} .o --> test/f1 test/f2 .o + test/{"f1" ""}.o --> test/f1.o test/.o + and test/{d1 d2}/{f1 f2}.o --> test/d1/f1.o test/d1/f2.o test/d2/f1.o test/d2/f2.o - This last expansion is activated only when the first characters of + This last expansion is activated only when the first characters of token_list appear immediately after the opening '{' with no intervening - white space. The reason for this restriction is the following incom- + white space. The reason for this restriction is the following incom- patibility with Bourne Shell recipes. The line { echo hello;} @@ -1170,74 +1181,74 @@ DMAKE(1) DMAKE(1) {echo hello;} - is not. Hence the latter triggers the enhanced macro expansion while - the former causes it to be suppressed. See the SPECIAL MACROS section - for a description of the special macros that dmake defines and under- + is not. Hence the latter triggers the enhanced macro expansion while + the former causes it to be suppressed. See the SPECIAL MACROS section + for a description of the special macros that dmake defines and under- stands. RULES AND TARGETS - A makefile contains a series of entries that specify dependencies. - Such entries are called target/prerequisite or rule definitions. Each + A makefile contains a series of entries that specify dependencies. + Such entries are called target/prerequisite or rule definitions. Each rule definition is optionally followed by a set of lines that provide a - recipe for updating any targets defined by the rule. Whenever dmake - attempts to bring a target up to date and an explicit recipe is pro- - vided with a rule defining the target, that recipe is used to update - the target. A rule definition begins with a line having the following + recipe for updating any targets defined by the rule. Whenever dmake + attempts to bring a target up to date and an explicit recipe is pro- + vided with a rule defining the target, that recipe is used to update + the target. A rule definition begins with a line having the following syntax: <targets> [<attributes>] <ruleop> [<prerequisites>] [;<recipe>] - targets is a non-empty list of targets. If the target is a special + targets is a non-empty list of targets. If the target is a special target (see SPECIAL TARGETS section below) then it must appear alone on the rule line. For example: .IMPORT .ERROR : ... is not allowed since both .IMPORT and .ERROR are special targets. Spe- - cial targets are not used in the construction of the dependency graph + cial targets are not used in the construction of the dependency graph and will not be made. - attributes is a possibly empty list of attributes. Any attribute + attributes is a possibly empty list of attributes. Any attribute defined in the ATTRIBUTES section above may be specified. All - attributes will be applied to the list of named targets in the rule + attributes will be applied to the list of named targets in the rule definition. No other targets will be affected. - NOTE: As stated earlier, if both the target list and prerequisite - list are empty but the attributes list is not, then the speci- - fied attributes affect all targets in the makefile. +Dmake Version 4.9 2007-06-25 18 - ruleop is a separator which is used to identify the targets from the - prerequisites. Optionally it also provides a facility for modifying - the way in which dmake handles the making of the associated targets. - In its simplest form the operator is a single ':', and need not be sep- - arated by white space from its neighboring tokens. It may additionally - be followed by any of the modifiers { !, ^, -, :, | }, where: -Dmake Version 4.8 2007-04-24 18 +DMAKE(1) DMAKE(1) + NOTE: As stated earlier, if both the target list and prerequisite + list are empty but the attributes list is not, then the speci- + fied attributes affect all targets in the makefile. -DMAKE(1) DMAKE(1) + ruleop is a separator which is used to identify the targets from the + prerequisites. Optionally it also provides a facility for modifying + the way in which dmake handles the making of the associated targets. + In its simplest form the operator is a single ':', and need not be sep- + arated by white space from its neighboring tokens. It may additionally + be followed by any of the modifiers { !, ^, -, :, | }, where: ! says execute the recipe for the associated targets once for each - out of date prerequisite. (The meaning of the runtime macro $? + out of date prerequisite. (The meaning of the runtime macro $? is changed, see below in the RUNTIME MACROS section.) Ordinarily the recipe is executed once for all out of date prerequisites at the same time. - ^ says to insert the specified prerequisites, if any, before any - other prerequisites already associated with the specified tar- - gets. In general, it is not useful to specify ^ with an empty + ^ says to insert the specified prerequisites, if any, before any + other prerequisites already associated with the specified tar- + gets. In general, it is not useful to specify ^ with an empty list of prerequisites. - - says to clear the previous list of prerequisites before adding + - says to clear the previous list of prerequisites before adding the new prerequisites. Thus, foo : @@ -1249,54 +1260,54 @@ DMAKE(1) DMAKE(1) however the old form still works as expected. - : When the rule operator is not modified by a second ':' only one - set of rules may be specified for making a target. Multiple + : When the rule operator is not modified by a second ':' only one + set of rules may be specified for making a target. Multiple definitions may be used to add to the list of prerequisites that - a target depends on. However, if a target is multiply defined - only one definition may specify a recipe for making the target. + a target depends on. However, if a target is multiply defined + only one definition may specify a recipe for making the target. - When a target's rule operator is modified by a second ':' (:: + When a target's rule operator is modified by a second ':' (:: for example) then this definition may not be the only definition with a recipe for the target. There may be other :: target def- inition lines that specify a different set of prerequisites with - a different recipe for updating the target. Any such target is - made if any of the definitions find it to be out of date with - respect to the related prerequisites and the corresponding - recipe is used to update the target. By definition all '::' + a different recipe for updating the target. Any such target is + made if any of the definitions find it to be out of date with + respect to the related prerequisites and the corresponding + recipe is used to update the target. By definition all '::' recipes that are found to be out of date for are executed. - In the following simple example, each rule has a `::' ruleop. - In such an operator we call the first `:' the operator, and the + In the following simple example, each rule has a `::' ruleop. + In such an operator we call the first `:' the operator, and the second `:' the modifier. a.o :: a.c b.h - first recipe for making a.o - a.o :: a.y b.h - second recipe for making a.o - If a.o is found to be out of date with respect to a.c then the - first recipe is used to make a.o. If it is found out of date - with respect to a.y then the second recipe is used. If a.o is - out of date with respect to b.h then both recipes are invoked to - make a.o. In the last case the order of invocation corresponds - to the order in which the rule definitions appear in the make- - file. - | Is defined only for PERCENT rule target definitions. When spec- - ified it indicates that the following construct should be parsed +Dmake Version 4.9 2007-06-25 19 -Dmake Version 4.8 2007-04-24 19 +DMAKE(1) DMAKE(1) + first recipe for making a.o -DMAKE(1) DMAKE(1) + a.o :: a.y b.h + second recipe for making a.o + If a.o is found to be out of date with respect to a.c then the + first recipe is used to make a.o. If it is found out of date + with respect to a.y then the second recipe is used. If a.o is + out of date with respect to b.h then both recipes are invoked to + make a.o. In the last case the order of invocation corresponds + to the order in which the rule definitions appear in the make- + file. + | Is defined only for PERCENT rule target definitions. When spec- + ified it indicates that the following construct should be parsed using the old semantinc meaning: %.o :| %.c %.r %.f ; some rule @@ -1307,13 +1318,13 @@ DMAKE(1) DMAKE(1) %.o : %.r ; some rule %.o : %.f ; some rule - Targets defined using a single `:' operator with a recipe may be rede- - fined again with a new recipe by using a `:' operator with a `:' modi- - fier. This is equivalent to a target having been initially defined + Targets defined using a single `:' operator with a recipe may be rede- + fined again with a new recipe by using a `:' operator with a `:' modi- + fier. This is equivalent to a target having been initially defined with a rule using a `:' modifier. Once a target is defined using a `:' - modifier it may not be defined again with a recipe using only the `:' + modifier it may not be defined again with a recipe using only the `:' operator with no `:' modifier. In both cases the use of a `:' modifier - creates a new list of prerequisites and makes it the current prerequi- + creates a new list of prerequisites and makes it the current prerequi- site list for the target. The `:' operator with no recipe always modi- fies the current list of prerequisites. Thus assuming each of the fol- lowing definitions has a recipe attached, then: @@ -1326,8 +1337,8 @@ DMAKE(1) DMAKE(1) joe :: fred ... (3) joe :: more ... (4) - are legal and mean: add the recipe associated with (2), or (4) to the - set of recipes for joe, placing them after existing recipes for making + are legal and mean: add the recipe associated with (2), or (4) to the + set of recipes for joe, placing them after existing recipes for making joe. The constructs: joe :: fred ... (5) @@ -1338,67 +1349,68 @@ DMAKE(1) DMAKE(1) joe : fred ... (7) joe : more ... (8) - are errors since we have two sets of perfectly good recipes for making - the target. + are errors since we have two sets of perfectly good recipes for making - prerequisites is a possibly empty list of targets that must be brought - up to date before making the current target. - recipe is a short form and allows the user to specify short rule defi- - nitions on a single line. It is taken to be the first recipe line in a - larger recipe if additional lines follow the rule definition. If the - semi-colon is present but the recipe line is empty (ie. null string) - then it is taken to be an empty rule. Any target so defined causes the - Don't know how to make ... error message to be suppressed when dmake - tries to make the target and fails. This silence is maintained for - rules that are terminated by a semicolon and have no following recipe - lines, for targets listed on the command line, for the first target - found in the makefile, and for any target having no recipe but contain- - ing a list of prerequisites (see the COMPATIBILITY section for an - exception to this rule if the AUGMAKE (-A) flag was specified). +Dmake Version 4.9 2007-06-25 20 -Dmake Version 4.8 2007-04-24 20 +DMAKE(1) DMAKE(1) -DMAKE(1) DMAKE(1) + the target. + prerequisites is a possibly empty list of targets that must be brought + up to date before making the current target. + + recipe is a short form and allows the user to specify short rule defi- + nitions on a single line. It is taken to be the first recipe line in a + larger recipe if additional lines follow the rule definition. If the + semi-colon is present but the recipe line is empty (ie. null string) + then it is taken to be an empty rule. Any target so defined causes the + Don't know how to make ... error message to be suppressed when dmake + tries to make the target and fails. This silence is maintained for + rules that are terminated by a semicolon and have no following recipe + lines, for targets listed on the command line, for the first target + found in the makefile, and for any target having no recipe but contain- + ing a list of prerequisites (see the COMPATIBILITY section for an + exception to this rule if the AUGMAKE (-A) flag was specified). RECIPES The traditional format used by most versions of Make defines the recipe - lines as arbitrary strings that may contain macro expansions. They - follow a rule definition line and may be spaced apart by comment or - blank lines. The list of recipe lines defining the recipe is termi- - nated by a new target definition, a macro definition, or end-of-file. - Each recipe line MUST begin with a <TAB> character (or spaces, see + lines as arbitrary strings that may contain macro expansions. They + follow a rule definition line and may be spaced apart by comment or + blank lines. The list of recipe lines defining the recipe is termi- + nated by a new target definition, a macro definition, or end-of-file. + Each recipe line MUST begin with a <TAB> character (or spaces, see .NOTABS) which may optionally be followed with one or all the following recipe property characters '@%+-' which affect the recipe execution: - '-' indicates that non-zero exit values (ie. errors) are to be + '-' indicates that non-zero exit values (ie. errors) are to be ignored when this recipe line is executed. - '+' indicates that the current recipe line is to be executed using + '+' indicates that the current recipe line is to be executed using the shell. Group recipes implicitely ignore this property. '%' indicates that dmake should swap itself out to secondary storage (MSDOS only) before running the recipe. - '@' indicates that the recipe line should NOT be echoed to the ter- + '@' indicates that the recipe line should NOT be echoed to the ter- minal prior to being executed. - '@@' is a stronger version of the previous property. The recipe line - and the output (stdout and stderr) of the executed recipe are + '@@' is a stronger version of the previous property. The recipe line + and the output (stdout and stderr) of the executed recipe are NOT shown on the terminal. - Each property is off by default (ie. by default, errors are signifi- + Each property is off by default (ie. by default, errors are signifi- cant, commands are echoed, no swapping is done and a shell is used only - if the recipe line contains a character found in the value of the - SHELLMETAS macro). Global settings activated via command line options - or special attribute or target names may also affect these settings. + if the recipe line contains a character found in the value of the + SHELLMETAS macro). Global settings activated via command line options + or special attribute or target names may also affect these settings. An example recipe: target : @@ -1407,38 +1419,38 @@ RECIPES @a recipe line that is not echoed -and one that has errors ignored %and one that causes dmake to swap out - +and one that is executed using a shell. - The second and new format of the recipe block begins the block with the - character '[' (the open group character) in the last non-white space - position of a line, and terminates the block with the character ']' - (the close group character) in the first non-white space position of a - line. In this form each recipe line need not have a leading TAB. This - is called a recipe group. Groups so defined are fed intact as a single - unit to a shell for execution whenever the corresponding target needs - to be updated. If the open group character '[' is preceded by one or - all of the recipe properties (-, %, @ and @@) then they apply to the - entire group in the same way that they apply to single recipe lines. - You may also specify '+' but it is redundant as a shell is already - being used to run the recipe. See the MAKING TARGETS section for a - description of how dmake invokes recipes. Here is an example of a - group recipe: - target : - [ - first recipe line +Dmake Version 4.9 2007-06-25 21 -Dmake Version 4.8 2007-04-24 21 +DMAKE(1) DMAKE(1) -DMAKE(1) DMAKE(1) + +and one that is executed using a shell. + The second and new format of the recipe block begins the block with the + character '[' (the open group character) in the last non-white space + position of a line, and terminates the block with the character ']' + (the close group character) in the first non-white space position of a + line. In this form each recipe line need not have a leading TAB. This + is called a recipe group. Groups so defined are fed intact as a single + unit to a shell for execution whenever the corresponding target needs + to be updated. If the open group character '[' is preceded by one or + all of the recipe properties (-, %, @ and @@) then they apply to the + entire group in the same way that they apply to single recipe lines. + You may also specify '+' but it is redundant as a shell is already + being used to run the recipe. See the MAKING TARGETS section for a + description of how dmake invokes recipes. Here is an example of a + group recipe: + target : + [ + first recipe line second recipe line tall of these recipe lines are fed to a single copy of a shell for execution. @@ -1448,8 +1460,8 @@ DMAKE(1) DMAKE(1) BUILTIN COMMANDS dmake supports some builtin commands. An optional leading '+' describes that the builtin can be used also when being executed in a shell other- - wise it is only implemented when used directly. Remember that if a - character of the recipe is found in the SHELLMETAS macro the execution + wise it is only implemented when used directly. Remember that if a + character of the recipe is found in the SHELLMETAS macro the execution of the recipe in a shell is forced. [+]noop [something] @@ -1459,65 +1471,64 @@ BUILTIN COMMANDS the runtime of the recipe without starting a real commmand. [+]<empty recipe> - If an empty recipe line is encountered it is not executed. This - sounds more trivial than it really is because the recipe could - consist of macros that evaluated to empty or whitespace only + If an empty recipe line is encountered it is not executed. This + sounds more trivial than it really is because the recipe could + consist of macros that evaluated to empty or whitespace only strings. echo [-n] data - This internal command prints data (with all leading whitespace - removed, but otherwise literally) to stdout. If the '-n' switch + This internal command prints data (with all leading whitespace + removed, but otherwise literally) to stdout. If the '-n' switch is given no trailing newline is printed. Note that no quoting is removed nor that escape sequences are handled. - No special treatment of buildin commands for group recipes is imple- - mented even though the <empty recipe> will most propably also not be - evaluated by most shells that can be used to handle the recipe groups. + No special treatment of buildin commands for group recipes is imple- + mented even though the <empty recipe> will most propably also not be + evaluated by most shells that can be used to handle the recipe groups. TEXT DIVERSIONS - dmake supports the notion of text diversions. If a recipe line con- + dmake supports the notion of text diversions. If a recipe line con- tains the macro expression - $(mktmp[,[file][,text]] data) - - then all text contained in the data expression is expanded and is writ- - ten to a temporary file. The data in the file will always be termi- - nated from a new line character. The return value of the macro is the - name of the temporary file unless the text parameter is defined. In - this case the return value is the expanded value of text. - data can be any text and must be separated from the 'mktmp' portion of - the macro name by white-space. The only restriction on the data text - is that it must contain a balanced number of parentheses of the same - kind as are used to initiate the $(mktmp ...) expression. For example: - $(mktmp $(XXX)) +Dmake Version 4.9 2007-06-25 22 - is legal and works as expected, but: - $(mktmp text (to dump to file) - is not legal. You can achieve what you wish by either defining a macro +DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 22 + $(mktmp[,[file][,text]] data) + then all text contained in the data expression is expanded and is writ- + ten to a temporary file. The data in the file will always be termi- + nated from a new line character. The return value of the macro is the + name of the temporary file unless the text parameter is defined. In + this case the return value is the expanded value of text. + data can be any text and must be separated from the 'mktmp' portion of + the macro name by white-space. The only restriction on the data text + is that it must contain a balanced number of parentheses of the same + kind as are used to initiate the $(mktmp ...) expression. For example: + $(mktmp $(XXX)) -DMAKE(1) DMAKE(1) + is legal and works as expected, but: + $(mktmp text (to dump to file) + is not legal. You can achieve what you wish by either defining a macro that expands to '(' or by using {} in the macro expression; like this: ${mktmp text (to dump to file} - Since the temporary file is opened when the macro containing the text - diversion expression is expanded, diversions may be nested and any - diversions that are created as part of ':=' macro expansions persist - for the duration of the dmake run. If the data text is to contain new + Since the temporary file is opened when the macro containing the text + diversion expression is expanded, diversions may be nested and any + diversions that are created as part of ':=' macro expansions persist + for the duration of the dmake run. If the data text is to contain new lines the map escape codes macro expasion can be used. For example the expression: @@ -1529,8 +1540,8 @@ DMAKE(1) DMAKE(1) cat /tmp/mk12294AA - where the temporary file contains two lines both of which are termi- - nated by a new-line. A second more illustrative example generates a + where the temporary file contains two lines both of which are termi- + nated by a new-line. A second more illustrative example generates a response file to an MSDOS link command: OBJ = fred.obj mary.obj joe.obj @@ -1547,46 +1558,46 @@ DMAKE(1) DMAKE(1) mary.obj+ joe.obj - The last line of the file is terminated by a new-line which is always - inserted at the end of the data string. + The last line of the file is terminated by a new-line which is always - If the optional file specifier is present then its expanded value is - the name of the temporary file to create. An example that would be - useful for MSDOS users with a Turbo-C compiler - $(mktmp,turboc.cfg $(CFLAGS)) - will place the contents of CFLAGS into a local turboc.cfg file. The - second optional argument, text, if present alters the name of the value - returned by the $(mktmp ...) macro. +Dmake Version 4.9 2007-06-25 23 - Under MS-DOS text diversions may be a problem. Many DOS tools require - that path names which contain directories use the \ character to - delimit the directories. Some users however wish to use the '/' to - delimit pathnames and use environments that allow them to do so. The - macro USESHELL is set to "yes" if the current recipe is forced to use a - shell via the .USESHELL or '+' directives, otherwise its value is "no". - The dmake startup files define the macro DIVFILE whose value is either - the value of TMPFILE or the value of TMPFILE edited to replace any '/' - characters to the appropriate value based on the current shell and -Dmake Version 4.8 2007-04-24 23 +DMAKE(1) DMAKE(1) + inserted at the end of the data string. + If the optional file specifier is present then its expanded value is + the name of the temporary file to create. An example that would be + useful for MSDOS users with a Turbo-C compiler -DMAKE(1) DMAKE(1) + $(mktmp,turboc.cfg $(CFLAGS)) + will place the contents of CFLAGS into a local turboc.cfg file. The + second optional argument, text, if present alters the name of the value + returned by the $(mktmp ...) macro. + Under MS-DOS text diversions may be a problem. Many DOS tools require + that path names which contain directories use the \ character to + delimit the directories. Some users however wish to use the '/' to + delimit pathnames and use environments that allow them to do so. The + macro USESHELL is set to "yes" if the current recipe is forced to use a + shell via the .USESHELL or '+' directives, otherwise its value is "no". + The dmake startup files define the macro DIVFILE whose value is either + the value of TMPFILE or the value of TMPFILE edited to replace any '/' + characters to the appropriate value based on the current shell and whether it will be used to execute the recipe. - Previous versions of dmake defined text diversions using <+, +> - strings, where <+ started a text diversion and +> terminated one. - dmake is backward compatible with this construct only if the <+ and +> - appear literally on the same recipe line or in the same macro value + Previous versions of dmake defined text diversions using <+, +> + strings, where <+ started a text diversion and +> terminated one. + dmake is backward compatible with this construct only if the <+ and +> + appear literally on the same recipe line or in the same macro value string. In such instances the expression: <+data+> @@ -1595,161 +1606,161 @@ DMAKE(1) DMAKE(1) $(mktmp data) - which is fully output compatible with the earlier construct. <+, +> + which is fully output compatible with the earlier construct. <+, +> constructs whose text spans multiple lines must be converted by hand to use $(mktmp ...). - If the environment variable TMPDIR is defined then the temporary file - is placed into the directory specified by that variable. A makefile - can modify the location of temporary files by defining a macro named + If the environment variable TMPDIR is defined then the temporary file + is placed into the directory specified by that variable. A makefile + can modify the location of temporary files by defining a macro named TMPDIR and exporting it using the .EXPORT special target. SPECIAL TARGETS - This section describes the special targets that are recognized by + This section describes the special targets that are recognized by dmake. Some are affected by attributes and others are not. .ERROR If defined then the recipe associated with this target is - executed whenever an error condition is detected by - dmake. All attributes that can be used with any other - target may be used with this target. Any prerequisites + executed whenever an error condition is detected by + dmake. All attributes that can be used with any other + target may be used with this target. Any prerequisites of this target will be brought up to date during its pro- cessing. NOTE: errors will be ignored while making this target, in extreme cases this may cause some problems. - .EXIT If this target is encountered while parsing a makefile - then the parsing of the makefile is immediately termi- - nated at that point. + .EXIT If this target is encountered while parsing a makefile + then the parsing of the makefile is immediately - .EXPORT All prerequisites associated with this target are assumed - to correspond to macro names and they and their values - are exported to the environment as environment strings at - the point in the makefile at which this target appears. - Any attributes specified with this target are ignored. - Only macros which have been assigned a value in the make- - file prior to the export directive are exported, macros - as yet undefined or macros whose value contains any of - the characters "+=:*" are not exported. - Note that macros that are not expanded during the macro - assignment and contain other macros will be written into - the environment containing these other macros in the form - of $(macroname). - .IMPORT Prerequisite names specified for this target are searched - for in the environment and defined as macros with their - value taken from the environment. If the special name - .EVERYTHING is used as a prerequisite name then all envi- - ronment variables defined in the environment are +Dmake Version 4.9 2007-06-25 24 -Dmake Version 4.8 2007-04-24 24 +DMAKE(1) DMAKE(1) + terminated at that point. -DMAKE(1) DMAKE(1) + .EXPORT All prerequisites associated with this target are assumed + to correspond to macro names and they and their values + are exported to the environment as environment strings at + the point in the makefile at which this target appears. + Any attributes specified with this target are ignored. + Only macros which have been assigned a value in the make- + file prior to the export directive are exported, macros + as yet undefined or macros whose value contains any of + the characters "+=:*" are not exported. + Note that macros that are not expanded during the macro + assignment and contain other macros will be written into + the environment containing these other macros in the form + of $(macroname). + .IMPORT Prerequisite names specified for this target are searched + for in the environment and defined as macros with their + value taken from the environment. If the special name + .EVERYTHING is used as a prerequisite name then all envi- + ronment variables defined in the environment are imported. The functionality of the -E flag can be forced - by placing the construct .IMPORT : .EVERYTHING at the + by placing the construct .IMPORT : .EVERYTHING at the start of a makefile. Similarly, by placing the construct - at the end, one can emulate the effect of the -e command + at the end, one can emulate the effect of the -e command line flag. If a prerequisite name cannot be found in the - environment an error message is issued. .IMPORT accepts - the .IGNORE attribute. When given, it causes dmake to - ignore the above error. See the MACROS section for a + environment an error message is issued. .IMPORT accepts + the .IGNORE attribute. When given, it causes dmake to + ignore the above error. See the MACROS section for a description of the processing of imported macro values. - .INCLUDE Parse another makefile just as if it had been located at - the point of the .INCLUDE in the current makefile. The - list of prerequisites gives the list of makefiles to try - to read. If the list contains multiple makefiles then + .INCLUDE Parse another makefile just as if it had been located at + the point of the .INCLUDE in the current makefile. The + list of prerequisites gives the list of makefiles to try + to read. If the list contains multiple makefiles then they are read in order from left to right. The following search rules are used when trying to locate the file. If the filename is surrounded by " or just by itself then it - is searched for in the current directory. If it is not - found it is then searched for in each of the directories - specified as prerequisites of the .INCLUDEDIRS special - target. If the file name is surrounded by < and >, (ie. + is searched for in the current directory. If it is not + found it is then searched for in each of the directories + specified as prerequisites of the .INCLUDEDIRS special + target. If the file name is surrounded by < and >, (ie. <my_spiffy_new_makefile>) then it is searched for only in the directories given by the .INCLUDEDIRS special target. - In both cases if the file name is a fully qualified name - starting at the root of the file system then it is only - searched for once, and the .INCLUDEDIRS list is ignored. - If .INCLUDE fails to find the file it invokes the infer- + In both cases if the file name is a fully qualified name + starting at the root of the file system then it is only + searched for once, and the .INCLUDEDIRS list is ignored. + If .INCLUDE fails to find the file it invokes the infer- ence engine to try to infer and hence make the file to be - included. In this way the file can be checked out of an - RCS repository for example. .INCLUDE accepts the - .IGNORE, .SETDIR, and .NOINFER attributes. If the - .IGNORE attribute is given and the file cannot be found - then dmake continues processing, otherwise an error mes- - sage is generated. If the .NOINFER attribute is given - and the file cannot be found then dmake will not attempt + included. In this way the file can be checked out of an + RCS repository for example. .INCLUDE accepts the + .IGNORE, .SETDIR, and .NOINFER attributes. If the + .IGNORE attribute is given and the file cannot be found + then dmake continues processing, otherwise an error mes- + sage is generated. If the .NOINFER attribute is given + and the file cannot be found then dmake will not attempt to infer and make the file. The .SETDIR attribute causes - dmake to change directories to the specified directory - prior to attempting the include operation. If all fails - dmake attempts to make the file to be included. If mak- - ing the file fails then dmake terminates unless the - .INCLUDE directive also specified the .IGNORE attribute. - If .FIRST is specified along with .INCLUDE then dmake - attempts to include each named prerequisite and will ter- - minate the inclusion with the first prerequisite that - results in a successful inclusion. - .INCLUDEDIRS The list of prerequisites specified for this target - defines the set of directories to search when trying to - include a makefile. - .KEEP_STATE This special target is a synonym for the macro definition - .KEEP_STATE := _state.mk +Dmake Version 4.9 2007-06-25 25 - It's effect is to turn on STATE keeping and to define - _state.mk as the state file. - .MAKEFILES The list of prerequisites is the set of files to try to - read as the default makefile. By default this target is -Dmake Version 4.8 2007-04-24 25 +DMAKE(1) DMAKE(1) + dmake to change directories to the specified directory + prior to attempting the include operation. If all fails + dmake attempts to make the file to be included. If mak- + ing the file fails then dmake terminates unless the + .INCLUDE directive also specified the .IGNORE attribute. + If .FIRST is specified along with .INCLUDE then dmake + attempts to include each named prerequisite and will ter- + minate the inclusion with the first prerequisite that + results in a successful inclusion. + .INCLUDEDIRS The list of prerequisites specified for this target + defines the set of directories to search when trying to + include a makefile. + .KEEP_STATE This special target is a synonym for the macro definition -DMAKE(1) DMAKE(1) + .KEEP_STATE := _state.mk + It's effect is to turn on STATE keeping and to define + _state.mk as the state file. + .MAKEFILES The list of prerequisites is the set of files to try to + read as the default makefile. By default this target is defined as: .MAKEFILES : makefile.mk Makefile makefile .REMOVE The recipe of this target is used whenever dmake needs to - remove intermediate targets that were made but do not - need to be kept around. Such targets result from the + remove intermediate targets that were made but do not + need to be kept around. Such targets result from the application of transitive closure on the dependency graph. - .ROOT The internal root of the dependency graph, see section + .ROOT The internal root of the dependency graph, see section STARTUP for details. - .SOURCE The prerequisite list of this target defines a set of - directories to check when trying to locate a target file - name. See the section on BINDING of targets for more + .SOURCE The prerequisite list of this target defines a set of + directories to check when trying to locate a target file + name. See the section on BINDING of targets for more information. .SOURCE.suff The same as .SOURCE, except that the .SOURCE.suff list is - searched first when trying to locate a file matching the + searched first when trying to locate a file matching the a target whose name ends in the suffix .suff. - .SUFFIXES This deprecated special target has no special meaning. + .SUFFIXES This deprecated special target has no special meaning. Avoid its use. - .TARGETS The internal targets that all user defined targets are + .TARGETS The internal targets that all user defined targets are prerequisites of, see section STARTUP for details. There are a few targets that are "slightly" special: @@ -1757,139 +1768,138 @@ DMAKE(1) DMAKE(1) .INIT .DONE - These targets exist because of historical reasons, see the usage of - .INIT and .DONE in section "STARTUP", they can be used and defined as - ordinary targets but are special in the sense that even though they - start with a `.' they are not treated as a .<suffix> meta target (See - the AUGMAKE META RULES section for details). + These targets exist because of historical reasons, see the usage of - Please note that self defined targets shouldn't use the prefix `.' as - they would be handled as .<suffix> meta targets and dmake most propably - would complain about this. - In addition to the special targets above, several other forms of tar- - gets are recognized and are considered special, their exact form and - use is defined in the sections that follow. -SPECIAL MACROS - dmake defines a number of special macros. They are divided into three - classes: control macros, run-time macros, and function macros. The - control macros are used by dmake to configure its actions, and are the - preferred method of doing so. In the case when a control macro has the - same function as a special target or attribute they share the same name - as the special target or attribute. The run-time macros are defined - when dmake makes targets and may be used by the user inside recipes. - The function macros provide higher level functions dealing with macro - expansion and diversion file processing. +Dmake Version 4.9 2007-06-25 26 -Dmake Version 4.8 2007-04-24 26 +DMAKE(1) DMAKE(1) + .INIT and .DONE in section "STARTUP", they can be used and defined as + ordinary targets but are special in the sense that even though they + start with a `.' they are not treated as a .<suffix> meta target (See + the AUGMAKE META RULES section for details). + Please note that self defined targets shouldn't use the prefix `.' as + they would be handled as .<suffix> meta targets and dmake most propably + would complain about this. -DMAKE(1) DMAKE(1) + In addition to the special targets above, several other forms of tar- + gets are recognized and are considered special, their exact form and + use is defined in the sections that follow. +SPECIAL MACROS + dmake defines a number of special macros. They are divided into three + classes: control macros, run-time macros, and function macros. The + control macros are used by dmake to configure its actions, and are the + preferred method of doing so. In the case when a control macro has the + same function as a special target or attribute they share the same name + as the special target or attribute. The run-time macros are defined + when dmake makes targets and may be used by the user inside recipes. + The function macros provide higher level functions dealing with macro + expansion and diversion file processing. CONTROL MACROS - To use the control macros simply assign them a value just like any - other macro. The control macros are divided into three groups: string + To use the control macros simply assign them a value just like any + other macro. The control macros are divided into three groups: string valued macros, character valued macros, and boolean valued macros. - The following are all of the string valued macros. This list is - divided into two groups. The first group gives the string valued - macros that are defined internally and cannot be directly set by the + The following are all of the string valued macros. This list is + divided into two groups. The first group gives the string valued + macros that are defined internally and cannot be directly set by the user. - ABSMAKECMD Warning! This macro's value is differently defined for - a native Windows dmake executable (compiled with MS + ABSMAKECMD Warning! This macro's value is differently defined for + a native Windows dmake executable (compiled with MS Visual C++ or MinGW) and dmake for other operating sys- tems or build with other compilers. In the first case its value is the absolute filename of - the executable of the current dmake process, otherwise + the executable of the current dmake process, otherwise it is defined as the NULL string. - INCDEPTH This macro's value is a string of digits representing - the current depth of makefile inclusion. In the first + INCDEPTH This macro's value is a string of digits representing + the current depth of makefile inclusion. In the first makefile level this value is zero. - MFLAGS Is the list of flags that were given on the command + MFLAGS Is the list of flags that were given on the command line including a leading switch character. The -f flag is not included in this list. MAKECMD Is the name with which dmake was invoked. - MAKEDIR Is the full path to the initial directory in which + MAKEDIR Is the full path to the initial directory in which dmake was invoked. - MAKEFILE Contains the string "-f makefile" where, makefile is - the name of initial user makefile that was first read. + MAKEFILE Contains the string "-f makefile" where, makefile is + the name of initial user makefile that was first read. - MAKEFLAGS Is the same as $(MFLAGS) but has no leading switch - character. (ie. MFLAGS = -$(MAKEFLAGS)) - MAKEMACROS Contains the complete list of macro expressions that - were specified on the command line. - MAKETARGETS Contains the name(s) of the target(s), if any, that - were specified on the command line. +Dmake Version 4.9 2007-06-25 27 - MAKEVERSION Contains a string indicating the current dmake version - number. - MAXPROCESSLIMIT Is a numeric string representing the maximum number of - processes that dmake can use when making targets using - parallel mode. - NULL Is permanently defined to be the NULL string. This is - useful when comparing a conditional expression to an - NULL value. - PWD Is the full path to the current directory in which make - is executing. - - SPACECHAR Is permanently defined to contain one space character. - This is useful when using space characters in function +DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 27 + MAKEFLAGS Is the same as $(MFLAGS) but has no leading switch + character. (ie. MFLAGS = -$(MAKEFLAGS)) + MAKEMACROS Contains the complete list of macro expressions that + were specified on the command line. + MAKETARGETS Contains the name(s) of the target(s), if any, that + were specified on the command line. + MAKEVERSION Contains a string indicating the current dmake version + number. + MAXPROCESSLIMIT Is a numeric string representing the maximum number of + processes that dmake can use when making targets using + parallel mode. -DMAKE(1) DMAKE(1) + NULL Is permanently defined to be the NULL string. This is + useful when comparing a conditional expression to an + NULL value. + PWD Is the full path to the current directory in which make + is executing. - macros, e.g. subst, that otherwise would get deleted - (leading/trailing spaces) or for using spaces in func- + SPACECHAR Is permanently defined to contain one space character. + This is useful when using space characters in function + macros, e.g. subst, that otherwise would get deleted + (leading/trailing spaces) or for using spaces in func- tion macro parameters. - TMPFILE Is set to the name of the most recent temporary file - opened by dmake. Temporary files are used for text + TMPFILE Is set to the name of the most recent temporary file + opened by dmake. Temporary files are used for text diversions and for group recipe processing. - TMD Stands for "To Make Dir", and is the path from the - present directory (value of $(PWD)) to the directory - that dmake was started up in (value of $(MAKEDIR)). If - the present directory is the directory that dmake was + TMD Stands for "To Make Dir", and is the path from the + present directory (value of $(PWD)) to the directory + that dmake was started up in (value of $(MAKEDIR)). If + the present directory is the directory that dmake was started up in TMD will be set to the relative path ".". - This allows to create valid paths by prepending - $(TMD)$(DIRSEPSTR) to a relative path. This macro is - modified when .SETDIR attributes are processed. TMD - will usually be a relative path with the following two - exceptions. If the relative path would go up until the - root directory or if different drive letters (DOS file - system) make a relative path impossible the absolute + This allows to create valid paths by prepending + $(TMD)$(DIRSEPSTR) to a relative path. This macro is + modified when .SETDIR attributes are processed. TMD + will usually be a relative path with the following two + exceptions. If the relative path would go up until the + root directory or if different drive letters (DOS file + system) make a relative path impossible the absolute path from MAKEDIR is used. - USESHELL The value of this macro is set to "yes" if the current - recipe is forced to use a shell for its execution via + USESHELL The value of this macro is set to "yes" if the current + recipe is forced to use a shell for its execution via the .USESHELL or '+' directives, its value is "no" oth- erwise. @@ -1897,232 +1907,252 @@ DMAKE(1) DMAKE(1) The second group of string valued macros control dmake behavior and may be set by the user. - .DIRCACHE If set to "yes" enables the directory cache (this is - the default). If set to "no" disables the directory - cache (equivalent to -d command-line flag). + .DIRCACHE If set to "yes" enables the directory cache (this is + the default). If set to "no" disables the directory - .DIRCACHERESPCASE - If set to "yes" causes the directory cache, if enabled, - to respect file case, if set to "no" files are cached - case insensitive. By default it is set to "no" on Win- - dows as the filesystems on this operating system are - case insensitive and set to "yes" for all other operat- - ing systems. The default can be overriden, if desired. - Note: Using case insensitive directory caching on case - sensitive file systems is a BAD idea. If in doubt use - case sensitive directory caching even on case insensi- - tive file systems as the worst case in this scenario is - that /foo/bar/ and /foo/BAR/ are cached separately - (with the same content) even though they are the same - directory. This would only happen if different targets - use different upper/lower case spellings for the same - directory and that is never a good idea. - NAMEMAX Defines the maximum length of a filename component. - The value of the variable is initialized at startup to - the value of the compiled macro NAME_MAX. On some sys- - tems the value of NAME_MAX is too short by default. - Setting a new value for NAMEMAX will override the com- - piled value. +Dmake Version 4.9 2007-06-25 28 -Dmake Version 4.8 2007-04-24 28 +DMAKE(1) DMAKE(1) + cache (equivalent to -d command-line flag). + .DIRCACHERESPCASE + If set to "yes" causes the directory cache, if enabled, + to respect file case, if set to "no" files are cached + case insensitive. By default it is set to "no" on Win- + dows as the filesystems on this operating system are + case insensitive and set to "yes" for all other operat- + ing systems. The default can be overriden, if desired. -DMAKE(1) DMAKE(1) + Note: Using case insensitive directory caching on case + sensitive file systems is a BAD idea. If in doubt use + case sensitive directory caching even on case insensi- + tive file systems as the worst case in this scenario is + that /foo/bar/ and /foo/BAR/ are cached separately + (with the same content) even though they are the same + directory. This would only happen if different targets + use different upper/lower case spellings for the same + directory and that is never a good idea. + NAMEMAX Defines the maximum length of a filename component. + The value of the variable is initialized at startup to + the value of the compiled macro NAME_MAX. On some sys- + tems the value of NAME_MAX is too short by default. + Setting a new value for NAMEMAX will override the com- + piled value. - .NOTABS When set to "yes" enables the use of spaces as well as - <tabs> to begin recipe lines. By default a non-group - recipe is terminated by a line without any leading - white-space or by a line not beggining with a <tab> - character. Enabling this mode modifies the first con- - dition of the above termination rule to terminate a - non-group recipe with a line that contains only - white-space. This mode does not effect the parsing of + .NOTABS When set to "yes" enables the use of spaces as well as + <tabs> to begin recipe lines. By default a non-group + recipe is terminated by a line without any leading + white-space or by a line not beggining with a <tab> + character. Enabling this mode modifies the first con- + dition of the above termination rule to terminate a + non-group recipe with a line that contains only + white-space. This mode does not effect the parsing of group recipes bracketed by []. AUGMAKE If set to "yes" value will enable the transformation of - special meta targets to support special AUGMAKE infer- + special meta targets to support special AUGMAKE infer- ences (See the "AUGMAKE META RULES" and "COMPATIBILITY" sections). DIRBRKSTR Contains the string of chars used to terminate the name - of a directory in a pathname. Under UNIX its value is + of a directory in a pathname. Under UNIX its value is "/", under MSDOS its value is "/\:". - DIRSEPSTR Contains the string that is used to separate directory - components when path names are constructed. It is + DIRSEPSTR Contains the string that is used to separate directory + components when path names are constructed. It is defined with a default value at startup. - DIVFILE Is defined in the startup file and gives the name that - should be returned for the diversion file name when + DIVFILE Is defined in the startup file and gives the name that + should be returned for the diversion file name when used in $(mktmp ...) expansions, see the TEXT DIVERSION section for details. - .KEEP_STATE Assigning this macro a value tells dmake the name of + .KEEP_STATE Assigning this macro a value tells dmake the name of the state file to use and turns on the keeping of state information for any targets that are brought up to date - by the make. - GROUPFLAGS This macro gives the set of flags to pass to the shell - when invoking it to execute a group recipe. The value - of the macro is the list of flags with a leading switch - indicator. (ie. `-' under UNIX) - GROUPSHELL This macro defines the full path to the executable - image to be used as the shell when processing group - recipes. This macro must be defined if group recipes - are used. It is assigned a default value in the - startup makefile. Under UNIX this value is /bin/sh. - GROUPSUFFIX If defined, this macro gives the string to use as a - suffix when creating group recipe files to be handed to - the command interpreter. For example, if it is defined - as .sh, then all temporary files created by dmake will - end in the suffix .sh. Under MSDOS if you are using - command.com as your GROUPSHELL, then this suffix must - be set to .bat in order for group recipes to function - correctly. The setting of GROUPSUFFIX and GROUPSHELL - is done automatically for command.com in the startup.mk - files. +Dmake Version 4.9 2007-06-25 29 - MAKE Is defined in the startup file by default. Initially - this macro is defined to have the value "$(MAKECMD) - $(MFLAGS)". The string $(MAKE) is recognized when - using the -n switch. -Dmake Version 4.8 2007-04-24 29 +DMAKE(1) DMAKE(1) + by the make. + GROUPFLAGS This macro gives the set of flags to pass to the shell + when invoking it to execute a group recipe. The value + of the macro is the list of flags with a leading switch + indicator. (ie. `-' under UNIX) + GROUPSHELL This macro defines the full path to the executable + image to be used as the shell when processing group + recipes. This macro must be defined if group recipes + are used. It is assigned a default value in the + startup makefile. Under UNIX this value is /bin/sh. -DMAKE(1) DMAKE(1) + GROUPSUFFIX If defined, this macro gives the string to use as a + suffix when creating group recipe files to be handed to + the command interpreter. For example, if it is defined + as .sh, then all temporary files created by dmake will + end in the suffix .sh. Under MSDOS if you are using + command.com as your GROUPSHELL, then this suffix must + be set to .bat in order for group recipes to function + correctly. The setting of GROUPSUFFIX and GROUPSHELL + is done automatically for command.com in the startup.mk + files. + MAKE Is defined in the startup file by default. Initially + this macro is defined to have the value "$(MAKECMD) + $(MFLAGS)". The string $(MAKE) is recognized when + using the -n switch. MAKESTARTUP This macro defines the full path to the initial startup - makefile. Use the -V command line option to discover + makefile. Use the -V command line option to discover its initial value. MAXLINELENGTH This macro defines the maximum size of a single line of - makefile input text. The size is specified as a num- - ber, the default value is defined internally and is - shown via the -V option. A buffer of this size plus 2 - is allocated for reading makefile text. The buffer is - freed before any targets are made, thereby allowing + makefile input text. The size is specified as a num- + ber, the default value is defined internally and is + shown via the -V option. A buffer of this size plus 2 + is allocated for reading makefile text. The buffer is + freed before any targets are made, thereby allowing files containing long input lines to be processed with- - out consuming memory during the actual make. This + out consuming memory during the actual make. This macro can only be used to extend the line length beyond it's default minimum value. - MAXPROCESS Specify the maximum number of child processes to use - when making targets. The default value of this macro - is "1" and its value cannot exceed the value of the + MAXPROCESS Specify the maximum number of child processes to use + when making targets. The default value of this macro + is "1" and its value cannot exceed the value of the macro MAXPROCESSLIMIT. Setting the value of MAXPROCESS on the command line or in the makefile is equivalent to - supplying a corresponding value to the -P flag on the - command line. If the global .SEQUENTIAL attribute is - set (or the -S command line switch is used) the value + supplying a corresponding value to the -P flag on the + command line. If the global .SEQUENTIAL attribute is + set (or the -S command line switch is used) the value of MAXPROCESS is fixed to "1" and cannot be changed. - PREP This macro defines the number of iterations to be - expanded automatically when processing % rule defini- - tions of the form: + OOODMAKEMODE This macro enables a special compatibility mode needed + by the OpenOffice.org build system. If set, the switch + disables the removal of leading './' path elements dur- + ing target filename normalization (See BINDING - % : %.suff - See the sections on PERCENT(%) RULES for details on how - PREP is used. - SHELL This macro defines the full path to the executable - image to be used as the shell when processing single - line recipes. This macro must be defined if recipes - requiring the shell for execution are to be used. It - is assigned a default value in the startup makefile. - Under UNIX this value is /bin/sh. +Dmake Version 4.9 2007-06-25 30 - SHELLFLAGS This macro gives the set of flags to pass to the shell - when invoking it to execute a single line recipe. The - value of the macro is the list of flags with a leading - switch indicator. (ie. `-' under UNIX) - SHELLMETAS Each time dmake executes a single recipe line (not a - group recipe) the line is searched for any occurrence - of a character defined in the value of SHELLMETAS. If - such a character is found the recipe line is defined to - require a shell to ensure its correct execution. In - such instances a shell is used to invoke the recipe - line. If no match is found the recipe line is executed - without the use of a shell. - There is only one character valued macro defined by dmake: SWITCHAR - contains the switch character used to introduce options on command - lines. For UNIX its value is `-', and for MSDOS its value may be `/' - or `-'. The macro is internally defined and is not user setable. The +DMAKE(1) DMAKE(1) -Dmake Version 4.8 2007-04-24 30 + TARGETS). If './' appear in the pathname, but not at + the beginning of it, they are still removed by the nor- + malization. + PREP This macro defines the number of iterations to be + expanded automatically when processing % rule defini- + tions of the form: + % : %.suff + See the sections on PERCENT(%) RULES for details on how + PREP is used. + SHELL This macro defines the full path to the executable + image to be used as the shell when processing single + line recipes. This macro must be defined if recipes + requiring the shell for execution are to be used. It + is assigned a default value in the startup makefile. + Under UNIX this value is /bin/sh. -DMAKE(1) DMAKE(1) + SHELLFLAGS This macro gives the set of flags to pass to the shell + when invoking it to execute a single line recipe. The + value of the macro is the list of flags with a leading + switch indicator. (ie. `-' under UNIX) + SHELLMETAS Each time dmake executes a single recipe line (not a + group recipe) the line is searched for any occurrence + of a character defined in the value of SHELLMETAS. If + such a character is found the recipe line is defined to + require a shell to ensure its correct execution. In + such instances a shell is used to invoke the recipe + line. If no match is found the recipe line is executed + without the use of a shell. + + There is only one character valued macro defined by dmake: SWITCHAR + contains the switch character used to introduce options on command + lines. For UNIX its value is `-', and for MSDOS its value may be `/' + or `-'. The macro is internally defined and is not user setable. The MSDOS version of dmake attempts to first extract SWITCHAR from an envi- - ronment variable of the same name. If that fails it then attempts to + ronment variable of the same name. If that fails it then attempts to use the undocumented getswitchar system call, and returns the result of - that. Under MSDOS version 4.0 you must set the value of the environ- + that. Under MSDOS version 4.0 you must set the value of the environ- ment macro SWITCHAR to '/' to obtain predictable behavior. All boolean macros currently understood by dmake correspond directly to - the previously defined attributes. These macros provide a second way + the previously defined attributes. These macros provide a second way to apply global attributes, and represent the preferred method of doing - so. They are used by assigning them a value. If the value is not a + so. They are used by assigning them a value. If the value is not a NULL string then the boolean condition is set to on. If the value is a - NULL string then the condition is set to off. There are five condi- - tions defined and they correspond directly to the attributes of the + NULL string then the condition is set to off. There are five condi- + tions defined and they correspond directly to the attributes of the same name. Their meanings are defined in the ATTRIBUTES section above. - The macros are: .EPILOG, .IGNORE, .MKSARGS, .NOINFER, .PRECIOUS, .PRO- - LOG, .SEQUENTIAL, .SILENT, .SWAP, and .USESHELL. Assigning any of + The macros are: .EPILOG, .IGNORE, .MKSARGS, .NOINFER, .PRECIOUS, .PRO- + LOG, .SEQUENTIAL, .SILENT, .SWAP, and .USESHELL. Assigning any of these a non NULL value will globally set the corresponding attribute to on. + + + +Dmake Version 4.9 2007-06-25 31 + + + + + +DMAKE(1) DMAKE(1) + + RUNTIME MACROS - These macros are defined when dmake is making targets, and may take on - different values for each target. $@ is defined to be the full target + These macros are defined when dmake is making targets, and may take on + different values for each target. $@ is defined to be the full target name, $? is the list of all out of date prerequisites, except for the ! - ruleop, in which case it is set to the current build prerequisite - instead. $& is the list of all prerequisites, $> is the name of the - library if the current target is a library member, and $< is the list - of prerequisites specified in the current rule. If the current target - had a recipe inferred then $< is the name of the inferred prerequisite - even if the target had a list of prerequisites supplied using an - explicit rule that did not provide a recipe. In such situations $& + ruleop, in which case it is set to the current build prerequisite + instead. $& is the list of all prerequisites, $> is the name of the + library if the current target is a library member, and $< is the list + of prerequisites specified in the current rule. If the current target + had a recipe inferred then $< is the name of the inferred prerequisite + even if the target had a list of prerequisites supplied using an + explicit rule that did not provide a recipe. In such situations $& gives the full list of prerequisites. - $* is defined as $(@:db) when making targets with explicit recipes and - is defined as the value of % when making targets whose recipe is the - result of an inference. In the first case $* is the target name with - no suffix, and in the second case, is the value of the matched % pat- - tern from the associated %-rule. $^ expands to the set of out of date - prerequisites taken from the current value of $<. In addition to - these, $$ expands to $, {{ expands to {, }} expands to }, and the + $* is defined as $(@:db) when making targets with explicit recipes and + is defined as the value of % when making targets whose recipe is the + result of an inference. In the first case $* is the target name with + no suffix, and in the second case, is the value of the matched % pat- + tern from the associated %-rule. $^ expands to the set of out of date + prerequisites taken from the current value of $<. In addition to + these, $$ expands to $, {{ expands to {, }} expands to }, and the strings <+ and +> are recognized as respectively starting and terminat- - ing a text diversion when they appear literally together in the same + ing a text diversion when they appear literally together in the same input line. The difference between $? and $^ can best be illustrated by an example, @@ -2134,7 +2164,7 @@ RUNTIME MACROS fred.out : my.c your.h his.h her.h # more prerequisites Assume joe, amy, and my.c are newer then fred.out. When dmake executes - the recipe for making fred.out the values of the following macros will + the recipe for making fred.out the values of the following macros will be: $@ --> fred.out @@ -2145,46 +2175,47 @@ RUNTIME MACROS $& --> joe amy hello my.c your.h his.h her.h +FUNCTION MACROS + dmake supports a full set of functional macros. One of these, the + $(mktmp ...) macro, is discussed in detail in the TEXT DIVERSION sec- + tion and is not covered here. The names of function macros must appear + literally after the opening $( or ${. They are not recognized if they + are the result of a recursive expansion. + Note that some of these macros take comma separated parameters but that + these parameters must not contain literal whitespaces. Whitespaces in + macros used in these parameters are allowed. -Dmake Version 4.8 2007-04-24 31 + $(and macroterm ...) + expands each macroterm in turn until there are no more or + one of them returns an empty string. If all expand to +Dmake Version 4.9 2007-06-25 32 -DMAKE(1) DMAKE(1) -FUNCTION MACROS - dmake supports a full set of functional macros. One of these, the - $(mktmp ...) macro, is discussed in detail in the TEXT DIVERSION sec- - tion and is not covered here. The names of function macros must appear - literally after the opening $( or ${. They are not recognized if they - are the result of a recursive expansion. - Note that some of these macros take comma separated parameters but that - these parameters must not contain literal whitespaces. Whitespaces in - macros used in these parameters are allowed. +DMAKE(1) DMAKE(1) - $(and macroterm ...) - expands each macroterm in turn until there are no more or - one of them returns an empty string. If all expand to - non-empty strings the macro returs the string "t" other- + + non-empty strings the macro returs the string "t" other- wise it returns an empty string. $(assign expression) - Causes expression to be parsed as a macro assignment - expression and results in the specified assignment being - made. An error is issued if the assignment is not - syntatically correct. expression may contain white - space. This is in effect a dynamic macro assignment - facility and may appear anywhere any other macro may - appear. The result of the expanding a dynamic macro - assignment expression is the name of the macro that was - assigned and $(NULL) if the expression is not a valid + Causes expression to be parsed as a macro assignment + expression and results in the specified assignment being + made. An error is issued if the assignment is not + syntatically correct. expression may contain white + space. This is in effect a dynamic macro assignment + facility and may appear anywhere any other macro may + appear. The result of the expanding a dynamic macro + assignment expression is the name of the macro that was + assigned and $(NULL) if the expression is not a valid macro assignment expression. Some examples are: $(assign foo := fred) @@ -2195,19 +2226,19 @@ FUNCTION MACROS $(eq,text_a,text_b true false) expands text_a and text_b and compares their results. If - equal it returns the result of the expansion of the true - term, otherwise it returns the expansion of the false + equal it returns the result of the expansion of the true + term, otherwise it returns the expansion of the false term. $(!eq,text_a,text_b true false) Behaves identically to the previous macro except that the - true string is chosen if the expansions of the two + true string is chosen if the expansions of the two strings are not equal $(foreach,var,list data) - Implements iterative macro expansion over data using var - as the iterator taking on values from list. var and list - are expanded and the result is the concatenation of + Implements iterative macro expansion over data using var + as the iterator taking on values from list. var and list + are expanded and the result is the concatenation of expanding data with var being set to each whitespace sep- arated token from list. For example: @@ -2218,30 +2249,29 @@ FUNCTION MACROS [[a] [b] [c]] + The iterator variable is defined as a local variable to + this foreach instance. The following expression illus- + trates this: + $(foreach,i,$(foreach,i,$(sort c a b) root/$i) [$i/f.h]) + when evaluated the result is: -Dmake Version 4.8 2007-04-24 32 - + [root/a/f.h] [root/b/f.h] [root/c/f.h] + The specification of list must be a valid macro expres- + sion, such as: -DMAKE(1) DMAKE(1) +Dmake Version 4.9 2007-06-25 33 - The iterator variable is defined as a local variable to - this foreach instance. The following expression illus- - trates this: - $(foreach,i,$(foreach,i,$(sort c a b) root/$i) [$i/f.h]) - when evaluated the result is: - [root/a/f.h] [root/b/f.h] [root/c/f.h] +DMAKE(1) DMAKE(1) - The specification of list must be a valid macro expres- - sion, such as: $($(assign list=a b c)) $(sort d a b c) @@ -2259,71 +2289,71 @@ DMAKE(1) DMAKE(1) when evaluated. $(nil expression) - Always returns the value of $(NULL) regardless of what - expression is. This function macro can be used to dis- + Always returns the value of $(NULL) regardless of what + expression is. This function macro can be used to dis- card results of expanding macro expressions. $(not macroterm) expands macroterm and returs the string "t" if the result - of the expansion is the empty string; otherwise, it + of the expansion is the empty string; otherwise, it returns the empty string. $(null,text true false) - expands the value of text. If it is NULL then the macro + expands the value of text. If it is NULL then the macro returns the value of the expansion of true and the expan- - sion of false otherwise. The terms true, and false must + sion of false otherwise. The terms true, and false must be strings containing no white-space. $(!null,text true false) Behaves identically to the previous macro except that the - true string is chosen if the expansion of text is not + true string is chosen if the expansion of text is not NULL. $(or macroterm ...) - expands each macroterm in turn and returs the empty - string if each term expands to the empty string; other- + expands each macroterm in turn and returs the empty + string if each term expands to the empty string; other- wise, it returs the string "t". $(shell command) - is a shell escape macro. It runs command as if it were - part of a recipe and returns, separated by a single + is a shell escape macro. It runs command as if it were + part of a recipe and returns, separated by a single space, all the non-white space terms written to stdout by the command. For example: $(shell ls *.c) + will return "a.c b.c c.c d.c" if the files exist in the + current directory. The recipe modification flags [+@%-] + are honored if they appear as the first characters in the + command. For example: + $(shell +ls *.c) + will run the command using the current shell. -Dmake Version 4.8 2007-04-24 33 + Note that if the macro is part of a recipe it will be +Dmake Version 4.9 2007-06-25 34 -DMAKE(1) DMAKE(1) - will return "a.c b.c c.c d.c" if the files exist in the - current directory. The recipe modification flags [+@%-] - are honored if they appear as the first characters in the - command. For example: - $(shell +ls *.c) +DMAKE(1) DMAKE(1) - will run the command using the current shell. - Note that if the macro is part of a recipe it will be - evaluated after all previous recipe lines have been exe- - cuted. For obvious reasons it will be evaluated before + evaluated after all previous recipe lines have been exe- + cuted. For obvious reasons it will be evaluated before the current recipe line or group recipe is executed. $(shell,expand command) - Is an extension to the $(shell command) function macro + Is an extension to the $(shell command) function macro that expands the result of running command. $(sort list) - Will take all white-space separated tokens in list and + Will take all white-space separated tokens in list and will return their sorted equivalent list. $(strip data) @@ -2331,7 +2361,7 @@ DMAKE(1) DMAKE(1) gle space. $(subst,pat,replacement data) - Will search for pat in data and will replace any occur- + Will search for pat in data and will replace any occur- rence of pat with the replacement string. The expansion $(subst,.o,.c $(OBJECTS)) @@ -2342,48 +2372,48 @@ DMAKE(1) DMAKE(1) $(uniq list) - Will take all white-space separated tokens in list and - will return their sorted equivalent list containing no + Will take all white-space separated tokens in list and + will return their sorted equivalent list containing no duplicates. For historic reasons dmake treats the following case slightly special: $(name something) - If it encounters a macro with a whitespace after name and name is not - literally one of the above mentioned function macro identifiers then - dmake will return the recursively expanded value of $(name). The - remaining something part will be expanded but the result will be dis- + If it encounters a macro with a whitespace after name and name is not + literally one of the above mentioned function macro identifiers then + dmake will return the recursively expanded value of $(name). The + remaining something part will be expanded but the result will be dis- carded. The use of this special feature is deprecated and should not be used. CONDITIONAL MACROS - dmake supports conditional macros. These allow the definition of tar- + dmake supports conditional macros. These allow the definition of tar- get specific macro values. You can now say the following: target ?= MacroName MacroOp Value - This creates a definition for MacroName whose value is Value only when - target is being made. You may use a conditional macro assignment + This creates a definition for MacroName whose value is Value only when + target is being made. You may use a conditional macro assignment any- + where that a regular macro assignment may appear, including as the + value of a $(assign ...) macro. + The new definition is associated with the most recent cell definition + for target. If no prior definition exists then one is created. The + implications of this are immediately evident in the following example: -Dmake Version 4.8 2007-04-24 34 +Dmake Version 4.9 2007-06-25 35 -DMAKE(1) DMAKE(1) - anywhere that a regular macro assignment may appear, including as the - value of a $(assign ...) macro. +DMAKE(1) DMAKE(1) - The new definition is associated with the most recent cell definition - for target. If no prior definition exists then one is created. The - implications of this are immediately evident in the following example: foo := hello @@ -2397,16 +2427,16 @@ DMAKE(1) DMAKE(1) cond .SETDIR=msdos::;@echo $(foo) $(bar) cond ?= foo := hihi - The first conditional assignment creates a binding for 'bar' that is - activated when 'cond' is made. The bindings following the :: defini- - tions are activated when their respective recipe rules are used. Thus - the first binding serves to provide a global value for 'bar' while any - of the cond :: rules are processed, and the local bindings for 'foo' + The first conditional assignment creates a binding for 'bar' that is + activated when 'cond' is made. The bindings following the :: defini- + tions are activated when their respective recipe rules are used. Thus + the first binding serves to provide a global value for 'bar' while any + of the cond :: rules are processed, and the local bindings for 'foo' come into effect when their associated :: rule is processed. - Conditionals for targets of .UPDATEALL are all activated before the - target group is made. Assignments are processed in order. Note that - the value of a conditional macro assignment is NOT AVAILABLE until the + Conditionals for targets of .UPDATEALL are all activated before the + target group is made. Assignments are processed in order. Note that + the value of a conditional macro assignment is NOT AVAILABLE until the associated target is made, thus the construct mytarget ?= bar := hello @@ -2420,104 +2450,106 @@ DMAKE(1) DMAKE(1) Once a target is made any associated conditional macros are deactivated and their values are no longer available. Activation occurrs after all - inference, and .SETDIR directives have been processed and after $@ is - assigned, but before prerequisites are processed; thereby making the - values of conditional macro definitions available during construction + inference, and .SETDIR directives have been processed and after $@ is + assigned, but before prerequisites are processed; thereby making the + values of conditional macro definitions available during construction of prerequisites. - If a %-meta rule target has associated conditional macro assignments, - and the rule is chosen by the inference algorithm then the conditional + If a %-meta rule target has associated conditional macro assignments, + and the rule is chosen by the inference algorithm then the conditional macro assignments are inferred together with the associated recipe. DYNAMIC PREREQUISITES dmake looks for prerequisites whose names contain macro expansions dur- - ing target processing. Any such prerequisites are expanded and the - result of the expansion is used as the prerequisite name. As an exam- + ing target processing. Any such prerequisites are expanded and the + result of the expansion is used as the prerequisite name. As an exam- ple the line: fred : $$@.c - causes the $$@ to be expanded when dmake is making fred, and it - resolves to the target fred. This enables dynamic prerequisites to be - generated. The value of @ may be modified by any of the valid macro + causes the $$@ to be expanded when dmake is making fred, and it + resolves to the target fred. This enables dynamic prerequisites to be + generated. The value of @ may be modified by any of the valid macro + modifiers. So you can say for example: + fred.out : $$(@:b).c -Dmake Version 4.8 2007-04-24 35 +Dmake Version 4.9 2007-06-25 36 -DMAKE(1) DMAKE(1) - modifiers. So you can say for example: +DMAKE(1) DMAKE(1) - fred.out : $$(@:b).c - where the $$(@:b) expands to fred. Note the use of $$ instead of $ to - indicate the dynamic expansion, this is due to the fact that the rule - line is expanded when it is initially parsed, and $$ then returns $ + where the $$(@:b) expands to fred. Note the use of $$ instead of $ to + indicate the dynamic expansion, this is due to the fact that the rule + line is expanded when it is initially parsed, and $$ then returns $ which later triggers the dynamic prerequisite expansion. Dynamic macro - expansion is performed in all user defined rules, and the special tar- + expansion is performed in all user defined rules, and the special tar- gets .SOURCE*, and .INCLUDEDIRS. - NOTE: The use of a $ as part of a prerequisite or target name is - strongly discouraged as the runtime macros (like $@) are expanded when - used in a recipe line so that the $ is interpreted as a macro identi- - fier and not as a character of the filename leading to invalid runtime + NOTE: The use of a $ as part of a prerequisite or target name is + strongly discouraged as the runtime macros (like $@) are expanded when + used in a recipe line so that the $ is interpreted as a macro identi- + fier and not as a character of the filename leading to invalid runtime macros. In addition to this no filename normalization is done for pre- - requisites and targets that contain $ characters. Nevertheless it is + requisites and targets that contain $ characters. Nevertheless it is possible to use $ in prerequisites by using $$$$ but this is not recom- mended and can lead to surprising results. - If dynamic macro expansion results in multiple white space separated - tokens then these are inserted into the prerequisite list inplace of - the dynamic prerequisite. Due to the recursive nature of macro expan- - sion the prerequisite list is fully expanded even if the dynamic pre- + If dynamic macro expansion results in multiple white space separated + tokens then these are inserted into the prerequisite list inplace of + the dynamic prerequisite. Due to the recursive nature of macro expan- + sion the prerequisite list is fully expanded even if the dynamic pre- requisite contained other runtime macros. BINDING TARGETS This operation takes a target name and binds it to an existing file, if - possible. dmake makes a distinction between the internal target name + possible. dmake makes a distinction between the internal target name of a target and its associated external file name. Thus it is possible - for a target's internal name and its external file name to differ. To - perform the binding, the following set of rules is used. Assume that - we are trying to bind a target whose name is of the form X.suff, where + for a target's internal name and its external file name to differ. To + perform the binding, the following set of rules is used. Assume that + we are trying to bind a target whose name is of the form X.suff, where .suff is the suffix and X is the stem portion (ie. that part which con- - tains the directory and the basename). dmake takes this target name - and performs a series of search operations that try to find a suitably - named file in the external file system. The search operation is user + tains the directory and the basename). dmake takes this target name + and performs a series of search operations that try to find a suitably + named file in the external file system. The search operation is user controlled via the settings of the various .SOURCE targets. - 1. If target has the .SYMBOL attribute set then look for it - in the library. If found, replace the target name with + 1. If target has the .SYMBOL attribute set then look for it + in the library. If found, replace the target name with the library member name and continue with step 2. If the name is not found then return. - 2. Extract the suffix portion (that following the `.') of - the target name. If the suffix is not null, look up the + 2. Extract the suffix portion (that following the `.') of + the target name. If the suffix is not null, look up the special target .SOURCE.<suff> (<suff> is the suffix). If - the special target exists then search each directory - given in the .SOURCE.<suff> prerequisite list for the - target. If the target's suffix was null (ie. .suff was - empty) then perform the above search but use the special - target .SOURCE.NULL instead. If at any point a match is - found then terminate the search. If a directory in the - prerequisite list is the special name `.NULL ' perform a - search for the full target name without prepending any + the special target exists then search each directory + given in the .SOURCE.<suff> prerequisite list for the + target. If the target's suffix was null (ie. .suff was + empty) then perform the above search but use the special + target .SOURCE.NULL instead. If at any point a match is + found then terminate the search. If a directory in the + prerequisite list is the special name `.NULL ' perform a + search for the full target name without prepending any directory portion (ie. prepend the NULL directory). 3. The search in step 2. failed. Repeat the same search but - this time use the special target .SOURCE. (a default - target of '.SOURCE : .NULL' is defined by dmake at + this time use the special target .SOURCE. (a default + target of '.SOURCE : .NULL' is defined by dmake at startup, and is user redefinable) + 4. The search in step 3. failed. If the target has the + library member attribute (.LIBMEMBER) set then try to -Dmake Version 4.8 2007-04-24 36 +Dmake Version 4.9 2007-06-25 37 @@ -2526,42 +2558,43 @@ Dmake Version 4.8 2007-04-24 36 DMAKE(1) DMAKE(1) - 4. The search in step 3. failed. If the target has the - library member attribute (.LIBMEMBER) set then try to - find the target in the library which was passed along - with the .LIBMEMBER attribute (see the MAKING LIBRARIES + find the target in the library which was passed along + with the .LIBMEMBER attribute (see the MAKING LIBRARIES section). The bound file name assigned to a target which - is successfully located in a library is the same name + is successfully located in a library is the same name that would be assigned had the search failed (see 5.). - 5. The search failed. Either the target was not found in - any of the search directories or no applicable .SOURCE - special targets exist. If applicable .SOURCE special - targets exist, but the target was not found, then dmake - assigns the first name searched as the bound file name. - If no applicable .SOURCE special targets exist, then the + 5. The search failed. Either the target was not found in + any of the search directories or no applicable .SOURCE + special targets exist. If applicable .SOURCE special + targets exist, but the target was not found, then dmake + assigns the first name searched as the bound file name. + If no applicable .SOURCE special targets exist, then the full original target name becomes the bound file name. - There is potential here for a lot of search operations. The trick is - to define .SOURCE.x special targets with short search lists and leave - .SOURCE as short as possible. The search algorithm has the following - useful side effect. When a target having the .LIBMEMBER (library mem- + There is potential here for a lot of search operations. The trick is + to define .SOURCE.x special targets with short search lists and leave + .SOURCE as short as possible. The search algorithm has the following + useful side effect. When a target having the .LIBMEMBER (library mem- ber) attribute is searched for, it is first searched for as an ordinary - file. When a number of library members require updating it is desir- - able to compile all of them first and to update the library at the end - in a single operation. If one of the members does not compile and - dmake stops, then the user may fix the error and make again. dmake + file. When a number of library members require updating it is desir- + able to compile all of them first and to update the library at the end + in a single operation. If one of the members does not compile and + dmake stops, then the user may fix the error and make again. dmake will not remake any of the targets whose object files have already been - generated as long as none of their prerequisite files have been modi- + generated as long as none of their prerequisite files have been modi- fied as a result of the fix. When dmake constructs target (and prerequisite) pathnames they are nor- - malized to the shortest (or most natural, see below for the cygwin + malized to the shortest (or most natural, see below for the cygwin case) representation. Substrings like './' or of the form 'baz/..' are - removed. For example "./foo", "bar/../foo" and foo are recognized as - the same file. This may result in somewhat unexpected values of the - macro expansion of runtime macros like $@, but is infact the corect - result. + removed and multiple slashes are collapsed to one unless they are at + the beginning of the pathname. Leading slashes are normalized according + to POSIX rules, i.e. more than two leading slashes are reduced to one + slash and a leading '//' is kept as it might have a special meaning. + For example "./foo", "bar/../foo" and foo are recognized as the same + file. This may result in somewhat unexpected values of the macro + expansion of runtime macros like $@, but is infact the corect result. NOTE: A cygwin dmake executable will accept DOS like pathnames with drive letters and cygwin POSIX pathnames and normalize them into its @@ -2586,13 +2619,9 @@ DMAKE(1) DMAKE(1) Which takes the value of VPATH and sets .SOURCE to the same set of directories as specified in VPATH. -PERCENT(%) RULES AND MAKING INFERENCES - When dmake makes a target, the target's set of prerequisites (if any) - must exist and the target must have a recipe which dmake can use to - -Dmake Version 4.8 2007-04-24 37 +Dmake Version 4.9 2007-06-25 38 @@ -2601,6 +2630,9 @@ Dmake Version 4.8 2007-04-24 37 DMAKE(1) DMAKE(1) +PERCENT(%) RULES AND MAKING INFERENCES + When dmake makes a target, the target's set of prerequisites (if any) + must exist and the target must have a recipe which dmake can use to make it. If the makefile does not specify an explicit recipe for the target then dmake uses special rules to try to infer a recipe which it can use to make the target. Previous versions of Make perform this @@ -2658,23 +2690,23 @@ DMAKE(1) DMAKE(1) %.c : %.y ; recipe... describes how to make any file ending in .c if a corresponding file - ending in .y can be found. - foo%.o : fee%.k ; recipe... - is used to describe how to make fooxxxx.o from feexxxx.k. +Dmake Version 4.9 2007-06-25 39 -Dmake Version 4.8 2007-04-24 38 +DMAKE(1) DMAKE(1) + ending in .y can be found. -DMAKE(1) DMAKE(1) + foo%.o : fee%.k ; recipe... + is used to describe how to make fooxxxx.o from feexxxx.k. %.a :; recipe... @@ -2730,19 +2762,10 @@ DMAKE(1) DMAKE(1) % : $$(@:d)RCS/$$(@:f),v : co $@ This rule uses the dynamic macro $@ to specify the prerequisite to try - to infer. During inference of this rule the macro $@ is set to the - value of the target of the %-meta rule and the appropriate prerequisite - is generated by extracting the directory portion of the target name (if - any), appending the string RCS/ to it, and appending the target file - name with a trailing ,v attached to the previous result. - - dmake can also infer indirect prerequisites. An inferred target can - have a list of prerequisites added that will not show up in the value - of $< but will show up in the value of $? and $&. Indirect -Dmake Version 4.8 2007-04-24 39 +Dmake Version 4.9 2007-06-25 40 @@ -2751,9 +2774,17 @@ Dmake Version 4.8 2007-04-24 39 DMAKE(1) DMAKE(1) - prerequisites are specified in an inference rule by quoting the prereq- - uisite with single quotes. For example, if you had the explicit depen- - dency: + to infer. During inference of this rule the macro $@ is set to the + value of the target of the %-meta rule and the appropriate prerequisite + is generated by extracting the directory portion of the target name (if + any), appending the string RCS/ to it, and appending the target file + name with a trailing ,v attached to the previous result. + + dmake can also infer indirect prerequisites. An inferred target can + have a list of prerequisites added that will not show up in the value + of $< but will show up in the value of $? and $&. Indirect prerequi- + sites are specified in an inference rule by quoting the prerequisite + with single quotes. For example, if you had the explicit dependency: fred.o : fred.c ; rule to make fred.o fred.o : local.h @@ -2762,17 +2793,17 @@ DMAKE(1) DMAKE(1) %.o : %.c 'local.h' ; makes a .o from a .c - You may infer indirect prerequisites that are a function of the value + You may infer indirect prerequisites that are a function of the value of '%' in the current rule. The meta-rule: %.o : %.c '$(INC)/%.h' ; rule to make a .o from a .c - infers an indirect prerequisite found in the INC directory whose name - is the same as the expansion of $(INC), and the prerequisite name - depends on the base name of the current target. The set of indirect - prerequisites is attached to the meta rule in which they are specified - and are inferred only if the rule is used to infer a recipe for a tar- - get. They do not play an active role in driving the inference algo- + infers an indirect prerequisite found in the INC directory whose name + is the same as the expansion of $(INC), and the prerequisite name + depends on the base name of the current target. The set of indirect + prerequisites is attached to the meta rule in which they are specified + and are inferred only if the rule is used to infer a recipe for a tar- + get. They do not play an active role in driving the inference algo- rithm. The construct: %.o : %.c %.f 'local.h'; recipe @@ -2794,30 +2825,19 @@ DMAKE(1) DMAKE(1) If any of the attributes .SETDIR, .EPILOG, .PROLOG, .SILENT, .USESHELL, .SWAP, .PRECIOUS, .LIBRARY, .NOSTATE and .IGNORE are given for a %-rule then when that rule is bound to a target as the result of an inference, - the target's set of attributes is augmented by the attributes from the - above set that are specified in the bound %-rule. Other attributes - specified for %-meta rules are not inherited by the target. The .SET- + the target's set of attributes is augmented by the attributes from the + above set that are specified in the bound %-rule. Other attributes + specified for %-meta rules are not inherited by the target. The .SET- DIR attribute is treated in a special way. If the target already had a - .SETDIR attribute set then dmake changes to that directory prior to - performing the inference. During inference any .SETDIR attributes for - the inferred prerequisite are honored. The directories must exist for - a %-meta rule to be selected as a possible inference path. If the - directories do not exist no error message is issued, instead the corre- - sponding path in the inference graph is rejected. - - dmake bases all of its inferences on the inference graph constructed - from the %-rules defined in the makefile. It knows exactly which tar- - gets can be made from which prerequisites by making queries on the - inference graph. - - For a %-meta rule to be inferred as the rule whose recipe will be used - to make a target, the target's name must match the %-target pattern, - and any inferred %-prerequisite must already exist or have an explicit - recipe so that the prerequisite can be made. Without transitive + .SETDIR attribute set then dmake changes to that directory prior to + performing the inference. During inference any .SETDIR attributes for + the inferred prerequisite are honored. The directories must exist for + a %-meta rule to be selected as a possible inference path. If the + directories do not exist no error message is issued, instead the -Dmake Version 4.8 2007-04-24 40 +Dmake Version 4.9 2007-06-25 41 @@ -2826,80 +2846,92 @@ Dmake Version 4.8 2007-04-24 40 DMAKE(1) DMAKE(1) - closure on the inference graph the above rule describes precisely when - an inference match terminates the search. If transitive closure is - enabled (the usual case), and a prerequisite does not exist or cannot - be made, then dmake invokes the inference algorithm recursively on the - prerequisite to see if there is some way the prerequisite can be manu- + corresponding path in the inference graph is rejected. + + dmake bases all of its inferences on the inference graph constructed + from the %-rules defined in the makefile. It knows exactly which tar- + gets can be made from which prerequisites by making queries on the + inference graph. + + For a %-meta rule to be inferred as the rule whose recipe will be used + to make a target, the target's name must match the %-target pattern, + and any inferred %-prerequisite must already exist or have an explicit + recipe so that the prerequisite can be made. Without transitive clo- + sure on the inference graph the above rule describes precisely when an + inference match terminates the search. If transitive closure is + enabled (the usual case), and a prerequisite does not exist or cannot + be made, then dmake invokes the inference algorithm recursively on the + prerequisite to see if there is some way the prerequisite can be manu- factured. For, if the prerequisite can be made then the current target - can also be made using the current %-meta rule. This means that there - is no longer a need to give a rule for making a .o from a .y if you + can also be made using the current %-meta rule. This means that there + is no longer a need to give a rule for making a .o from a .y if you have already given a rule for making a .o from a .c and a .c from a .y. - In such cases dmake can infer how to make the .o from the .y via the + In such cases dmake can infer how to make the .o from the .y via the intermediary .c and will remove the .c when the .o is made. Transitive closure can be disabled by giving the -T switch on the command line. - A word of caution. dmake bases its transitive closure on the %-meta - rule targets. When it performs transitive closure it infers how to - make a target from a prerequisite by performing a pattern match as if + A word of caution. dmake bases its transitive closure on the %-meta + rule targets. When it performs transitive closure it infers how to + make a target from a prerequisite by performing a pattern match as if the potential prerequisite were a new target. The set of rules: %.o : %.c ; rule for making .o from .c %.c : %.y ; rule for making .c from .y % : RCS/%,v ; check out of RCS file - will, by performing transitive closure, allow dmake to infer how to - make a .o from a .y using a .c as an intermediate temporary file. - Additionally it will be able to infer how to make a .y from an RCS - file, as long as that RCS file is in the RCS directory and has a name - which ends in .y,v. The transitivity computation is performed dynami- - cally for each target that does not have a recipe. This has potential - to be costly if the %-meta rules are not carefully specified. The - .NOINFER attribute is used to mark a %-meta node as being a final tar- - get during inference. Any node with this attribute set will not be - used for subsequent inferences. As an example the node RCS/%,v is - marked as a final node since we know that if the RCS file does not - exist there likely is no other way to make it. Thus the standard + will, by performing transitive closure, allow dmake to infer how to + make a .o from a .y using a .c as an intermediate temporary file. + Additionally it will be able to infer how to make a .y from an RCS + file, as long as that RCS file is in the RCS directory and has a name + which ends in .y,v. The transitivity computation is performed dynami- + cally for each target that does not have a recipe. This has potential + to be costly if the %-meta rules are not carefully specified. The + .NOINFER attribute is used to mark a %-meta node as being a final tar- + get during inference. Any node with this attribute set will not be + used for subsequent inferences. As an example the node RCS/%,v is + marked as a final node since we know that if the RCS file does not + exist there likely is no other way to make it. Thus the standard startup makefile contains an entry similar to: .NOINFER : RCS/%,v Thereby indicating that the RCS file is the end of the inference chain. - Whenever the inference algorithm determines that a target can be made - from more than one prerequisite and the inference chains for the two - methods are the same length the algorithm reports an ambiguity and + Whenever the inference algorithm determines that a target can be made + from more than one prerequisite and the inference chains for the two + methods are the same length the algorithm reports an ambiguity and prints the ambiguous inference chains. dmake tries to remove intermediate files resulting from transitive clo- - sure if the file is not marked as being PRECIOUS, or the -u flag was + sure if the file is not marked as being PRECIOUS, or the -u flag was not given on the command line, and if the inferred intermediate did not - previously exist. Intermediate targets that existed prior to being - made are never removed. This is in keeping with the philosophy that - dmake should never remove things from the file system that it did not - add. If the special target .REMOVE is defined and has a recipe then - dmake constructs a list of the intermediate files to be removed and - makes them prerequisites of .REMOVE. It then makes .REMOVE thereby - removing the prerequisites if the recipe of .REMOVE says to. Typically - .REMOVE is defined in the startup file as: + previously exist. Intermediate targets that existed prior to being + made are never removed. This is in keeping with the philosophy that + dmake should never remove things from the file system that it did not + add. If the special target .REMOVE is defined and has a recipe then - .REMOVE :; $(RM) $< -AUGMAKE META RULES - As a subclass of the meta targets that is actually mapped to %-meta - rules dmake understands several SYSV AUGMAKE targets transformations. - This .<suffix> special target construct transforms into the following - %-meta rules: - .suff :; recipe +Dmake Version 4.9 2007-06-25 42 -Dmake Version 4.8 2007-04-24 41 +DMAKE(1) DMAKE(1) + + dmake constructs a list of the intermediate files to be removed and + makes them prerequisites of .REMOVE. It then makes .REMOVE thereby + removing the prerequisites if the recipe of .REMOVE says to. Typically + .REMOVE is defined in the startup file as: + .REMOVE :; $(RM) $< -DMAKE(1) DMAKE(1) +AUGMAKE META RULES + As a subclass of the meta targets that is actually mapped to %-meta + rules dmake understands several SYSV AUGMAKE targets transformations. + This .<suffix> special target construct transforms into the following + %-meta rules: + .suff :; recipe gets mapped into: @@ -2907,7 +2939,7 @@ DMAKE(1) DMAKE(1) dmake also supports the old format special target .<suffix>.<suffix> by - identifying any rules of this form and mapping them to the appropriate + identifying any rules of this form and mapping them to the appropriate %-rule. So for example if an old makefile contains the construct: .c.o :; cc -c $< -o $@ @@ -2916,8 +2948,8 @@ DMAKE(1) DMAKE(1) %.o : %.c; cc -c $< -o $@ - The following SYSV AUGMAKE special targets transformation must be - enabled by providing the -A flag on the command line or by setting the + The following SYSV AUGMAKE special targets transformation must be + enabled by providing the -A flag on the command line or by setting the value of AUGMAKE to non-NULL. The construct .c~.o :; recipe @@ -2926,66 +2958,65 @@ DMAKE(1) DMAKE(1) %.o : s.%.c ; recipe - In general, a special target of the form .<str>~ is replaced by the - %-rule construct s.%.<str>, thereby providing support for the syntax - used by SYSV AUGMAKE for providing SCCS support. When enabled, these - mappings allow processing of existing SYSV makefiles without modifica- + In general, a special target of the form .<str>~ is replaced by the + %-rule construct s.%.<str>, thereby providing support for the syntax + used by SYSV AUGMAKE for providing SCCS support. When enabled, these + mappings allow processing of existing SYSV makefiles without modifica- tions. MAKING TARGETS In order to update a target dmake must execute a recipe. When a recipe - needs to be executed it is first expanded so that any macros in the - recipe text are expanded, and it is then either executed directly or - passed to a shell. dmake supports two types of recipes. The regular + needs to be executed it is first expanded so that any macros in the + recipe text are expanded, and it is then either executed directly or + passed to a shell. dmake supports two types of recipes. The regular recipes and group recipes. When a regular recipe is invoked dmake executes each line of the recipe - separately using a new copy of a shell if a shell is required. Thus - effects of commands do not generally persist across recipe lines (e.g. - cd requests in a recipe line do not carry over to the next recipe - line). This is true even in environments such as MSDOS, where dmake - internally sets the current working director to match the directory it + separately using a new copy of a shell if a shell is required. Thus + effects of commands do not generally persist across recipe lines (e.g. + cd requests in a recipe line do not carry over to the next recipe + line). This is true even in environments such as MSDOS, where dmake + internally sets the current working director to match the directory it was in before the command was executed. - The decision on whether a shell is required to execute a command is - based on the value of the macro SHELLMETAS or on the specification of - '+' or .USESHELL for the current recipe or target respectively. If any - character in the value of SHELLMETAS is found in the expanded recipe - text-line or the use of a shell is requested explicitly via '+' or - .USESHELL then the command is executed using a shell, otherwise the - command is executed directly. The shell that is used for execution is - given by the value of the macro SHELL. The flags that are passed to - the shell are given by the value of SHELLFLAGS. Thus dmake constructs - the command line: - - $(SHELL) $(SHELLFLAGS) $(expanded_recipe_command) - Normally dmake writes the command line that it is about to invoke to - standard output. If the .SILENT attribute is set for the target or for - the recipe line (via @), then the recipe line is not echoed. +Dmake Version 4.9 2007-06-25 43 -Dmake Version 4.8 2007-04-24 42 +DMAKE(1) DMAKE(1) + The decision on whether a shell is required to execute a command is + based on the value of the macro SHELLMETAS or on the specification of + '+' or .USESHELL for the current recipe or target respectively. If any + character in the value of SHELLMETAS is found in the expanded recipe + text-line or the use of a shell is requested explicitly via '+' or + .USESHELL then the command is executed using a shell, otherwise the + command is executed directly. The shell that is used for execution is + given by the value of the macro SHELL. The flags that are passed to + the shell are given by the value of SHELLFLAGS. Thus dmake constructs + the command line: -DMAKE(1) DMAKE(1) + $(SHELL) $(SHELLFLAGS) $(expanded_recipe_command) + Normally dmake writes the command line that it is about to invoke to + standard output. If the .SILENT attribute is set for the target or for + the recipe line (via @), then the recipe line is not echoed. - Group recipe processing is similar to that of regular recipes, except - that a shell is always invoked. The shell that is invoked is given by - the value of the macro GROUPSHELL, and its flags are taken from the - value of the macro GROUPFLAGS. If a target has the .PROLOG attribute - set then dmake prepends to the shell script the recipe associated with + Group recipe processing is similar to that of regular recipes, except + that a shell is always invoked. The shell that is invoked is given by + the value of the macro GROUPSHELL, and its flags are taken from the + value of the macro GROUPFLAGS. If a target has the .PROLOG attribute + set then dmake prepends to the shell script the recipe associated with the special target .GROUPPROLOG, and if the attribute .EPILOG is set as - well, then the recipe associated with the special target .GROUPEPILOG - is appended to the script file. This facility can be used to always - prepend a common header and common trailer to group recipes. Group - recipes are echoed to standard output just like standard recipes, but + well, then the recipe associated with the special target .GROUPEPILOG + is appended to the script file. This facility can be used to always + prepend a common header and common trailer to group recipes. Group + recipes are echoed to standard output just like standard recipes, but are enclosed by lines beginning with [ and ]. The recipe flags [+,-,%,@] are recognized at the start of a recipe line @@ -3002,16 +3033,16 @@ DMAKE(1) DMAKE(1) +echo hi - The last step performed by dmake prior to running a recipe is to set + The last step performed by dmake prior to running a recipe is to set the macro CMNDNAME to the name of the command to execute (determined by - finding the first white-space ending token in the command line). It - then sets the macro CMNDARGS to be the remainder of the line. dmake + finding the first white-space ending token in the command line). It + then sets the macro CMNDARGS to be the remainder of the line. dmake then expands the macro COMMAND which by default is set to COMMAND = $(CMNDNAME) $(CMNDARGS) - The result of this final expansion is the command that will be exe- - cuted. The reason for this expansion is to allow for a different + The result of this final expansion is the command that will be exe- + cuted. The reason for this expansion is to allow for a different interface to the argument passing facilities (esp. under DOS) than that provided by dmake. You can for example define COMMAND to be @@ -3019,37 +3050,38 @@ DMAKE(1) DMAKE(1) which dumps the arguments into a temporary file and runs the command - $(CMNDNAME) @/tmp/ASAD23043 - which has a much shorter argument list. It is now up to the command to - use the supplied argument as the source for all other arguments. As an - optimization, if COMMAND is not defined dmake does not perform the - above expansion. On systems, such as UNIX, that handle long command - lines this provides a slight saving in processing the makefiles. -MAKING LIBRARIES - Libraries are easy to maintain using dmake. A library is a file con- - taining a collection of object files. Thus to make a library you sim- - ply specify it as a target with the .LIBRARY attribute set and specify - its list of prerequisites. The prerequisites should be the object mem- - bers that are to go into the library. When dmake makes the library - target it uses the .LIBRARY attribute to pass to the prerequisites the - .LIBMEMBER attribute and the name of the library. This enables the - file binding mechanism to look for the member in the library if an - appropriate object file cannot be found. dmake now supports Elf - libraries on systems that support Elf and hence supports, on those sys- - tems, long member file names. A small example best illustrates this. +Dmake Version 4.9 2007-06-25 44 -Dmake Version 4.8 2007-04-24 43 +DMAKE(1) DMAKE(1) -DMAKE(1) DMAKE(1) + $(CMNDNAME) @/tmp/ASAD23043 + which has a much shorter argument list. It is now up to the command to + use the supplied argument as the source for all other arguments. As an + optimization, if COMMAND is not defined dmake does not perform the + above expansion. On systems, such as UNIX, that handle long command + lines this provides a slight saving in processing the makefiles. + +MAKING LIBRARIES + Libraries are easy to maintain using dmake. A library is a file con- + taining a collection of object files. Thus to make a library you sim- + ply specify it as a target with the .LIBRARY attribute set and specify + its list of prerequisites. The prerequisites should be the object mem- + bers that are to go into the library. When dmake makes the library + target it uses the .LIBRARY attribute to pass to the prerequisites the + .LIBMEMBER attribute and the name of the library. This enables the + file binding mechanism to look for the member in the library if an + appropriate object file cannot be found. dmake now supports Elf + libraries on systems that support Elf and hence supports, on those sys- + tems, long member file names. A small example best illustrates this. mylib.a .LIBRARY : mem1.o mem2.o mem3.o rules for making library... @@ -3058,18 +3090,18 @@ DMAKE(1) DMAKE(1) # equivalent to: '%.o : %.c ; ...' .c.o :; rules for making .o from .c say - dmake will use the .c.o rule for making the library members if appro- - priate .c files can be found using the search rules. NOTE: this is + dmake will use the .c.o rule for making the library members if appro- + priate .c files can be found using the search rules. NOTE: this is not specific in any way to C programs, they are simply used as an exam- ple. - dmake tries to handle the old library construct format in a sensible - way. The construct lib(member.o) is separated and the lib portion is - declared as a library target. The new target is defined with the - .LIBRARY attribute set and the member.o portion of the construct is - declared as a prerequisite of the lib target. If the construct - lib(member.o) appears as a prerequisite of a target in the makefile, - that target has the new name of the lib assigned as its prerequisite. + dmake tries to handle the old library construct format in a sensible + way. The construct lib(member.o) is separated and the lib portion is + declared as a library target. The new target is defined with the + .LIBRARY attribute set and the member.o portion of the construct is + declared as a prerequisite of the lib target. If the construct + lib(member.o) appears as a prerequisite of a target in the makefile, + that target has the new name of the lib assigned as its prerequisite. Thus the following example: a.out : ml.a(a.o) ml.a(b.o); $(CC) -o $@ $< @@ -3091,133 +3123,132 @@ DMAKE(1) DMAKE(1) ranlib $@ rm -rf $? + + +Dmake Version 4.9 2007-06-25 45 + + + + + +DMAKE(1) DMAKE(1) + + and making a.out then works as expected. - The same thing happens for any target of the form lib((entry)). These - targets have an additional feature in that the entry target has the + The same thing happens for any target of the form lib((entry)). These + targets have an additional feature in that the entry target has the .SYMBOL attribute set automatically. NOTE: If the notion of entry points is supported by the archive and by - dmake (currently not the case) then dmake will search the archive for + dmake (currently not the case) then dmake will search the archive for the entry point and return not only the modification time of the member - which defines the entry but also the name of the member file. This - name will then replace entry and will be used for making the member + which defines the entry but also the name of the member file. This + name will then replace entry and will be used for making the member file. Once bound to an archive member the .SYMBOL attribute is removed from the target. This feature is presently disabled as there is little - standardization among archive formats, and we have yet to find a make- - file utilizing this feature (possibly due to the fact that it is unim- + standardization among archive formats, and we have yet to find a make- + file utilizing this feature (possibly due to the fact that it is unim- plemented in most versions of UNIX Make). Finally, when dmake looks for a library member it must first locate the - library file. It does so by first looking for the library relative to - the current directory and if it is not found it then looks relative to + library file. It does so by first looking for the library relative to + the current directory and if it is not found it then looks relative to the current value of $(TMD). This allows commonly used libraries to be kept near the root of a source tree and to be easily found by dmake. - - - -Dmake Version 4.8 2007-04-24 44 - - - - - -DMAKE(1) DMAKE(1) - - KEEP STATE - dmake supports the keeping of state information for targets that it + dmake supports the keeping of state information for targets that it makes whenever the macro .KEEP_STATE is assigned a value. The value of - the macro should be the name of a state file that will contain the - state information. If state keeping is enabled then each target that - does not poses the .NOSTATE attribute will have a record written into + the macro should be the name of a state file that will contain the + state information. If state keeping is enabled then each target that + does not poses the .NOSTATE attribute will have a record written into the state file indicating the target's name, the current directory, the - command used to update the target, and which, if any, :: rule is being - used. When you make this target again if any of this information does + command used to update the target, and which, if any, :: rule is being + used. When you make this target again if any of this information does not match the previous settings and the target is not out dated it will - still be re-made. The assumption is that one of the conditions above - has changed and that we wish to remake the target. For example, state - keeping is used in the maintenance of dmake to test compile different - versions of the source using different compilers. Changing the com- + still be re-made. The assumption is that one of the conditions above + has changed and that we wish to remake the target. For example, state + keeping is used in the maintenance of dmake to test compile different + versions of the source using different compilers. Changing the com- piler causes the compilation flags to be modified and hence all sources to be recompiled. - The state file is an ascii file and is portable, however it is not in - human readable form as the entries represent hash keys of the above + The state file is an ascii file and is portable, however it is not in + human readable form as the entries represent hash keys of the above information. The Sun Microsystem's Make construct .KEEP_STATE : - is recognized and is mapped to .KEEP_STATE:=_state.mk. The dmake ver- - sion of state keeping does not include scanning C source files for - dependencies like Sun Make. This is specific to C programs and it was + is recognized and is mapped to .KEEP_STATE:=_state.mk. The dmake ver- + sion of state keeping does not include scanning C source files for + dependencies like Sun Make. This is specific to C programs and it was felt that it does not belong in make. dmake instead provides the tool, - cdepend, to scan C source files and to produce depedency information. - Users are free to modify cdepend to produce other dependency files. - (NOTE: cdepend does not come with the distribution at this time, but + cdepend, to scan C source files and to produce depedency information. + Users are free to modify cdepend to produce other dependency files. + (NOTE: cdepend does not come with the distribution at this time, but will be available in a patch in the near future) MULTI PROCESSING - If the architecture supports it then dmake is capable of making a tar- - get's prerequisites in parallel. dmake will make as much in parallel - as it can and use a number of child processes up to the maximum speci- - fied by MAXPROCESS or by the value supplied to the -P command line - flag. A parallel make is enabled by setting the value of MAXPROCESS - (either directly or via -P option) to a value which is > 1. dmake - guarantees that all dependencies as specified in the makefile are hon- - ored. A target will not be made until all of its prerequisites have - been made. Note that when you specify -P 4 then four child processes - are run concurrently but dmake actually displays the fifth command it - will run immediately upon a child process becomming free. This is an - artifact of the method used to traverse the dependency graph and cannot - be removed. If a parallel make is being performed then the following - restrictions on parallelism are enforced. + If the architecture supports it then dmake is capable of making a tar- + get's prerequisites in parallel. dmake will make as much in parallel - 1. Individual recipe lines in a non-group recipe are per- - formed sequentially in the order in which they are speci- - fied within the makefile and in parallel with the recipes - of other targets. - 2. If a target contains multiple recipe definitions (cf. :: - rules) then these are performed sequentially in the order - in which the :: rules are specified within the makefile - and in parallel with the recipes of other targets. - 3. If a target rule contains the `!' modifier, then the - recipe is performed sequentially for the list of outdated - prerequisites and in parallel with the recipes of other +Dmake Version 4.9 2007-06-25 46 -Dmake Version 4.8 2007-04-24 45 +DMAKE(1) DMAKE(1) + as it can and use a number of child processes up to the maximum speci- + fied by MAXPROCESS or by the value supplied to the -P command line + flag. A parallel make is enabled by setting the value of MAXPROCESS + (either directly or via -P option) to a value which is > 1. dmake + guarantees that all dependencies as specified in the makefile are hon- + ored. A target will not be made until all of its prerequisites have + been made. Note that when you specify -P 4 then four child processes + are run concurrently but dmake actually displays the fifth command it + will run immediately upon a child process becomming free. This is an + artifact of the method used to traverse the dependency graph and cannot + be removed. If a parallel make is being performed then the following + restrictions on parallelism are enforced. -DMAKE(1) DMAKE(1) + 1. Individual recipe lines in a non-group recipe are per- + formed sequentially in the order in which they are speci- + fied within the makefile and in parallel with the recipes + of other targets. + 2. If a target contains multiple recipe definitions (cf. :: + rules) then these are performed sequentially in the order + in which the :: rules are specified within the makefile + and in parallel with the recipes of other targets. + 3. If a target rule contains the `!' modifier, then the + recipe is performed sequentially for the list of outdated + prerequisites and in parallel with the recipes of other targets. 4. If a target has the .SEQUENTIAL attribute set then all of - its prerequisites are made sequentially relative to one - another (as if MAXPROCESS=1), but in parallel with other + its prerequisites are made sequentially relative to one + another (as if MAXPROCESS=1), but in parallel with other targets in the makefile. - Note: If you specify a parallel make then the order of target update + Note: If you specify a parallel make then the order of target update and the order in which the associated recipes are invoked will not cor- respond to that displayed by the -n flag. CONDITIONALS - dmake supports a makefile construct called a conditional. It allows - the user to conditionally select portions of makefile text for input - processing and to discard other portions. This becomes useful for - writing makefiles that are intended to function for more than one tar- - get host and environment. The conditional expression is specified as + dmake supports a makefile construct called a conditional. It allows + the user to conditionally select portions of makefile text for input + processing and to discard other portions. This becomes useful for + writing makefiles that are intended to function for more than one tar- + get host and environment. The conditional expression is specified as follows: .IF expression @@ -3228,13 +3259,25 @@ CONDITIONALS ... else text ... .END - The .ELSE and .ELIF portions are optional, and the conditionals may be - nested (ie. the text may contain another conditional). .IF, .ELSE, - and .END may appear anywhere in the makefile, but a single conditional + The .ELSE and .ELIF portions are optional, and the conditionals may be + nested (ie. the text may contain another conditional). .IF, .ELSE, + and .END may appear anywhere in the makefile, but a single conditional expression may not span multiple makefiles. expression can be one of the following forms: + + + +Dmake Version 4.9 2007-06-25 47 + + + + + +DMAKE(1) DMAKE(1) + + String evaluation <text> | <text> == <text> | <text> != <text> @@ -3244,38 +3287,26 @@ CONDITIONALS Boolean evaluation ( <text> ) | <text> || <text> | <text> && <text> - where text is either text or a macro expression. In any case, before - the comparison is made, the expression is expanded. The text portions + where text is either text or a macro expression. In any case, before + the comparison is made, the expression is expanded. The text portions are then selected and compared. In the case of the numeric comparisons - enclosing quotes are removed after expanding the expressions and the - leading numerical parts are converted to an integer number. If no + enclosing quotes are removed after expanding the expressions and the + leading numerical parts are converted to an integer number. If no numerical part is found this results to 0 (zero). The string "12ab" for - example evaluates to the number 12. Expressions can be nested with () - and the use of || or &&. White space at the start and end of the text - portion is discarded before the comparison. This means that a macro - that evaluates to nothing but white space is considered a NULL value - for the purpose of the comparison. In the first case the expression - evaluates TRUE if the text is not NULL otherwise it evaluates FALSE. - The remaining two cases both evaluate the expression on the basis of a + example evaluates to the number 12. Expressions can be nested with () + and the use of || or &&. White space at the start and end of the text + portion is discarded before the comparison. This means that a macro + that evaluates to nothing but white space is considered a NULL value + for the purpose of the comparison. In the first case the expression + evaluates TRUE if the text is not NULL otherwise it evaluates FALSE. + The remaining two cases both evaluate the expression on the basis of a string comparison. If a macro expression needs to be equated to a NULL - string then compare it to the value of the macro $(NULL). You can use + string then compare it to the value of the macro $(NULL). You can use the $(shell ...) macro to construct more complex test expressions. EXAMPLES # A simple example showing how to use make # - - - -Dmake Version 4.8 2007-04-24 46 - - - - - -DMAKE(1) DMAKE(1) - - prgm : a.o b.o cc a.o b.o -o prgm a.o : a.c g.h @@ -3284,9 +3315,9 @@ DMAKE(1) DMAKE(1) cc b.c -o $@ In the previous example prgm is remade only if a.o and/or b.o is out of - date with respect to prgm. These dependencies can be stated more con- - cisely by using the inference rules defined in the standard startup - file. The default rule for making .o's from .c's looks something like + date with respect to prgm. These dependencies can be stated more con- + cisely by using the inference rules defined in the standard startup + file. The default rule for making .o's from .c's looks something like this: %.o : %.c; cc -c $(CFLAGS) -o $@ $< @@ -3299,7 +3330,7 @@ DMAKE(1) DMAKE(1) cc -o prgm $< a.o b.o : g.h - A more general way to say the above using the new macro expansions + A more general way to say the above using the new macro expansions would be: SRC = a b @@ -3308,9 +3339,20 @@ DMAKE(1) DMAKE(1) prgm : $(OBJ) cc -o $@ $< + + +Dmake Version 4.9 2007-06-25 48 + + + + + +DMAKE(1) DMAKE(1) + + $(OBJ) : g.h - If we want to keep the objects in a separate directory, called objdir, + If we want to keep the objects in a separate directory, called objdir, then we would write something like this. SRC = a b @@ -3326,7 +3368,7 @@ DMAKE(1) DMAKE(1) .SOURCE.o : objdir # tell dmake to look here for .o's - An example of building library members would go something like this: + An example of building library members would go something like this: (NOTE: The same rules as above will be used to produce .o's from .c's) SRC= a b @@ -3340,19 +3382,8 @@ DMAKE(1) DMAKE(1) ar rv $@ $< rm $< - - -Dmake Version 4.8 2007-04-24 47 - - - - - -DMAKE(1) DMAKE(1) - - - Finally, suppose that each of the source files in the previous example - had the `:' character in their target name. Then we would write the + Finally, suppose that each of the source files in the previous example + had the `:' character in their target name. Then we would write the above example as: SRC= f:a f:b @@ -3367,71 +3398,71 @@ DMAKE(1) DMAKE(1) rm $< COMPATIBILITY - There are two notable differences between dmake and the standard ver- + There are two notable differences between dmake and the standard ver- sion of BSD UNIX 4.2/4.3 Make. - 1. BSD UNIX 4.2/4.3 Make supports wild card filename expansion - for prerequisite names. Thus if a directory contains a.h, + 1. BSD UNIX 4.2/4.3 Make supports wild card filename expansion + for prerequisite names. Thus if a directory contains a.h, b.h and c.h, then a line like target: *.h - will cause UNIX make to expand the *.h into "a.h b.h c.h". + will cause UNIX make to expand the *.h into "a.h b.h c.h". dmake does not support this type of filename expansion. - 2. Unlike UNIX make, touching a library member causes dmake to - search the library for the member name and to update the - library time stamp. This is only implemented in the UNIX - version. MSDOS and other versions may not have librarians - that keep file time stamps, as a result dmake touches the - library file itself, and prints a warning. - dmake is not compatible with GNU Make. In particular it does not - understand GNU Make's macro expansions that query the file system. - dmake is fully compatible with SYSV AUGMAKE, and supports the following - AUGMAKE features: - 1. GNU Make style include, and if/else/endif directives are - allowed in non-group recipes. Thus, the word include appear- - ing at the start of a line that is not part of a gruop recipe - will be mapped to the ".INCLUDE" directive that damke uses. - Similarly, the words ifeq,ifneq,elif,else, and endif are - mapped to their corresponding dmake equivalents. +Dmake Version 4.9 2007-06-25 49 - 2. The macro modifier expression $(macro:str=sub) is understood - and is equivalent to the expression $(macro:s/str/sub), with - the restriction that str must match the following regular - expression: - str[ |\t][ |\t]* - (ie. str only matches at the end of a token where str is a - suffix and is terminated by a space, a tab, or end of line) - Normally sub is expanded before the substitution is made, if - you specify -A on the command line then sub is not expanded. - 3. The macro % is defined to be $@ (ie. $% expands to the same - value as $@). +DMAKE(1) DMAKE(1) + 2. Unlike UNIX make, touching a library member causes dmake to + search the library for the member name and to update the + library time stamp. This is only implemented in the UNIX + version. MSDOS and other versions may not have librarians + that keep file time stamps, as a result dmake touches the + library file itself, and prints a warning. -Dmake Version 4.8 2007-04-24 48 + dmake is not compatible with GNU Make. In particular it does not + understand GNU Make's macro expansions that query the file system. + dmake is fully compatible with SYSV AUGMAKE, and supports the following + AUGMAKE features: + 1. GNU Make style include, and if/else/endif directives are + allowed in non-group recipes. Thus, the word include appear- + ing at the start of a line that is not part of a gruop recipe + will be mapped to the ".INCLUDE" directive that damke uses. + Similarly, the words ifeq,ifneq,elif,else, and endif are + mapped to their corresponding dmake equivalents. + 2. The macro modifier expression $(macro:str=sub) is understood + and is equivalent to the expression $(macro:s/str/sub), with + the restriction that str must match the following regular + expression: + str[ |\t][ |\t]* -DMAKE(1) DMAKE(1) + (ie. str only matches at the end of a token where str is a + suffix and is terminated by a space, a tab, or end of line) + Normally sub is expanded before the substitution is made, if + you specify -A on the command line then sub is not expanded. + 3. The macro % is defined to be $@ (ie. $% expands to the same + value as $@). 4. The AUGMAKE notion of libraries is handled correctly. - 5. Directories are always made if you specify -A. This is con- + 5. Directories are always made if you specify -A. This is con- sistent with other UNIX versions of Make. - 6. Makefiles that utilize virtual targets to force making of + 6. Makefiles that utilize virtual targets to force making of other targets work as expected if AUGMAKE special target han- dling is enabled. For example: @@ -3442,36 +3473,47 @@ DMAKE(1) DMAKE(1) 'dmake -A FRC=FRC' - but fails with a 'don't know how to make FRC' error message + but fails with a 'don't know how to make FRC' error message if you do not specify AUGMAKE special target handling via the -A flag (or by setting AUGMAKE:=yes internally). LIMITS - In some environments the length of an argument string is restricted. - (e.g. MSDOS command line arguments cannot be longer than 128 bytes if - you are using the standard command.com command interpreter as your + In some environments the length of an argument string is restricted. + (e.g. MSDOS command line arguments cannot be longer than 128 bytes if + you are using the standard command.com command interpreter as your shell, dmake text diversions may help in these situations.) + + +Dmake Version 4.9 2007-06-25 50 + + + + + +DMAKE(1) DMAKE(1) + + PORTABILITY - To write makefiles that can be moved from one environment to another + To write makefiles that can be moved from one environment to another requires some forethought. In particular you must define as macros all - those things that may be different in the new environment. dmake has - two facilities that help to support writing portable makefiles, recur- - sive macros and conditional expressions. The recursive macros, allow - one to define environment configurations that allow different environ- - ments for similar types of operating systems. For example the same + those things that may be different in the new environment. dmake has + two facilities that help to support writing portable makefiles, recur- + sive macros and conditional expressions. The recursive macros, allow + one to define environment configurations that allow different environ- + ments for similar types of operating systems. For example the same make script can be used for SYSV and BSD but with different macro defi- nitions. - To write a makefile that is portable between UNIX and MSDOS requires - both features since in almost all cases you will need to define new + To write a makefile that is portable between UNIX and MSDOS requires + both features since in almost all cases you will need to define new recipes for making targets. The recipes will probably be quite differ- - ent since the capabilities of the tools on each machine are different. - Different macros will be needed to help handle the smaller differences + ent since the capabilities of the tools on each machine are different. + Different macros will be needed to help handle the smaller differences in the two environments. FILES - Makefile, makefile, startup.mk (use dmake -V to tell you where the + Makefile, makefile, startup.mk (use dmake -V to tell you where the startup file is) SEE ALSO @@ -3480,32 +3522,20 @@ SEE ALSO AUTHOR Dennis Vadura, dvadura@wticorp.com - Many thanks to Carl Seger for his helpful suggestions, and to Trevor + Many thanks to Carl Seger for his helpful suggestions, and to Trevor John Thompson for his many excellent ideas and informative bug reports. - Many thanks also go to those on the NET that have helped in making + Many thanks also go to those on the NET that have helped in making dmake one of the best Make tools available. BUGS - Some system commands return non-zero status inappropriately. Use -i + Some system commands return non-zero status inappropriately. Use -i (`-' within the makefile) to overcome the difficulty. - - - -Dmake Version 4.8 2007-04-24 49 - - - - - -DMAKE(1) DMAKE(1) - - Some systems do not have easily accessible time stamps for library mem- - bers (MSDOS, AMIGA, etc) for these dmake uses the time stamp of the - library instead and prints a warning the first time it does so. This - is almost always ok, except when multiple makefiles update a single - library file. In these instances it is possible to miss an update if + bers (MSDOS, AMIGA, etc) for these dmake uses the time stamp of the + library instead and prints a warning the first time it does so. This + is almost always ok, except when multiple makefiles update a single + library file. In these instances it is possible to miss an update if one is not careful. This man page is way too long. @@ -3517,7 +3547,7 @@ WARNINGS PWD from csh/ksh will cause problems if a cd operation is performed and -e or -E option is used. - Using internal macros such as COMMAND, may wreak havoc if you don't + Using internal macros such as COMMAND, may wreak havoc if you don't understand their functionality. @@ -3527,46 +3557,6 @@ WARNINGS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Dmake Version 4.8 2007-04-24 50 +Dmake Version 4.9 2007-06-25 51 |