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.
  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 Substitution syntax
 142 -------------------
 143
 144 In general & expands to the subdirectory name when used for a
 145 filename, and to the subdirectory name with / replaced with _ for
 146 variable names.
 147
 148 Note that & is processed *even in makefile comments*.  The substitutor
 149 does not understand make syntax, or shell syntax, at all.  However,
 150 the substitution rules are chosen to work well with constructs which
 151 are common in makefiles.
 152
 153 In the notation below, we suppose that the substitution is being in
 154 done in a subdirectory sub/dir of the source tree.  In the RH column
 155 we describe the expansion at the top level, which is often a special
 156 case (in general in variable names we call that TOP rather than the
 157 empty string).
 158
 159 &CAPS           =>      sub_dir_CAPS                    or TOP_CAPS
 160 &lc             =>      sub/dir/lc                      or lc
 161         Here CAPS is any ASCII letter A-Z and lc is a-z.
 162         The assumption is that filenames are usually lowercase and
 163         variables usually uppercase.  Otherwise, use another syntax:
 164
 165 &_              =>      sub_dir_                        or TOP_
 166 &/              =>      sub/dir/                        or nothing
 167 &=_             =>      sub_dir                         or TOP
 168 &=/             =>      sub/dir                         or .
 169 &^              =>      $(top_srcdir)/sub/dir           or $(top_srcdir)
 170 &~              =>      $(abs_top_srcdir)/sub/dir       or $(abs_top_srcdir)
 171
 172 &&              =>      &&              for convenience in shell runes
 173 \&              =>      &               general escaping mechanism
 174
 175 & thing thing... &
 176 & ^ thing thing... &
 177 & ~ thing thing... &
 178         Convenience syntax for prefixing multiple filenames.
 179         Introduced by & followed by lwsp (space or tab).
 180         Each lwsp-separated non-ws word is prefixed by &/ &^/ &~/
 181         respectively.  No other & escapes are recognised.
 182         This processing continues until & preceded by lwsp,
 183         or until EOL (the end of the line), or \ then EOL.
 184
 185 &:<directive> <args>....
 186         recognised at start of line only (possibly after lwsp)
 187         args are processed for &
 188
 189 &:include filename              filename should usually be foo.sd.mk
 190 &:-include filename             tolerate nonexistent file
 191         filenames are relative to $(top_srcdir)
 192
 193 &!<lwsp>        disables & until EOL (and then disappears)
 194
 195 &#      delete everything to end of line
 196         (useful if the RHS contains unrecognise & constructions)
 197
 198 &!STUFF
 199         changes the escape sequence from & to literally STUFF
 200         STUFF may be any series of of non-whitespace characters,
 201         and is terminated by EOL or lwsp.  &!STUFF and the lwsp
 202         are discarded.
 203
 204         After this, write STUFF instead of &, everywhere.
 205         The effect is global and lasts until the next setting.
 206         It takes effect on &:include'd files too, so maybe set
 207         it back before using &:include.
 208
 209         Notably
 210                 STUFFSTUFF      =>      STUFFSTUFF
 211                 \STUFF          =>      STUFF
 212                 STUFF!&         set escape back to &
 213
 214 &TARGETS_things
 215         Handled specially.  If mentioned, declares that this
 216         subdir ought to have a target `things'.  The rule will be
 217                 &/things:: $(&TARGETS_things)
 218
 219         You may extend it by adding more :: rules for the target,
 220         but the preferred style is to do things like this:
 221                 &TARGETS_check += & test-passed.stamp
 222
 223         It is important to mention &TARGETS_things at least once in
 224         the context of each applicable directory, because doing so
 225         arranges that the *parent* will also have a `things' target
 226         which recursively implies this directory's `things'.
 227
 228         Must be spelled exactly &TARGETS_things.  &_TARGETS_things,
 229         for example, is not magic.  But mentioning &TARGETS_things in
 230         a #-comment *does* work because the & filter does not care
 231         about comments.
 232
 233         `all' is extra special: every directory has an `all'
 234         target, which corresponds to &TARGETS.
 235
 236 Subdirectory and variable naming
 237 --------------------------------
 238
 239 The simple variable decoration scheme does not enforce a strict
 240 namespace distinction between parts of variable names which come from
 241 subdirectory names, and parts that mean something else.
 242
 243 So it is a good idea to be a bit careful with your directory naming.
 244 `TOP', names that contain `_', and names that are similar to parts of
 245 make variables (whether conventional ones, or ones used in your
 246 project) are best avoided.
 247
 248 If you name your variables in ALL CAPS and your subdirectories in
 249 lower case with `-' rather than `_', there will be no confusion.
 250
 251 Incorporating this into your project
 252 ------------------------------------
 253
 254 Use `git-subtree' to merge the subdirmk/ directory.  You may find it
 255 useful to symlink the DEVELOPER-CERTIFICATE file (git can store
 256 symlinks as symlinks - just `git add' the link).  And you probably
 257 want to mention the situation in your top-level COPYING.
 258
 259 Symlink autogen.sh into your project toplevel.
 260
 261 In your configure.ac, say
 262
 263   m4_include([subdirmk/subdirmk.ac])
 264   SUBDIRMK_SUBDIRS([...list of subdirectories in relative syntax...])
 265
 266 Write a Subdir.sd.mk in each directory.  The toplevel one should
 267 probably contain:
 268
 269   include subdirmk/usual.mk
 270   include subdirmk/regen.mk
 271
 272 Write a Perdir.sd.mk in the toplevel, if you want.  It should probably
 273 have:
 274
 275   &:include subdirmk/cdeps.sd.mk
 276   &:include subdirmk/clean.sd.mk
 277
 278
 279 Legal information
 280 -----------------
 281
 282 subdirmk is
 283  Copyright 2019 Mark Wooding
 284  Copyright 2019 Ian Jackson
 285
 286     subdirmk and its example is free software; you can redistribute it
 287     and/or modify it under the terms of the GNU Library General Public
 288     License as published by the Free Software Foundation; either
 289     version 2 of the License, or (at your option) any later version.
 290
 291     This is distributed in the hope that it will be useful, but
 292     WITHOUT ANY WARRANTY; without even the implied warranty of
 293     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 294     Library General Public License for more details.
 295
 296     You should have received a copy of the GNU Library General Public
 297     License along with this library as the file LGPL-2.
 298     If not, see https://www.gnu.org/.
 299
 300 Individual files generally contain the following tag in the copyright
 301 notice, instead of the full licence grant text:
 302   SPDX-License-Identifier: LGPL-2.0-or-later
 303 As is conventional, this should be read as a licence grant.
 304
 305 Contributions are accepted based on the git commit Signed-off-by
 306 convention, by which the contributors' certify their contributions
 307 according to the Developer Certificate of Origin version 1.1 - see
 308 the file DEVELOPER-CERTIFICATE.
 309
 310 Where subdirmk is used by and incorporated into another project (eg
 311 via git subtree), the directory subdirmk/ is under GNU LGPL-2.0+, and
 312 the rest of the project are under that other project's licence(s).
 313 (The project's overall licence must be compatible with LGPL-2.0+.)