From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Wed, 13 Nov 2019 22:26:50 +0000 (+0000)
Subject: Documentation for regen.mk
X-Git-Tag: v0.5.1~27^2~12
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=secnet.git;a=commitdiff_plain;h=c8c7630c9523d18365953077522995995de0fc58

Documentation for regen.mk

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

diff --git a/subdirmk/regen.mk.in b/subdirmk/regen.mk.in
index a6d9ad2..83952c9 100644
--- a/subdirmk/regen.mk.in
+++ b/subdirmk/regen.mk.in
@@ -3,6 +3,20 @@
 #  Copyright 2019 Ian Jackson
 # SPDX-License-Identifier: LGPL-2.0-or-later
 
+# Usage:
+#   include subdirmk/regen.mk
+# (probably in toplevel Subdir.sd.mk)
+#
+# Arranges that config.status is automatically rerun to update
+# makefiles from templates, whenever a template *.sd.mk or *.mk.in is
+# edited; and that autoconf is rerun if configure's inputs are edited.
+#
+# If you add includes to configure.ac, add them to CONFIGURE_ACS.
+#
+# Also provides a `realclean::' target at the toplevel which deletes
+# the autoconf output.  This may be made into a recursive target
+# by mentioning &TARGETS_realclean in appropriate .sd.mk.
+
 CONFIGURE	?= configure
 CONFIGURE_AC	?= $(CONFIGURE).ac
 CONFIG_STATUS	?= config.status