From 9fa15d9a7e84b93c5763b0209eee7e3d572d72e0 Mon Sep 17 00:00:00 2001
From: carygravel <4869402+carygravel@users.noreply.github.com>
Date: Sun, 11 Aug 2024 19:53:20 +0000
Subject: [PATCH] cli/checkconfig: document limitations (#15348)

---
 cmd/check_config.go | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/cmd/check_config.go b/cmd/check_config.go
index 6ba015ad1..088ae2464 100644
--- a/cmd/check_config.go
+++ b/cmd/check_config.go
@@ -11,7 +11,10 @@ import (
 var checkconfig = &cobra.Command{
 	Use:   "checkconfig",
 	Short: "Check config file for errors",
-	Run:   runConfigCheck,
+	Long: `Check the (specified or default) config file for errors. Note that
+	       checkconfig only checks the config file for parsing errors and does
+		   not check that individual device configurations are valid.`,
+	Run: runConfigCheck,
 }
 
 func init() {