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