Merge branch 'ticket/2.6.x/2128_docstrings' into 2.6.x

* ticket/2.6.x/2128_docstrings:
  (#2128) Add WARNING for node_name_{fact,value} descriptions
  (#2128) Whitespace only reflow commit
  (#2128) In-line docs for node_name_{fact,value}

1 files changed, 17 insertions, 7 deletions

diff --git a/lib/puppet/defaults.rb b/lib/puppet/defaults.rb
index 4502dae16..82ff1095f 100644
--- a/lib/puppet/defaults.rb
+++ b/lib/puppet/defaults.rb
@@ -486,15 +486,25 @@ module Puppet
   )
 
   setdefaults(:agent,
-    :node_name_value => ["$certname", "The name of the node."],
+    :node_name_value => { :default => "$certname",
+      :desc => "The explicit value used for the node name for all requests the agent
+        makes to the master. WARNING: 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."
+    },
     :node_name_fact => { :default => "",
-        :desc => "The fact to use as the node name.",
-        :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"
-          end
+      :desc => "The fact name used to determine the node name used for all requests the agent
+        makes to the master. WARNING: 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.",
+      :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"
         end
-      },
+      end
+    },
     :localconfig => { :default => "$statedir/localconfig",
       :owner => "root",
       :mode => 0660,