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.
  32
  33 However, the sigil & is treated specially.  By and large, it refers to
  34 `the current directory'.  There are a variety of convenient
  35 constructions.
  36
  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.
  40
  41 The Subdir.sd.mk's are filtered, fed through autoconf in the usual way
  42 (for @..@-substitutions) and included by one autogenerated toplevel
  43 makefile.
  44
  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.)
  48
  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.
  52
  53 Where there are dependencies between subdirectories, each Subdir.sd.mk
  54 can simply refer to files in other subdirectories directly.
  55
  56 Invocation, "recursive" per-directory targets
  57 ---------------------------------------------
  58
  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.
  63
  64 But `foo' can also be a conventional target like `all'.
  65
  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
  71 src_TARGETS.)
  72
  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.
  78
  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).
  83
  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).
  92
  93 Perdir.sd.mk, inclusion
  94 -----------------------
  95
  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.
  99
 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.
 105
 106 Global definitions
 107 ------------------
 108
 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.
 112
 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'.
 116
 117 Subdirectory templates `.sd.mk' vs plain autoconf templates `.mk.in'
 118 --------------------------------------------------------------------
 119
 120 There are two kinds of template files.
 121
 122  Filename                 .sd.mk                  .mk.in
 123
 124  Processed by             &-substitution,         autoconf only
 125                           then autoconf
 126
 127  Instantiated             Usu. once per subdir    Once only
 128
 129  Need to be mentioned     No, but Subdir.sd.mk    All not in subdirmk/
 130  in configure.ac?         via SUBDIRMK_SUBDIRS    via SUBDIRMK_MAKEFILES
 131
 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
 135                            Subdir and Perdir)
 136
 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.
 140
 141 Summary of directory reference syntaxes
 142 ---------------------------------------
 143
 144       Recommended     In build tree             In source tree
 145              when     Relative  Absolute        Relative     Absolute
 146
 147   This       lc       &file     &~file          &^file       &^~file
 148   directory  any      &/file    &~/file         &^/file      &^~/file
 149              several  & f g h   & ~ f g h       & ^ f g h    & ^~ f g h
 150
 151   Top        lc                 &@~file         &@^file      &@~^file
 152   level      any      file      &@~/file        &@^/file     &@~^/file
 153              .mk.in   file      $(abs)/file     $(src)/file  $(abs_src)/file
 154              several  f g h     & @~ f g h      & @^ f g h   & @~^ f g h
 155
 156 Substitution syntax
 157 -------------------
 158
 159 In general & expands to the subdirectory name when used for a
 160 filename, and to the subdirectory name with / replaced with _ for
 161 variable names.
 162
 163 Note that & is processed *even in makefile comments*.  The substitutor
 164 does not understand make syntax, or shell syntax, at all.  However,
 165 the substitution rules are chosen to work well with constructs which
 166 are common in makefiles.
 167
 168 In the notation below, we suppose that the substitution is being in
 169 done in a subdirectory sub/dir of the source tree.  In the RH column
 170 we describe the expansion at the top level, which is often a special
 171 case (in general in variable names we call that TOP rather than the
 172 empty string).
 173
 174 &CAPS           =>      sub_dir_CAPS                    or TOP_CAPS
 175 &lc             =>      sub/dir/lc                      or lc
 176         Here CAPS is any ASCII letter A-Z and lc is a-z.
 177         The assumption is that filenames are usually lowercase and
 178         variables usually uppercase.  Otherwise, use another syntax:
 179
 180 &_              =>      sub_dir_                        or TOP_
 181 &/              =>      sub/dir/                        or nothing
 182 &=_             =>      sub_dir                         or TOP
 183 &=/             =>      sub/dir                         or .
 184 &^              =>      $(top_srcdir)/sub/dir           or $(top_srcdir)
 185 &~              =>      $(abs_top_srcdir)/sub/dir       or $(abs_top_srcdir)
 186
 187 In general:
 188         ^       filenames in source tree rather than build tree
 189         ~       filenames are absolute rather than relative
 190         @       filenames do not contain subdir (useful with the above)
 191
 192 &&              =>      &&              for convenience in shell runes
 193 \&              =>      &               general escaping mechanism
 194
 195 & thing thing... &
 196 & ^ thing thing... &
 197 & ~ thing thing... &
 198         Convenience syntax for prefixing multiple filenames.
 199         Introduced by & followed by lwsp (space or tab).
 200         Each lwsp-separated non-ws word is prefixed by &/ &^/ &~/
 201         respectively.  No other & escapes are recognised.
 202         This processing continues until & preceded by lwsp,
 203         or until EOL (the end of the line), or \ then EOL.
 204
 205 &:<directive> <args>....
 206         recognised at start of line only (possibly after lwsp)
 207         args are processed for &
 208
 209 &:include filename              filename should usually be foo.sd.mk
 210 &:-include filename             tolerate nonexistent file
 211         filenames are relative to $(top_srcdir)
 212
 213 &!<lwsp>        disables & until EOL (and then disappears)
 214
 215 &#      delete everything to end of line
 216         (useful if the RHS contains unrecognised & constructions)
 217
 218 &!STUFF
 219         changes the escape sequence from & to literally STUFF
 220         STUFF may be any series of of non-whitespace characters,
 221         and is terminated by EOL or lwsp.  &!STUFF and the lwsp
 222         are discarded.
 223
 224         After this, write STUFF instead of &, everywhere.
 225         The effect is global and lasts until the next setting.
 226         It takes effect on &:include'd files too, so maybe set
 227         it back before using &:include.
 228
 229         Notably
 230                 STUFFSTUFF      =>      STUFFSTUFF
 231                 \STUFF          =>      STUFF
 232                 STUFF!&         set escape back to &
 233
 234 &TARGETS_things
 235         Handled specially.  If mentioned, declares that this
 236         subdir ought to have a target `things'.  The rule will be
 237                 &/things:: $(&TARGETS_things)
 238
 239         You may extend it by adding more :: rules for the target,
 240         but the preferred style is to do things like this:
 241                 &TARGETS_check += & test-passed.stamp
 242
 243         It is important to mention &TARGETS_things at least once in
 244         the context of each applicable directory, because doing so
 245         arranges that the *parent* will also have a `things' target
 246         which recursively implies this directory's `things'.
 247
 248         Must be spelled exactly &TARGETS_things.  &_TARGETS_things,
 249         for example, is not magic.  But mentioning &TARGETS_things in
 250         a #-comment *does* work because the & filter does not care
 251         about comments.
 252
 253         `all' is extra special: every directory has an `all'
 254         target, which corresponds to &TARGETS.
 255
 256 Subdirectory and variable naming
 257 --------------------------------
 258
 259 The simple variable decoration scheme does not enforce a strict
 260 namespace distinction between parts of variable names which come from
 261 subdirectory names, and parts that mean something else.
 262
 263 So it is a good idea to be a bit careful with your directory naming.
 264 `TOP', names that contain `_', and names that are similar to parts of
 265 make variables (whether conventional ones, or ones used in your
 266 project) are best avoided.
 267
 268 If you name your variables in ALL CAPS and your subdirectories in
 269 lower case with `-' rather than `_', there will be no confusion.
 270
 271 Incorporating this into your project
 272 ------------------------------------
 273
 274 Use `git-subtree' to merge the subdirmk/ directory.  You may find it
 275 useful to symlink the DEVELOPER-CERTIFICATE file (git can store
 276 symlinks as symlinks - just `git add' the link).  And you probably
 277 want to mention the situation in your top-level COPYING.
 278
 279 Symlink autogen.sh into your project toplevel.
 280
 281 In your configure.ac, say
 282
 283   m4_include([subdirmk/subdirmk.ac])
 284   SUBDIRMK_SUBDIRS([...list of subdirectories in relative syntax...])
 285
 286 Write a Subdir.sd.mk in each directory.  The toplevel one should
 287 probably contain:
 288
 289   include subdirmk/usual.mk
 290   include subdirmk/regen.mk
 291
 292 Write a Perdir.sd.mk in the toplevel, if you want.  It should probably
 293 have:
 294
 295   &:include subdirmk/cdeps.sd.mk
 296   &:include subdirmk/clean.sd.mk
 297
 298 Hints
 299 -----
 300
 301 You can convert your project incrementally.  Start with the top-level
 302 Makefile.in and rename it to Subdir.sd.mk, and add the appropriate
 303 stuff to configure.ac, and fix everything up.  Leave the existing
 304 $(MAKE) -C for your existing subdirectories alone.  Then you can
 305 convert individual subdirectories, or classes of subdirectories, at
 306 your leisure.  (You must be /sure/ that each subdirectory will be
 307 entered only once at a time, but your existing recursive make descent
 308 system should already do that or you already have concurrency bugs.)
 309
 310 Aside from this, be very wary of any invocation of $(MAKE) anywhere.
 311 This is a frequent source of concurrency bugs in recursive make build
 312 systems.  When combined with nonrecursive make it's all in the same
 313 directory and there is nothing stopping the different invocations
 314 ending up trying to make the same targets at the same time. That
 315 causes hideous racy lossage.  There are ways to get this to work
 316 reliably but it is advanced stuff.
 317
 318 If you make syntax errors, or certain kinds of other errors, in your
 319 makefiles, you may find that just `make' is broken now and cannot get
 320 far enough to regenerate a working set of makefiles.  If this happens
 321 just rerun ./config.status by hand.
 322
 323
 324 Legal information
 325 -----------------
 326
 327 subdirmk is
 328  Copyright 2019 Mark Wooding
 329  Copyright 2019 Ian Jackson
 330
 331     subdirmk and its example is free software; you can redistribute it
 332     and/or modify it under the terms of the GNU Library General Public
 333     License as published by the Free Software Foundation; either
 334     version 2 of the License, or (at your option) any later version.
 335
 336     This is distributed in the hope that it will be useful, but
 337     WITHOUT ANY WARRANTY; without even the implied warranty of
 338     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 339     Library General Public License for more details.
 340
 341     You should have received a copy of the GNU Library General Public
 342     License along with this library as the file LGPL-2.
 343     If not, see https://www.gnu.org/.
 344
 345 Individual files generally contain the following tag in the copyright
 346 notice, instead of the full licence grant text:
 347   SPDX-License-Identifier: LGPL-2.0-or-later
 348 As is conventional, this should be read as a licence grant.
 349
 350 Contributions are accepted based on the git commit Signed-off-by
 351 convention, by which the contributors' certify their contributions
 352 according to the Developer Certificate of Origin version 1.1 - see
 353 the file DEVELOPER-CERTIFICATE.
 354
 355 Where subdirmk is used by and incorporated into another project (eg
 356 via git subtree), the directory subdirmk/ is under GNU LGPL-2.0+, and
 357 the rest of the project are under that other project's licence(s).
 358 (The project's overall licence must be compatible with LGPL-2.0+.)