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