X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ian/git?p=subdirmk.git;a=blobdiff_plain;f=subdirmk%2Fclean.sd.mk;h=08f8dcc61e5cd584618e97a8d81b696f0dfd50ca;hp=e235fcd8e251bbf8a45b9ac073b3e1415ccd0b91;hb=41682cf1c6108dce44a3e7a57eaacec0c0b058bd;hpb=a2d0da0b0b2f40319d8787b98f5198f78303f85d

diff --git a/subdirmk/clean.sd.mk b/subdirmk/clean.sd.mk
index e235fcd..08f8dcc 100644
--- a/subdirmk/clean.sd.mk
+++ b/subdirmk/clean.sd.mk
@@ -3,6 +3,18 @@
 #  Copyright 2019 Ian Jackson
 # SPDX-License-Identifier: LGPL-2.0-or-later
 
+&# Usage:
+&#   &:include subdirmk/clean.sd.mk
+&# (probably in Perdir.sd.mk)
+&#
+&# Provides a per-directory `clean' target, which deletes all the files
+&# in &CLEAN.  &OBJECTS, &DEPFILES and &TARGETS are automatically deleted.
+&#
+&# If you want to delete a directory, extend the target with
+&#   &/clean::
+&#	$(RM) -r somethingn
+&# ($(RM) conventionally contains `-f'.)
+
 &CLEAN += & *~ *.tmp
 &CLEAN += $(&OBJECTS)
 &CLEAN += $(&TARGETS)