test/example/check: Make sections appear in stderr output

This makes the output easier to navigate.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests/example/check: Better handling of makefile updates

Rather than checking just for presence of a string in a templated
output file, also have the input file define a target which we try to
run.  This checks that make actually reread the file.

Also add ||false to the grep lines, which makes the stderr output
more obviously contain a failure when the test fails.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests/example: Include non-.sd.mk files in SUBDIRMK_MAKEFILES

subdirmk.ac provides @_SUBDIRMK_MAKEFILES@ which is a list of the
*.mk makefiles (corresponding to *.mk.in makefiles) passed to
SUBDIRMK_MAKEFILES.  These need to be included in the
identically-named make variable for regen.mk to rerun config.status
when the .in files are edited.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests/example: Correct filename for for-test.mk

&^/ means "this source directory" so &^/lib/ in lib/ is nonsense and
produces lib/lib/.  Also we didn't want the source directory:
anyway: config.status produces outputs in the build tree.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

regen.mk.in: Debugging, controlled by SUBDIRMK_REGEN_NDEBUG

And enable this in test/example/check.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests: Test Perdir.sd.mk

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

README: Do not assert that all directive arguments are &-expanded

Since
  Syntax: only some directives' RHS should be &-expanded
this has not been true for &:changequote, and it is not true in
the general case.  It depends on the directive.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

README: Document NEWQUOTE\$ in changequote

This also adds a doctest.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Syntax: Line joining with &\

make has a weird rule for line joining in recipes, where the \ is
retained.  This is very annoying espcially when writing little scripts
in other languages in recipes.  The GNU make documentation suggests
using a `define' block, in which the \ are still necessary, but
vanish.  But that separates out the recipe from the rule, and also
demands that the recipe text be given a name.

(Note that .ONESHELL offers an alternative but sadly is not available
on a per-rule basis.  This is even less sensible with non-recursive
make, where you might want different directories to have different
settings.)

So, provide &\ which does the other thing, swallowing the newline and
discarding the &\, even in rules.

Add a test case too.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests: Test &TARGETS feature

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Syntax: Refine &TARGETS_things, mostly to avoid # wrinkle

We will add a test case in a moment, since it is quite a noisy diff.

We have to upate clean.sd.mk, which uses this feature.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Syntax: only some directives' RHS should be &-expanded

In principle this is an incompatible change but only for strange input
files and only if they use &:changequote.

We need an ad-hoc test for this.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Syntax: Provide &$VARIABLE

Testing is done by the doctests.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

doctests: Test in sub/dir too

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

doctests: Add missing & from include

This makes no difference in this file but we'll want the same in
sub/dir/ and they should be the same.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

doctests: check: Define i and o vars

This makes bash -x debugging easier.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

doctests: Fail on extraction if we don't understand the README

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests/filter/check: Enable pipefail

So we must use bash.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

doctests: Extract and use

Include the doctests from the toplevel Subdir.sd.mk.

In check, extract the doctests, and seddery the expected output into
the combined expected output file.  This involves adding a comment in
Subdir.mk.expected to indicate where the doctests will appear.

In update-expected, contrive to strip the doctest output back out of
the actual output so we can update only the manually-edited part.

Consequential changes to MAKEFILE_TEMPLATES in main.mk.expected
and .gitignore.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

doctests: Fix newline handling in changequote mode section

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

README, doctests: Use NEWQUOTE instead of STUFF

STUFF is rather generic.  Also we want to seddery it in the rubric for
the doctest to avoid it triggering.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

doctests: Provide extract-doctest

This is not called yet.  There are a few things that need fixing
first.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

README: Do not use => inappropriately

Our notation is that => introduces the ouput string.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Syntax: Use &\ for escaping; abolish \&

"\&" causes lots of trouble, including difficulty specifying certain
resulting strings.

Previously I proposed a scheme using &$@ but this is only useful to
provide a way to write &s.

The $-doubling regime which will come later wants a way to produce a
single literal $, so introduce that now using the same syntax.
And &\ feels quite natural to me.

Incompatible change.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Syntax: Introduce &. and friends

Incompatible change.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

generate: Provide $var_prefix_name to process_input_mk

Nothing uses this yet.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Syntax: Introduce &:changequote

Incompatible change.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

generate: Track output Makefiles properly

This fixes a bug where the intermediate directory Makefile was not
included whe it should be.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests/filter: Add .../sub/dir

This will let us test output which depends on the subdirectory,
which is kind of the whole point...

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests: Shuffle, make tests/check run all the tests

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests/filter: New test framework for generate

This test case bypasses autoconf and runs generate directly.
It also gives us somewhere to write examples of each of the
&-expansions without further cluttering test-example.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

generate: Handle nodes with no own Subdir.sd.mk

If a directory is not mentioned on the command line, we would assume
it had a Subdir.sd.mk anyway.  Instead, expect it not to have one.

We do still generate a per-subdirectory fragment for such unmentioned
nodes: this serves to wire its children ino the parent, make running
`make' in that directory possible, etc.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

generate: Add missing final newline to main.mk

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests: Add some section comments.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

example: Add a comment next to for-test bits

This may help unconfuse people using this as an example.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

README: Fix a mistake in the file reference table

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Merge from secnet

&TARGETS*: make autogenerated targets .PHONY

Suggested-by: Mark Wooding <mdw@distorted.org.uk>
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Minor fix to README

Reported-by: Mark Wooding <mdw@distorted.org.uk>
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Minor fixes to regen.mk.in comment

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Suppress MAKEFILE_TEMPLATES when running `make clean'

See the README hunk for the reasoning.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: break out subdirmk_target in generated Makefile

We are going to want to reuse this.  Make it a simply-expanded make
variable rather than a perl variable, so that it only gets computed
once.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: stub Makefiles: filter out `all'

Otherwise `make all' generates this:
  Makefile:3: target 'all' given more than once in the same rule
which is harmless but mildly irritating.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: clean.sd.mk: Delete .*~ too (eg .gitignore~)

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: cdeps.sd.mk: Honour &CDEPS_OBJECTS

This makes this facility more flexible.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Fix bug in regen.mk.in

Apparently, if you just write `;', make knows that the command can't
have done anything.  It therefore concludes tha the target file cannot
have been updated and doesn't bother rereading it.

The result is that you end up using last run's makefiles.

Writing @: fixes this.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Change stub force target to `run-main.mk'

This produces significantly better error messages:
  [some error from actual makefiles]
  make[1]: Leaving directory '/home/ian/wherever'
  Makefile:6: recipe for target 'run-main.mk' failed

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Fix bug when target in subdir exists

If you try to make a file that exists, the % rule doesn't seem to
match.  But providing the dependency for all of $(MAKCMDGOALS)
works.

We have to mention `all' explicitly because it might not appear in
$(MAKECMDGOALS).

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Docs: Fix some leftover ; and ,

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Docs, go back to ^ and ~

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Go back to ^ and ~

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Implement new syntax

But I plan to go back to ^ and ~

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Discuss variable settings and inclusion order

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Actually clear right variable

"subdirmk: main.mk: clear SUBDIRMK_MAKEFILES MAKEFILE_TEMPLATES"
cleared MAKEFILES by mistake (this was a rebase transposition error -
this commit originally came before "subdirmk: Rename MAKEFILES
variable".

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Abolish all absolute pathname syntaxes

These are rare and make things much more confusing.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Improve docs.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Fill in an empty cell with a copy instead

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Transpose columns in path syntax reference

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Change . to require rather than imply @

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Further corresponding new syntax

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: wip new syntax

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Swap rows in syntax table

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: New plan for directory references, further

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: New plan for directory references, new

Not yet implemented.  About to simplify this...

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: New plan for directory references

Not yet implemented.  About to simplify this...

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Summarise directory reference syntaxes, permute

Just permute the columns which seems to be clearer.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

docs: Summarise directory reference syntaxes

This reveals it to be a bit of a mess.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Clarify incremental paragraph

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Clarify race lossage paragraph

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Some hints in docs

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: main.mk: clear SUBDIRMK_MAKEFILES MAKEFILE_TEMPLATES

Otherwise, if we reenter main.mk (for exmaple, there are some reasons
why one might want to $(MAKE) a particular target), and someone
foolishly said `export', we inherit SUBDIRMK_MAKEFILES from our
previous self and end up reading everything twice.  That causes things
not to work very well.

While we're here, clear MAKEFILE_TEMPLATES too.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Rename MAKEFILES variable

This is very magic to make and the behaviour is very undesirable.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Honour CONFIG_STATUS_OUTPUTS

Principally to support autoheader.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

subdirmk: Make \& work (!)

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Two minor docs fixes

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Drop AC_PROG_INSTALL and remove build-aux/install-sh from example

This is just deadweight.  It's rather poor practice too.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

test regeneration after a -included .in file changes

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

test regeneration after a &:-included file (ie a .sd.mk) changes

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Tests: use set -x

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Fix docs typo

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

tests/check: New test script, quite basic

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Transpose directories

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Documentation for regen.mk

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

realclean: Use @_SUBDIRMK_MAKEFILES@

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Drop Perdir.sd.mk from explicit MAKEFILE_TEMPLATES

generate does this itself now.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Documentation for usual.mk.in

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Documentation for clean.sd.mk and cdeps.sd.mk

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Move knowledge of DEPFILES into cdeps.sd.mk

No overall functional change.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Introduce CDEPS_CFLAGS so without cdeps.sd.mk you don't get .*.d

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

New &# feature

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

More docs updates

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Merge branch 'master' of https://git.distorted.org.uk/~markw/subdirmk

subdirmk/*: Some simple whitespace cleanups

Zap trailing whitespace, and spaces-followed-by-tabs.  This commit is
empty in `git show -b'.

Signed-off-by: Mark Wooding <mdw@distorted.org.uk>

subdirmk/generate: Make `FORCE-ALWAYS-RUN' be `.PHONY'

Otherwise `touch FORCE-ALWAYS-RUN' stops your build from working, which
seems a shame, even though nobody should ever want to do this.

Signed-off-by: Mark Wooding <mdw@distorted.org.uk>

subdirmk/usual.mk.in: Fix `VPATH' setting

This file isn't processed through `generate', so `&' doesn't mean
anything special.

Use `$(top_srcdir)' here because we can rely on that being established
by `main.mk'.

Signed-off-by: Mark Wooding <mdw@distorted.org.uk>

subdirmk/regen.mk.in: Trim `$(srcdir)/' prefix from output makefile names

This doesn't make a difference if you're doing in-tree builds, of course.

Signed-off-by: Mark Wooding <mdw@distorted.org.uk>

subdirmk/generate: Supply default target if none given in command line

If you just run `make' then `$(MAKECMDGOALS)' is empty, so we get the
default target of `main.mk'.  Nothing is set up by `usual.mk', so we
end up with `$(srcdir)/configure' established by `regen.mk'.

Instead, propagate `all' to the `main.mk' makefile.  Maybe this should
be configurable, though I don't think that'll be very useful in real
life.

Signed-off-by: Mark Wooding <mdw@distorted.org.uk>

subdirmk/autogen.sh: Remove myself as copyright holder

I had nothing to do with this.  My original proof-of-concept suggested
that developers use `autoreconf' to bootstrap the working tree.

Signed-off-by: Mark Wooding <mdw@distorted.org.uk>

more docs changes

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

more docs fixes

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>