From faba109d49fe172979b3b38b0956eeb115fe35f6 Mon Sep 17 00:00:00 2001
From: "Karl O. Pinc" <kop@karlpinc.com>
Date: Sat, 3 Jun 2023 18:14:59 -0500
Subject: [PATCH] Document how to use help.mk

---
 make_files/help.mk | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/make_files/help.mk b/make_files/help.mk
index 9893c10..98ff3a2 100644
--- a/make_files/help.mk
+++ b/make_files/help.mk
@@ -16,6 +16,10 @@
 
 # Use this by putting the following line into your Makefile:
 # include help.mk
+#
+# Then, any lines in the makefiles that begin with "## " are displayed
+# as help text.  This allows user-documentation to be placed next to
+# relevant makefile targets and rules.
 
 help:
 	@grep -Eh '^##($$| )' $(MAKEFILE_LIST) | sed -E 's/^##($$| )//'
-- 
2.34.1