Merge pull request #9094 from pillarsdotnet/fix-comment-in-find_file-function

cthorn42 · web-flow · commit 2bec39974a6b · 2023-09-21T18:15:41.000-07:00
Correct inaccurate comment in find_file() function.
diff --git a/lib/puppet/parser/files.rb b/lib/puppet/parser/files.rb
@@ -29,9 +29,10 @@ def find_manifests_in_modules(pattern, environment)
   #   * modulename/filename selector: a file is found in the file directory
   #     of the named module.
   #
-  # In the second case a nil is returned if there isn't a file found. In the
-  # first case (absolute path), there is no existence check done and so the
-  # path will be returned even if there isn't a file available.
+  # The check for file existence is performed on the node compiling the
+  # manifest. A node running "puppet apply" compiles its own manifest, but
+  # a node running "puppet agent" depends on the configured puppetserver
+  # for compiling. In either case, a nil is returned if no file is found.
   #
   # @param template [String] the file selector
   # @param environment [Puppet::Node::Environment] the environment in which to search

Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,10 @@ def find_manifests_in_modules(pattern, environment)`
`29`	`29`	`# * modulename/filename selector: a file is found in the file directory`
`30`	`30`	`# of the named module.`
`31`	`31`	`#`
`32`		`- # In the second case a nil is returned if there isn't a file found. In the`
`33`		`- # first case (absolute path), there is no existence check done and so the`
`34`		`- # path will be returned even if there isn't a file available.`
	`32`	`+ # The check for file existence is performed on the node compiling the`
	`33`	`+ # manifest. A node running "puppet apply" compiles its own manifest, but`
	`34`	`+ # a node running "puppet agent" depends on the configured puppetserver`
	`35`	`+ # for compiling. In either case, a nil is returned if no file is found.`
`35`	`36`	`#`
`36`	`37`	`# @param template [String] the file selector`
`37`	`38`	`# @param environment [Puppet::Node::Environment] the environment in which to search`