1 subdirmk - assistance for non-recursive use of make
2 ===================================================
7 Peter Miller's 1997 essay _Recursive Make Considered Harmful_
8 persuasively argues that it is better to arrange to have a single
9 make invocation with the project's complete dependency tree, rather
10 than the currently conventional `$(MAKE) -C subdirectory' approach.
12 However, actually writing a project's build system in a non-recursive
13 style is not very ergonomic. The main difficulties are:
14 - constantly having to write out long file and directory names
15 - the lack of a per-directory make variable namespace means
16 long make variables (or namespace clashes)
17 - it is difficult to arrange that one can cd to a subdirectory
18 and say `make all' and have something reasonable happen
19 (to wit, build an appropriate subset)
21 `subdirmk' is an attempt to solve these problems (and it also slightly
22 alleviates some of the boilerplate needed to support out-of-tree
28 The developer is expected to write a makefile fragment, in each
29 relevant subdirectory, called `Subdir.sd.mk'.
31 These fragments may contain ordinary make language.
33 However, the sigil & is treated specially. By and large, it refers to
34 `the current directory'. There are a variety of convenient
37 The result is that to a large extent, the Subdir.sd.mk has an easy way
38 to namespace its "local" make variables, and an easy way to refer to
39 its "local" filenames.
41 The Subdir.sd.mk's are filtered, fed through autoconf in the usual way
42 (for @..@-substitutions) and included by one autogenerated toplevel
45 So all of the input is combined and passed to one make invocation.
46 (A corollary is that there is no enforcement of the namespacing:
47 discipline is required to prefix relevant variable names with &, etc.)
49 Each subdirectory is also provided with an autogenerated `Makefile'
50 which exists purely to capture ordinary make invocations and arrange
51 for something suitable to happen.
53 Where there are dependencies between subdirectories, each Subdir.sd.mk
54 can simply refer to files in other subdirectories directly.
56 Invocation, "recursive" per-directory targets
57 ---------------------------------------------
59 Arrangements are made so that when you run `make foo' in a
60 subdirectory, it is like running the whole toplevel makefile, from the
61 toplevel, as `make subdir/foo'. If `subdir/foo' is a file that might
62 be built, that builds it.
64 But `foo' can also be a conventional target like `all'.
66 Each subdirectory has its own `all' target. For example a
67 subdirectory `src' has a target `src/all'. The rules for these are
68 automatically generated from the settings of the per-directory
69 &TARGETS variables. &TARGETS is magic in this way. (In
70 src/Subdir.sd.mk, &TARGETS of course refers to a make variable called
73 The `all' target in a parent directory is taken to imply the `all'
74 targets in all of its subdirectories, recursively. And in the
75 autogenerated stub Makefiles, `all' is the default target. So if you
76 just type `make' in the toplevel, you are asking for `&all'
77 (<subdir>/all) for every directory in the project.
79 In a parallel build, the rules for all these various subdirectory
80 targets may be in run in parallel: there is only one `make' invocation
81 at a time. There is no sequencing between subdirectories, only been
82 individual targets (as specified according to their dependencies).
84 You can define other per-directory recursive targets too: simply
85 mention (usually, by setting) the variable &TARGETS_zonk, or whatever.
86 This will create a src/zonk target (for appropriate value of src/).
87 Unlike `all', these other targets only exist in areas of the project
88 where at least something mentions them. So for example, if
89 &TARGETS_zonk is mentioned in src but not lib, `make zonk' in
90 lib will fail. If you want to make a target exist everywhere,
91 mention its name in Perdir.sd.mk (see below).
93 Perdir.sd.mk, inclusion
94 -----------------------
96 The file Perdir.sd.mk in the toplevel of the source is automatically
97 processed after each individual directory's Subdir.sd.mk, and the
98 &-substituted contents therefore appear once for each subdirectory.
100 This lets you do per-directory boilerplate. Some useful boilerplate
101 is already provided in subdirmk, for you to reference like this:
102 &:include subdirmk/cdeps.sd.mk
103 &:include subdirmk/clean.sd.mk
104 For example you could put that in Perdir.sd.mk.
109 If want to set global variables, such as CC, that should only be done
110 once. You can put them in your top-level Subdir.sd.mk, or a separate
111 file you `include' and declare using SUBDIRMK_MAKEFILES.
113 If you need different settings of variables like CC for different
114 subdirectories, you should probably do that with target-specific
115 variable settings. See the info node `(make) Target-specific'.
117 Subdirectory templates `.sd.mk' vs plain autoconf templates `.mk.in'
118 --------------------------------------------------------------------
120 There are two kinds of template files.
122 Filename .sd.mk .mk.in
124 Processed by &-substitution, autoconf only
127 Instantiated Usu. once per subdir Once only
129 Need to be mentioned No, but Subdir.sd.mk All not in subdirmk/
130 in configure.ac? via SUBDIRMK_SUBDIRS via SUBDIRMK_MAKEFILES
132 How to include `&:include foo.sd.mk' `include foo.mk'
133 in all relevant .sd.mk in only one
134 (but not needed for Subdir.sd.mk
137 If you `include subdirmk/regen.mk', dependency management and
138 automatic regeneration for all of this template substitution, and for
139 config.status etc. is done for you.
141 Summary of recommended directory reference syntaxes
142 ---------------------------------------------------
144 Path construction &-expansions, meanings summary:
146 In build tree In source tree
147 This directory just & &,
148 Top level &. implies absolute &;
150 Adding `@' means "absolute path". This is not needed with &. because
151 there is never any need to use &. since it would expand to nothing.
152 `/' terminates the escape (needed if the next thing is not a lowercase
153 character, or space). `=' means "just the value, no /". Space starts
154 multi-word processing.
156 Recommended In build tree In source tree
157 when Relative Absolute Relative Absolute
159 This lc &file &@file &,file &@,file
160 directory any &/file &@/file &,/file &@,/file
161 several & f g h &@ f g h &, f g h &@, f g h
163 Top lc &.file &;file &@;file
164 level any file &./file &;/file &@;/file
165 several f g h &. f g h &; f g h &@; f g h
166 .mk.in file $(abs)/file $(src)/file $(abs_src)/file
171 In general & expands to the subdirectory name when used for a
172 filename, and to the subdirectory name with / replaced with _ for
175 Note that & is processed *even in makefile comments*. The substitutor
176 does not understand make syntax, or shell syntax, at all. However,
177 the substitution rules are chosen to work well with constructs which
178 are common in makefiles.
180 In the notation below, we suppose that the substitution is being in
181 done in a subdirectory sub/dir of the source tree. In the RH column
182 we describe the expansion at the top level, which is often a special
183 case (in general in variable names we call that TOP rather than the
186 &CAPS => sub_dir_CAPS or TOP_CAPS
187 &lc => sub/dir/lc or lc
188 Here CAPS is any ASCII letter A-Z and lc is a-z.
189 The assumption is that filenames are usually lowercase and
190 variables usually uppercase. Otherwise, use another syntax:
192 &_ => sub_dir_ or TOP_
193 &/ => sub/dir/ or nothing
194 &=_ => sub_dir or TOP
196 &^ => $(top_srcdir)/sub/dir or $(top_srcdir)
197 &~ => $(abs_top_srcdir)/sub/dir or $(abs_top_srcdir)
200 ^ filenames in source tree rather than build tree
201 ~ filenames are absolute rather than relative
202 @ filenames do not contain subdir (useful with the above)
204 && => && for convenience in shell runes
205 \& => & general escaping mechanism
210 Convenience syntax for prefixing multiple filenames.
211 Introduced by & followed by lwsp (space or tab).
212 Each lwsp-separated non-ws word is prefixed by &/ &^/ &~/
213 respectively. No other & escapes are recognised.
214 This processing continues until & preceded by lwsp,
215 or until EOL (the end of the line), or \ then EOL.
217 &:<directive> <args>....
218 recognised at start of line only (possibly after lwsp)
219 args are processed for &
221 &:include filename filename should usually be foo.sd.mk
222 &:-include filename tolerate nonexistent file
223 filenames are relative to $(top_srcdir)
225 &!<lwsp> disables & until EOL (and then disappears)
227 &# delete everything to end of line
228 (useful if the RHS contains unrecognised & constructions)
231 changes the escape sequence from & to literally STUFF
232 STUFF may be any series of of non-whitespace characters,
233 and is terminated by EOL or lwsp. &!STUFF and the lwsp
236 After this, write STUFF instead of &, everywhere.
237 The effect is global and lasts until the next setting.
238 It takes effect on &:include'd files too, so maybe set
239 it back before using &:include.
242 STUFFSTUFF => STUFFSTUFF
244 STUFF!& set escape back to &
247 Handled specially. If mentioned, declares that this
248 subdir ought to have a target `things'. The rule will be
249 &/things:: $(&TARGETS_things)
251 You may extend it by adding more :: rules for the target,
252 but the preferred style is to do things like this:
253 &TARGETS_check += & test-passed.stamp
255 It is important to mention &TARGETS_things at least once in
256 the context of each applicable directory, because doing so
257 arranges that the *parent* will also have a `things' target
258 which recursively implies this directory's `things'.
260 Must be spelled exactly &TARGETS_things. &_TARGETS_things,
261 for example, is not magic. But mentioning &TARGETS_things in
262 a #-comment *does* work because the & filter does not care
265 `all' is extra special: every directory has an `all'
266 target, which corresponds to &TARGETS.
268 Subdirectory and variable naming
269 --------------------------------
271 The simple variable decoration scheme does not enforce a strict
272 namespace distinction between parts of variable names which come from
273 subdirectory names, and parts that mean something else.
275 So it is a good idea to be a bit careful with your directory naming.
276 `TOP', names that contain `_', and names that are similar to parts of
277 make variables (whether conventional ones, or ones used in your
278 project) are best avoided.
280 If you name your variables in ALL CAPS and your subdirectories in
281 lower case with `-' rather than `_', there will be no confusion.
283 Incorporating this into your project
284 ------------------------------------
286 Use `git-subtree' to merge the subdirmk/ directory. You may find it
287 useful to symlink the DEVELOPER-CERTIFICATE file (git can store
288 symlinks as symlinks - just `git add' the link). And you probably
289 want to mention the situation in your top-level COPYING.
291 Symlink autogen.sh into your project toplevel.
293 In your configure.ac, say
295 m4_include([subdirmk/subdirmk.ac])
296 SUBDIRMK_SUBDIRS([...list of subdirectories in relative syntax...])
298 Write a Subdir.sd.mk in each directory. The toplevel one should
301 include subdirmk/usual.mk
302 include subdirmk/regen.mk
304 Write a Perdir.sd.mk in the toplevel, if you want. It should probably
307 &:include subdirmk/cdeps.sd.mk
308 &:include subdirmk/clean.sd.mk
313 You can convert your project incrementally. Start with the top-level
314 Makefile.in and rename it to Subdir.sd.mk, and add the appropriate
315 stuff to configure.ac, and fix everything up. Leave the existing
316 $(MAKE) -C for your existing subdirectories alone. Then you can
317 convert individual subdirectories, or classes of subdirectories, at
318 your leisure. (You must be /sure/ that each subdirectory will be
319 entered only once at a time, but your existing recursive make descent
320 system should already do that or you already have concurrency bugs.)
322 Aside from this, be very wary of any invocation of $(MAKE) anywhere.
323 This is a frequent source of concurrency bugs in recursive make build
324 systems. When combined with nonrecursive make it's all in the same
325 directory and there is nothing stopping the different invocations
326 ending up trying to make the same targets at the same time. That
327 causes hideous racy lossage. There are ways to get this to work
328 reliably but it is advanced stuff.
330 If you make syntax errors, or certain kinds of other errors, in your
331 makefiles, you may find that just `make' is broken now and cannot get
332 far enough to regenerate a working set of makefiles. If this happens
333 just rerun ./config.status by hand.
340 Copyright 2019 Mark Wooding
341 Copyright 2019 Ian Jackson
343 subdirmk and its example is free software; you can redistribute it
344 and/or modify it under the terms of the GNU Library General Public
345 License as published by the Free Software Foundation; either
346 version 2 of the License, or (at your option) any later version.
348 This is distributed in the hope that it will be useful, but
349 WITHOUT ANY WARRANTY; without even the implied warranty of
350 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
351 Library General Public License for more details.
353 You should have received a copy of the GNU Library General Public
354 License along with this library as the file LGPL-2.
355 If not, see https://www.gnu.org/.
357 Individual files generally contain the following tag in the copyright
358 notice, instead of the full licence grant text:
359 SPDX-License-Identifier: LGPL-2.0-or-later
360 As is conventional, this should be read as a licence grant.
362 Contributions are accepted based on the git commit Signed-off-by
363 convention, by which the contributors' certify their contributions
364 according to the Developer Certificate of Origin version 1.1 - see
365 the file DEVELOPER-CERTIFICATE.
367 Where subdirmk is used by and incorporated into another project (eg
368 via git subtree), the directory subdirmk/ is under GNU LGPL-2.0+, and
369 the rest of the project are under that other project's licence(s).
370 (The project's overall licence must be compatible with LGPL-2.0+.)