From 84ffa30b0848d7749928c5efe67681dc749447a4 Mon Sep 17 00:00:00 2001
From: aarzilli <alessandro.arzilli@gmail.com>
Date: Tue, 15 Oct 2024 10:33:24 +0200
Subject: [PATCH] addressing review comments

---
 cobra_test.go              | 20 +++++++++++++++++---
 site/content/user_guide.md |  3 ++-
 2 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/cobra_test.go b/cobra_test.go
index 212d09ab7..c86728251 100644
--- a/cobra_test.go
+++ b/cobra_test.go
@@ -227,6 +227,20 @@ func TestRpad(t *testing.T) {
 	}
 }
 
+// TestDeadcodeElimination checks that a simple program using cobra in its
+// default configuration is linked taking full advantage of the linker's
+// deadcode elimination step.
+//
+// If reflect.Value.MethodByName/reflect.Value.Method are reachable the
+// linker will not always be able to prove that exported methods are
+// unreachable, making deadcode elimination less effective. Using
+// text/template and html/template makes reflect.Value.MethodByName
+// reachable.
+// Since cobra can use text/template templates this test checks that in its
+// default configuration that code path can be proven to be unreachable by
+// the linker.
+//
+// See also: https://github.com/spf13/cobra/pull/1956
 func TestDeadcodeElimination(t *testing.T) {
 	// check that a simple program using cobra in its default configuration is
 	// linked with deadcode elimination enabled.
@@ -234,7 +248,8 @@ func TestDeadcodeElimination(t *testing.T) {
 		dirname  = "test_deadcode"
 		progname = "test_deadcode_elimination"
 	)
-	os.Mkdir(dirname, 0770)
+	_ = os.Mkdir(dirname, 0770)
+	defer os.RemoveAll(dirname)
 	filename := filepath.Join(dirname, progname+".go")
 	err := os.WriteFile(filename, []byte(`package main
 
@@ -262,11 +277,10 @@ func main() {
 		os.Exit(1)
 	}
 }
-`), 0660)
+`), 0600)
 	if err != nil {
 		t.Fatalf("could not write test program: %v", err)
 	}
-	defer os.RemoveAll(dirname)
 	buf, err := exec.Command("go", "build", filename).CombinedOutput()
 	if err != nil {
 		t.Fatalf("could not compile test program: %s", string(buf))
diff --git a/site/content/user_guide.md b/site/content/user_guide.md
index dd26de4f8..01cef7c01 100644
--- a/site/content/user_guide.md
+++ b/site/content/user_guide.md
@@ -552,7 +552,8 @@ cmd.SetHelpFunc(f func(*Command, []string))
 cmd.SetHelpTemplate(s string)
 ```
 
-The latter two will also apply to any children commands.
+The latter two will also apply to any children commands. Templates specified with SetHelpTemplate are evaluated using
+`text/template` which can increase the size of the compiled executable.
 
 ## Usage Message