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