Add a note on help output of how to unset configs

2021-08-20 19:44:44 -07:00
parent 73ed7d1891
commit 4d37c87c7b
2 changed files with 9 additions and 7 deletions
--- a/internal/app/wwctl/profile/set/root.go
+++ b/internal/app/wwctl/profile/set/root.go
@@ -6,9 +6,10 @@ var (
 	baseCmd = &cobra.Command{
 		Use:   "set [flags] <profile pattern>...",
 		Short: "Configure node profile properties",
-		Long:  "This command will allow you to set configuration properties for node profiles.",
-		Args:  cobra.MinimumNArgs(1),
-		RunE:  CobraRunE,
+		Long: "This command will allow you to set configuration properties for node profiles.\n\n" +
+			"Note: use the string 'UNSET' to remove a configuration",
+		Args: cobra.MinimumNArgs(1),
+		RunE: CobraRunE,
 	}
 	SetAll            bool
 	SetYes            bool