Relocate comments so that they can be picked up correctly by the doc tools.

3 files changed, 18 insertions, 14 deletions

diff --git a/lib/chef/file_content_management/deploy/cp.rb b/lib/chef/file_content_management/deploy/cp.rb
index 98ee54119c..c6b1d6cd11 100644
--- a/lib/chef/file_content_management/deploy/cp.rb
+++ b/lib/chef/file_content_management/deploy/cp.rb
@@ -26,6 +26,12 @@
 class Chef
   class FileContentManagement
     class Deploy
+      #
+      # PURPOSE: This strategy preserves the inode, and will preserve modes + ownership
+      #          even if the user running chef cannot create that ownership (but has
+      #          rights to the file).  It is vulnerable to crashes in the middle of
+      #          writing the file which could result in corruption or zero-length files.
+      #
       class Cp
         def create(file)
           Chef::Log.debug("touching #{file} to create it")
diff --git a/lib/chef/file_content_management/deploy/mv_unix.rb b/lib/chef/file_content_management/deploy/mv_unix.rb
index 548571eb1b..9baaa9906d 100644
--- a/lib/chef/file_content_management/deploy/mv_unix.rb
+++ b/lib/chef/file_content_management/deploy/mv_unix.rb
@@ -16,17 +16,16 @@
 # limitations under the License.
 #
 
-#
-# PURPOSE: this strategy is atomic, and attempts to preserve file modes
-#
-# NOTE: there is no preserve flag to FileUtils.mv, and we want to preserve the dst file
-#       modes rather than the src file modes (preserve = true is what mv does already, we
-#       would like preserve = false which is tricky).
-#
-
 class Chef
   class FileContentManagement
     class Deploy
+      #
+      # PURPOSE: this strategy is atomic, and attempts to preserve file modes
+      #
+      # NOTE: there is no preserve flag to FileUtils.mv, and we want to preserve the dst file
+      #       modes rather than the src file modes (preserve = true is what mv does already, we
+      #       would like preserve = false which is tricky).
+      #
       class MvUnix
         def create(file)
           # this is very simple, but it ensures that ownership and file modes take
diff --git a/lib/chef/util/selinux.rb b/lib/chef/util/selinux.rb
index c50347006c..bc0942ed82 100644
--- a/lib/chef/util/selinux.rb
+++ b/lib/chef/util/selinux.rb
@@ -22,14 +22,13 @@
 
 require 'chef/mixin/shell_out'
 
-#
-# IMPORTANT: We assume that selinux utilities are installed on an
-# selinux enabled server. Provisioning an selinux enabled server
-# without selinux utilities is not supported.
-#
-
 class Chef
   class Util
+    #
+    # IMPORTANT: We assume that selinux utilities are installed on an
+    # selinux enabled server. Provisioning an selinux enabled server
+    # without selinux utilities is not supported.
+    #
     class Selinux
 
       include Chef::Mixin::ShellOut