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