From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Wed, 13 Nov 2019 22:14:48 +0000 (+0000)
Subject: Documentation for usual.mk.in
X-Git-Tag: subdirmk/0.1~42
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=subdirmk.git;a=commitdiff_plain;h=9a241607f82ecdc7930a050051a1fce4009e9666

Documentation for usual.mk.in

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

diff --git a/subdirmk/usual.mk.in b/subdirmk/usual.mk.in
index c40a18f..66c71eb 100644
--- a/subdirmk/usual.mk.in
+++ b/subdirmk/usual.mk.in
@@ -3,6 +3,13 @@
 #  Copyright 2019 Ian Jackson
 # SPDX-License-Identifier: LGPL-2.0-or-later
 
+# Usage:
+#   include subdirmk/usual.mk
+# (probably in toplevel Subdir.sd.mk)
+#
+# Provides various conventional `make' variables, and a
+# rule for compiling C programs.
+
 VPATH		= $(top_srcdir)
 
 prefix		= @prefix@