From 464a7ec3da81e164fa4159d9288f9ac37bf471fb Mon Sep 17 00:00:00 2001
From: Gregory Lemieux <glemieux@users.noreply.github.com>
Date: Tue, 29 Oct 2024 13:40:23 -0700
Subject: [PATCH] add truncated version of suggested header comments to
 .gitmodules

---
 .gitmodules | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.gitmodules b/.gitmodules
index 63e597cb70..7dc4d3c410 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,3 +1,9 @@
+# This is a git submodule file to include additional submodules when FATES is checkout out.
+#
+# It includes optional additional support for
+# git-fleximod (https://github.com/ESMCI/git-fleximod)
+# that will be used when git-fleximod is used to check it out (i.e. for CESM)
+#
 [submodule "tools/landusedata"]
 	path = tools/landusedata
 	url = https://github.com/NGEET/tools-fates-landusedata