chiark / gitweb /
Interface: Rename Perdir to Suffix; provide Prefix
[subdirmk.git] / README
1 subdirmk - assistance for non-recursive use of make
2 ===================================================
3
4 Introduction
5 ------------
6
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.
11
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)
20
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
23 builds well).
24
25 Basic approach
26 --------------
27
28 The developer is expected to write a makefile fragment, in each
29 relevant subdirectory, called `Subdir.sd.mk'.
30
31 These fragments may contain ordinary make language.  Unqualified
32 filenames are relative to the build toplevel, and all commands all run
33 there.
34
35 However, the sigil & is treated specially.  By and large, it refers to
36 `the build directory corresponding to this .sd.mk file', etc.
37 There are a variety of convenient constructions.
38
39 The result is that to a large extent, the Subdir.sd.mk has an easy way
40 to namespace its "local" make variables, and an easy way to refer to
41 its "local" filenames (and filenames in general).
42
43 The Subdir.sd.mk's are filtered, fed through autoconf in the usual way
44 (for @..@-substitutions) and included by one autogenerated toplevel
45 makefile.
46
47 So all of the input is combined and passed to one make invocation.
48 (A corollary is that there is no enforcement of the namespacing:
49 discipline is required to prefix relevant variable names with &, etc.)
50
51 Each subdirectory is also provided with an autogenerated `Makefile'
52 which exists purely to capture ordinary make invocations and arrange
53 for something suitable to happen.
54
55 Where there are dependencies between subdirectories, each Subdir.sd.mk
56 can simply refer to files in other subdirectories directly.
57
58 Invocation, "recursive" per-directory targets
59 ---------------------------------------------
60
61 Arrangements are made so that when you run `make foo' in a
62 subdirectory, it is like running the whole toplevel makefile, from the
63 toplevel, as `make subdir/foo'.  If `subdir/foo' is a file that might
64 be built, that builds it.
65
66 But `foo' can also be a conventional target like `all'.
67
68 Each subdirectory has its own `all' target.  For example a
69 subdirectory `src' has a target `src/all'.  The rules for these are
70 automatically generated from the settings of the per-directory
71 &TARGETS variables.  &TARGETS is magic in this way.  (In
72 src/Subdir.sd.mk, &TARGETS of course refers to a make variable called
73 src_TARGETS.)
74
75 The `all' target in a parent directory is taken to imply the `all'
76 targets in all of its subdirectories, recursively.  And in the
77 autogenerated stub Makefiles, `all' is the default target.  So if you
78 just type `make' in the toplevel, you are asking for `&all'
79 (<subdir>/all) for every directory in the project.
80
81 In a parallel build, the rules for all these various subdirectory
82 targets may be in run in parallel: there is only one `make' invocation
83 at a time.  There is no sequencing between subdirectories, only been
84 individual targets (as specified according to their dependencies).
85
86 You can define other per-directory recursive targets too: simply
87 mention (usually, by setting) the variable &TARGETS_zonk, or whatever.
88 This will create a src/zonk target (for appropriate value of src/).
89 Unlike `all', these other targets only exist in areas of the project
90 where at least something mentions them.  So for example, if
91 &TARGETS_zonk is mentioned in src but not lib, `make zonk' in
92 lib will fail.  If you want to make a target exist everywhere,
93 mention its name in Prefix.sd.mk or Suffix.sd.mk (see below).
94
95 Prefix.sd.mk, Suffix.sd.mk, inclusion
96 -------------------------------------
97
98 The files Prefix.sd.mk and Suffix.sd.mk in the toplevel of the source
99 are automatically processed before and after each individual
100 directory's Subdir.sd.mk, and the &-substituted contents therefore
101 appear once for each subdirectory.
102
103 This lets you do per-directory boilerplate.  Some useful boilerplate
104 is already provided in subdirmk, for you to reference like this:
105   &:include subdirmk/cdeps.sd.mk
106   &:include subdirmk/clean.sd.mk
107 For example you could put that in Suffix.sd.mk.
108
109 The top-level Subdir.sd.mk is the first makefile included after the
110 autogenerated `main.mk' which merely has some basic settings and
111 includes.  So if you want to get in early and set global variables,
112 put them near the top of Subdir.sd.mk.
113
114 subdirmk's filter script itself sets (only) these variables:
115   top_srcdir
116   abs_top_srcdir
117   SUBDIRMK_MAKEFILES
118   MAKEFILE_TEMPLATES
119 You are likely to want to define $(PWD), and shorter names for
120 top_srdir and abs_top_srcdir (we suggest $(src) and $(abs_src)).
121
122 Global definitions
123 ------------------
124
125 If want to set global variables, such as CC, that should only be done
126 once.  You can put them in your top-level Subdir.sd.mk, or a separate
127 file you `include' and declare using SUBDIRMK_MAKEFILES.
128
129 If you need different settings of variables like CC for different
130 subdirectories, you should probably do that with target-specific
131 variable settings.  See the info node `(make) Target-specific'.
132
133 Subdirectory templates `.sd.mk' vs plain autoconf templates `.mk.in'
134 --------------------------------------------------------------------
135
136 There are two kinds of template files.
137
138  Filename                 .sd.mk                  .mk.in
139
140  Processed by             &-substitution,         autoconf only
141                           then autoconf
142
143  Instantiated             Usu. once per subdir    Once only
144
145  Need to be mentioned     No, but Subdir.sd.mk    All not in subdirmk/
146  in configure.ac?         via SUBDIRMK_SUBDIRS    via SUBDIRMK_MAKEFILES
147
148  How to include           `&:include foo.sd.mk'   `include foo.mk'
149                           in all relevant .sd.mk  in only one
150                           (but not needed for     Subdir.sd.mk
151                            Prefix, Suffix)
152
153 If you `include subdirmk/regen.mk', dependency management and
154 automatic regeneration for all of this template substitution, and for
155 config.status etc. is done for you.
156
157 Tables of file reference syntaxes
158 ---------------------------------
159
160 In a nonrecursive makefile supporting out of tree builds there are
161 three separate important distinctions between different file
162 locations:
163
164  (i) In the build tree, or in the source tree ?
165
166  (ii) In (or relative to) the subdirectory to which this Subdir.sd.mk
167      relates, or relative to the project's top level ?
168
169  (iii) Absolute or relative pathname ?  Usually relative pathnames
170      suffice.  Where an absolute pathname is needed, it can be built
171      out of &/ and an appropriate make variable such as $(PWD).
172
173 Path construction &-expansions are built from the following:
174
175                       Relative paths in...
176                       build     source
177                                                        
178   This directory      &         &^
179   Top level           .         &~
180
181 In more detail, with all the various options laid out:
182
183       Recommended     Relative paths in...   Absolute paths in...
184              for      build     source       build         source
185                                                        
186   This       lc       &file     &^file       $(PWD)/&file  $(abs_src)/&file
187   directory  any      &/file    &^/file      $(PWD)/&/file $(abs_src)/&/file
188              several  & f g h   &^ f g h     $(addprefix...)
189                                              
190   Top        lc       file      &~file
191   level      any      file      &~/file      $(PWD)/file   $(abs_src)/file
192              .mk.in   file      $(src)/file  $(PWD)/file   $(abs_src)/file
193              several  f g h     &~ f g h     $(addprefix...)
194
195 (This assumes you have appropriate make variables src, PWD and
196 abs_src.)
197
198 Substitution syntax
199 -------------------
200
201 In general & expands to the subdirectory name when used for a
202 filename, and to the subdirectory name with / replaced with _ for
203 variable names.
204
205 Note that & is processed *even in makefile comments*.  The substitutor
206 does not understand make syntax, or shell syntax, at all.  However,
207 the substitution rules are chosen to work well with constructs which
208 are common in makefiles.
209
210 In the notation below, we suppose that the substitution is being in
211 done in a subdirectory sub/dir of the source tree.  In the RH column
212 we describe the expansion at the top level, which is often a special
213 case (in general in variable names we call that TOP rather than the
214 empty string).
215
216 &CAPS           =>      sub_dir_CAPS                    or TOP_CAPS
217 &lc             =>      sub/dir/lc                      or lc
218         Here CAPS is any ASCII letter A-Z and lc is a-z.
219         The assumption is that filenames are usually lowercase and
220         variables usually uppercase.  Otherwise, use another syntax:
221
222 &/              =>      sub/dir/                        or nothing
223 &_              =>      sub_dir_                        or TOP_
224 &.              =>      sub/dir                         or .
225         (This implies that `&./' works roughly like `&/', although
226         it can produce a needless `./')
227
228 &=              =>      sub_dir                         or TOP
229
230 &^lc            =>      $(top_srcdir)/sub/dir/lc
231 &^/             =>      $(top_srcdir)/sub/dir/
232 &^.             =>      $(top_srcdir)/sub/dir
233
234 &~lc            =>      $(top_srcdir)/lc
235 &~/             =>      $(top_srcdir)/
236 &~.             =>      $(top_srcdir)
237
238 In general:
239     ^   pathname of this subdirectory in source tree
240     ~   pathname of top level of source tree
241     /   terminates the path escape } needed if next is
242     _   terminates the var escape  } not lwsp or space)
243     .   terminates path escape giving dir name (excluding /)
244     =   terminates var escape giving only prefix part (rarely needed)
245   lwsp  starts multi-word processing (see below)
246
247 So pathname syntax is a subset of:
248     '&' [ '^' | '~' ] [ lc | '/' | '.' | '=' ]
249
250 &&              =>      &&              for convenience in shell runes
251
252 &\&             =>      &               general escaping mechanism
253 &\$             =>      $
254 &\NEWLINE                               eats the newline and vanishes
255
256 &$VARIABLE      =>      $(sub_dir_VARIABLE)     or $(TOP_VARIABLE)
257         VARIABLE is ASCII starting with a letter and matching \w+
258
259 & thing thing... &
260 &^ thing thing... &
261 &~ thing thing... &
262         Convenience syntax for prefixing multiple filenames.
263         Introduced by & followed by lwsp where lc could go.
264         Each lwsp-separated non-ws word is prefixed by &/ etc.
265         etc. respectively.  No other & escapes are recognised.
266         This processing continues until & preceded by lwsp,
267         or until EOL (the end of the line), or \ then EOL.
268
269 &:<directive> <args>....
270         recognised at start of line only (possibly after lwsp)
271
272 &:include filename              filename should usually be [&]foo.sd.mk
273 &:-include filename             tolerate nonexistent file
274         filenames are relative to $(top_srcdir)
275         RHS is &-expanded
276
277 &!<lwsp>        disables & until EOL (and then disappears)
278
279 &#      delete everything to end of line
280         (useful if the RHS contains unrecognised & constructions)
281
282 &:changequote NEWQUOTE
283         changes the escape sequence from & to literally NEWQUOTE
284         NEWQUOTE may be any series of of non-whitespace characters,
285         and is terminated by EOL or lwsp.  The whole line is
286         discarded.
287
288         After this, write NEWQUOTE instead of &, everywhere.
289         The effect is global and lasts until the next setting.
290         It takes effect on &:include'd files too, so maybe set
291         it back before using &:include.
292
293         Notably
294                 NEWQUOTENEWQUOTE        => NEWQUOTENEWQUOTE
295                 NEWQUOTE\NEWQUOTE       => NEWQUOTE
296                 NEWQUOTE\$              => $
297                 NEWQUOTE:changequote &  set escape back to &
298
299 &TARGETS_things
300         Handled specially.  If mentioned at the start of a line
301         (possibly following whitespace), declares that this
302         subdir ought to have a target `things'.  The rule will be
303                 &/things:: $(&TARGETS_things)
304
305         You may extend it by adding more :: rules for the target,
306         but the preferred style is to do things like this:
307                 &TARGETS_check += & test-passed.stamp
308
309         It is important to mention &TARGETS_things at least once in
310         the context of each applicable directory, because doing so
311         arranges that the *parent* will also have a `things' target
312         which recursively implies this directory's `things'.
313
314         Must be spelled exactly &TARGETS_things.  &_TARGETS_things,
315         for example, is not magic.  To make the target exist
316         without providing any prerequisites for it, write a line
317         containing just `&TARGETS_things +='.
318
319         `all' is extra special: every directory has an `all'
320         target, which corresponds to &TARGETS.
321
322 Subdirectory and variable naming
323 --------------------------------
324
325 The simple variable decoration scheme does not enforce a strict
326 namespace distinction between parts of variable names which come from
327 subdirectory names, and parts that mean something else.
328
329 So it is a good idea to be a bit careful with your directory naming.
330 `TOP', names that contain `_', and names that are similar to parts of
331 make variables (whether conventional ones, or ones used in your
332 project) are best avoided.
333
334 If you name your variables in ALL CAPS and your subdirectories in
335 lower case with `-' rather than `_', there will be no confusion.
336
337 Incorporating this into your project
338 ------------------------------------
339
340 Use `git-subtree' to merge the subdirmk/ directory.  You may find it
341 useful to symlink the DEVELOPER-CERTIFICATE file (git can store
342 symlinks as symlinks - just `git add' the link).  And you probably
343 want to mention the situation in your top-level COPYING.
344
345 Symlink autogen.sh into your project toplevel.
346
347 In your configure.ac, say
348
349   m4_include([subdirmk/subdirmk.ac])
350   SUBDIRMK_SUBDIRS([...list of subdirectories in relative syntax...])
351
352 Write a Subdir.sd.mk in each directory.  The toplevel one should
353 probably contain:
354
355   include subdirmk/usual.mk
356   include subdirmk/regen.mk
357
358 Write a Suffix.sd.mk in the toplevel, if you want.  It should probably
359 have:
360
361   &:include subdirmk/cdeps.sd.mk
362   &:include subdirmk/clean.sd.mk
363
364 Hints
365 -----
366
367 You can convert your project incrementally.  Start with the top-level
368 Makefile.in and rename it to Subdir.sd.mk, and add the appropriate
369 stuff to configure.ac, and fix everything up.  Leave the existing
370 $(MAKE) -C for your existing subdirectories alone.  Then you can
371 convert individual subdirectories, or classes of subdirectories, at
372 your leisure.  (You must be /sure/ that each subdirectory will be
373 entered only once at a time, but your existing recursive make descent
374 system should already do that or you already have concurrency bugs.)
375
376 Aside from this, be very wary of any invocation of $(MAKE) anywhere.
377 This is a frequent source of concurrency bugs in recursive make build
378 systems.  When combined with nonrecursive make it's all in the same
379 directory and there is nothing stopping the different invocations
380 ending up trying to make the same targets at the same time. That
381 causes hideous racy lossage.  There are ways to get this to work
382 reliably but it is advanced stuff.
383
384 If you make syntax errors, or certain kinds of other errors, in your
385 makefiles, you may find that just `make' is broken now and cannot get
386 far enough to regenerate a working set of makefiles.  If this happens
387 just rerun ./config.status by hand.
388
389 If you go back and forth between different versions of your code you
390 can sometimes find that `make' complains that one of your Subdir.sd.mk
391 files is missing: typically, if iot was used and therefore a
392 dependency in some other version of your code.  If you run `make
393 clean' (or `make realclean') these dependencies are suppressed, which
394 will clear up the problem.
395
396
397 Legal information
398 -----------------
399
400 subdirmk is
401  Copyright 2019 Mark Wooding
402  Copyright 2019 Ian Jackson
403
404     subdirmk and its example is free software; you can redistribute it
405     and/or modify it under the terms of the GNU Library General Public
406     License as published by the Free Software Foundation; either
407     version 2 of the License, or (at your option) any later version.
408
409     This is distributed in the hope that it will be useful, but
410     WITHOUT ANY WARRANTY; without even the implied warranty of
411     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
412     Library General Public License for more details.
413
414     You should have received a copy of the GNU Library General Public
415     License along with this library as the file LGPL-2.
416     If not, see https://www.gnu.org/.
417
418 Individual files generally contain the following tag in the copyright
419 notice, instead of the full licence grant text:
420   SPDX-License-Identifier: LGPL-2.0-or-later
421 As is conventional, this should be read as a licence grant.
422
423 Contributions are accepted based on the git commit Signed-off-by
424 convention, by which the contributors' certify their contributions
425 according to the Developer Certificate of Origin version 1.1 - see
426 the file DEVELOPER-CERTIFICATE.
427
428 Where subdirmk is used by and incorporated into another project (eg
429 via git subtree), the directory subdirmk/ is under GNU LGPL-2.0+, and
430 the rest of the project are under that other project's licence(s).
431 (The project's overall licence must be compatible with LGPL-2.0+.)