(#2128) In-line docs for node_name_{fact,value}

This change augments the in-line documentation for the node_name_fact and
node_name_value configuration settings.  These settings will not work
effectively without additional changes elsewhere in the system, e.g. to
auth.conf.

In order to help the end user land softly if they choose to change these
settings, a short link URL we control and can redirect has been added
to each setting.  These currently point to the community Wiki but may be
redirected to docs.puppetlabs.com in the future.

1 files changed, 14 insertions, 2 deletions

diff --git a/lib/puppet/defaults.rb b/lib/puppet/defaults.rb
index 4502dae16..fa0736387 100644
--- a/lib/puppet/defaults.rb
+++ b/lib/puppet/defaults.rb
@@ -486,9 +486,21 @@ module Puppet
   )
 
   setdefaults(:agent,
-    :node_name_value => ["$certname", "The name of the node."],
+    :node_name_value => ["$certname", <<-'ENDnodenamevalueDESChereDOC' ],
+      The explicit value used for the node name for all requests the agent makes to
+      the master. This setting is mutually exclusive with node_name_fact. Changing
+      this setting also requires changes to the default auth.conf configuration on
+      the Puppet Master.  Please see http://links.puppetlabs.com/node_name_value for
+      more information.
+      ENDnodenamevalueDESChereDOC
     :node_name_fact => { :default => "",
-        :desc => "The fact to use as the node name.",
+        :desc => <<-'ENDnodenamefactDESChereDOC',
+          The fact name used to determine the node name used for all requests the agent
+          makes to the master. This setting is mutually exclusive with node_name_value.
+          Changing this setting also requires changes to the default auth.conf
+          configuration on the Puppet Master.  Please see
+          http://links.puppetlabs.com/node_name_fact for more information.
+          ENDnodenamefactDESChereDOC
         :hook => proc do |value|
           if !value.empty? and Puppet[:node_name_value] != Puppet[:certname]
             raise "Cannot specify both the node_name_value and node_name_fact settings"