excise crlf from the codebase

Author: natefinch

mage/main.go

@@ -113,7 +113,7 @@ type Invocation struct {
 	GoCmd      string        // the go binary command to run
 	CacheDir   string        // the directory where we should store compiled binaries
 	HashFast   bool          // don't rely on GOCACHE, just hash the magefiles
-	Multiline  bool          // whether to retain CRLF line endings in comments for the generated main file
+	Multiline  bool          // whether to retain line returns in help text for the generated main file
 }
 
 // MagefilesDirName is the name of the default folder to look for if no directory was specified,
@@ -209,7 +209,7 @@ func Parse(stderr, stdout io.Writer, args []string) (inv Invocation, cmd Command
 	fs.BoolVar(&inv.Force, "f", false, "force recreation of compiled magefile")
 	fs.BoolVar(&inv.Debug, "debug", mg.Debug(), "turn on debug messages")
 	fs.BoolVar(&inv.Verbose, "v", mg.Verbose(), "show verbose output when running mage targets")
-	fs.BoolVar(&inv.Multiline, "multiline", mg.Multiline(), "retain CRLF line endings in descriptions")
+	fs.BoolVar(&inv.Multiline, "multiline", mg.Multiline(), "retain line returns in help text")
 	fs.BoolVar(&inv.Help, "h", false, "show this help")
 	fs.DurationVar(&inv.Timeout, "t", 0, "timeout in duration parsable format (e.g. 5m30s)")
 	fs.BoolVar(&inv.Keep, "keep", false, "keep intermediate mage files around after running")

mage/main_test.go

@@ -616,17 +616,17 @@ func TestMultiline(t *testing.T) {
 			name: "list",
 			args: []string{"-d", "testdata/multiline", "-l"},
 			// line returns at the end here are important to show that we don't add an extra line return.
-			output: "This is a global comment for the mage output.\nIt should be retained with CRLF.\n\nTargets:",
+			output: "This is a global comment for the mage output.\nIt should retain line returns.\n\nTargets:",
 		},
 		{
 			name:   "help-func",
 			args:   []string{"-d", "testdata/multiline", "-h", "doit"},
-			output: "DoIt is a dummy function with a crlf comment.\nThat should show up with multiple lines.\n\nUsage:",
+			output: "DoIt is a dummy function with a multiline comment.\nThat should show up with multiple lines.\n\nUsage:",
 		},
 		{
 			name:   "help-func",
 			args:   []string{"-d", "testdata/multiline", "-h", "sub:doittoo"},
-			output: "DoItToo is a dummy function with a crlf comment.\nHere's the second line.\n\nUsage:",
+			output: "DoItToo is a dummy function with a multiline comment.\nHere's the second line.\n\nUsage:",
 		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
@@ -656,17 +656,17 @@ func TestMultilineTag(t *testing.T) {
 			name: "list",
 			args: []string{"-d", "testdata/multiline/tag", "-l"},
 			// line returns at the end here are important to show that we don't add an extra line return.
-			output: "This is a global comment for the mage output.\nIt should be retained with CRLF.\n\nTargets:",
+			output: "This is a global comment for the mage output.\nIt should retain line returns.\n\nTargets:",
 		},
 		{
 			name:   "help-func",
 			args:   []string{"-d", "testdata/multiline/tag", "-h", "doit"},
-			output: "DoIt is a dummy function with a crlf comment.\nThat should show up with multiple lines.\n\nUsage:",
+			output: "DoIt is a dummy function with a multiline comment.\nThat should show up with multiple lines.\n\nUsage:",
 		},
 		{
 			name:   "help-func",
 			args:   []string{"-d", "testdata/multiline/tag", "-h", "sub:doittoo"},
-			output: "DoItToo is a dummy function with a crlf comment.\nHere's the second line.\n\nUsage:",
+			output: "DoItToo is a dummy function with a multiline comment.\nHere's the second line.\n\nUsage:",
 		},
 	} {
 		// The tests should be the same regardless of the environment variable, because the tag should override.

mage/testdata/multiline/magefile.go

@@ -1,21 +1,21 @@
 //go:build mage
 
 // This is a global comment for the mage output.
-// It should be retained with CRLF.
+// It should retain line returns.
 package main
 
 import "github.com/magefile/mage/mg"
 
-// DoIt is a dummy function with a crlf comment.
+// DoIt is a dummy function with a multiline comment.
 // That should show up with multiple lines.
 func DoIt() {
 }
 
 // Sub is a namespace.
-// It also has a crlf.
+// It also has a line return.
 type Sub mg.Namespace
 
-// DoItToo is a dummy function with a crlf comment.
+// DoItToo is a dummy function with a multiline comment.
 // Here's the second line.
 func (Sub) DoItToo() {
 }

mage/testdata/multiline/tag/magefile.go

@@ -1,23 +1,23 @@
 //go:build mage
 
 // This is a global comment for the mage output.
-// It should be retained with CRLF.
+// It should retain line returns.
 package main
 
 //mage:multiline // Enable multiline description output.
 
 import "github.com/magefile/mage/mg"
 
-// DoIt is a dummy function with a crlf comment.
+// DoIt is a dummy function with a multiline comment.
 // That should show up with multiple lines.
 func DoIt() {
 }
 
 // Sub is a namespace.
-// It also has a crlf.
+// It also has a line return.
 type Sub mg.Namespace
 
-// DoItToo is a dummy function with a crlf comment.
+// DoItToo is a dummy function with a multiline comment.
 // Here's the second line.
 func (Sub) DoItToo() {
 }

mg/runtime.go

@@ -99,8 +99,8 @@ func HashFast() bool {
 	return b
 }
 
-// Multiline reports whether the user has requested to retain CRLF line endings
-// in comments for the generated main file.
+// Multiline reports whether the user has requested to retain line returns
+// in help text for the generated main file.
 func Multiline() bool {
 	b, _ := strconv.ParseBool(os.Getenv(MultilineEnv))
 	return b