svn commit: r1614484 - /vcl/trunk/managementnode/lib/VCL/Module/OS/Windows.pm

[ar...@apache.org]

Author: arkurth
Date: Tue Jul 29 20:55:07 2014
New Revision: 1614484

URL: http://svn.apache.org/r1614484
Log:
VCL-770
Added pod comments for previous commit.

Modified:
    vcl/trunk/managementnode/lib/VCL/Module/OS/Windows.pm

Modified: vcl/trunk/managementnode/lib/VCL/Module/OS/Windows.pm
URL: http://svn.apache.org/viewvc/vcl/trunk/managementnode/lib/VCL/Module/OS/Windows.pm?rev=1614484&r1=1614483&r2=1614484&view=diff
==============================================================================
--- vcl/trunk/managementnode/lib/VCL/Module/OS/Windows.pm (original)
+++ vcl/trunk/managementnode/lib/VCL/Module/OS/Windows.pm Tue Jul 29 20:55:07 2014
@@ -6521,9 +6521,16 @@ sub run_gpupdate {
 
 =head2 fix_cygwin_nodosfilewarning
 
- Parameters  : 
- Returns     :
- Description : 
+ Parameters  : none
+ Returns     : boolean
+ Description : Cygwin will include a warning message in the output of a command
+               such as sed.exe or grep.exe which uses a DOS-style file path.
+               This warning is only displayed the first time this is
+               encountered, and not for subsequent commands. The extra warning
+               output can cause problems for other subroutines which parse the
+               output. This subroutine intentionally attempts to trigger the
+               warning so that it does not appear in the output for other
+               subroutines.
 
 =cut