Re: pod cleanup
authorKen Williams <ken@mathforum.org>
Thu, 21 Aug 2003 21:24:57 +0000 (16:24 -0500)
committerJarkko Hietaniemi <jhi@iki.fi>
Fri, 22 Aug 2003 05:06:58 +0000 (05:06 +0000)
Message-Id: <D2C0AA31-D447-11D7-8495-003065F6D85A@mathforum.org>

p4raw-id: //depot/perl@20815

lib/File/Spec/Cygwin.pm
lib/File/Spec/OS2.pm

index 541bad0..0712add 100644 (file)
@@ -28,6 +28,8 @@ to offer patches and suggestions.
 
 =pod
 
+=over 4
+
 =item canonpath
 
 Any C<\> (backslashes) are converted to C</> (forward slashes),
@@ -78,4 +80,8 @@ sub tmpdir {
     $tmpdir = $self->_tmpdir( $ENV{TMPDIR}, "/tmp", 'C:/temp' );
 }
 
+=back
+
+=cut
+
 1;
index 1ff3278..f03df72 100644 (file)
@@ -34,24 +34,6 @@ sub _cwd {
     return Cwd::sys_cwd();
 }
 
-=pod
-
-=item tmpdir
-
-Returns a string representation of the first existing directory
-from the following list:
-
-    $ENV{TMPDIR}
-    $ENV{TEMP}
-    $ENV{TMP}
-    /tmp
-    /
-
-Since Perl 5.8.0, if running under taint mode, and if the environment
-variables are tainted, they are not used.
-
-=cut
-
 my $tmpdir;
 sub tmpdir {
     return $tmpdir if defined $tmpdir;
@@ -61,13 +43,6 @@ sub tmpdir {
                              '/'  );
 }
 
-=item canonpath
-
-No physical check on the filesystem, but a logical cleanup of a
-path. On UNIX eliminated successive slashes and successive "/.".
-
-=cut
-
 sub canonpath {
     my ($self,$path) = @_;
     $path =~ s/^([a-z]:)/\l$1/s;
@@ -80,24 +55,6 @@ sub canonpath {
     return $path;
 }
 
-=item splitpath
-
-    ($volume,$directories,$file) = File::Spec->splitpath( $path );
-    ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );
-
-Splits a path into volume, directory, and filename portions. Assumes that 
-the last file is a path unless the path ends in '/', '/.', '/..'
-or $no_file is true.  On Win32 this means that $no_file true makes this return 
-( $volume, $path, '' ).
-
-Separators accepted are \ and /.
-
-Volumes can be drive letters or UNC sharenames (\\server\share).
-
-The results can be passed to L</catpath> to get back a path equivalent to
-(usually identical to) the original path.
-
-=cut
 
 sub splitpath {
     my ($self,$path, $nofile) = @_;
@@ -128,42 +85,12 @@ sub splitpath {
 }
 
 
-=item splitdir
-
-The opposite of L<catdir()|File::Spec/catdir()>.
-
-    @dirs = File::Spec->splitdir( $directories );
-
-$directories must be only the directory portion of the path on systems 
-that have the concept of a volume or that have path syntax that differentiates
-files from directories.
-
-Unlike just splitting the directories on the separator, leading empty and 
-trailing directory entries can be returned, because these are significant
-on some OSs. So,
-
-    File::Spec->splitdir( "/a/b//c/" );
-
-Yields:
-
-    ( '', 'a', 'b', '', 'c', '' )
-
-=cut
-
 sub splitdir {
     my ($self,$directories) = @_ ;
     split m|[\\/]|, $directories, -1;
 }
 
 
-=item catpath
-
-Takes volume, directory and file portions and returns an entire path. Under
-Unix, $volume is ignored, and this is just like catfile(). On other OSs,
-the $volume become significant.
-
-=cut
-
 sub catpath {
     my ($self,$volume,$directory,$file) = @_;
 
@@ -303,3 +230,25 @@ File::Spec::OS2 - methods for OS/2 file specs
 
 See L<File::Spec> and L<File::Spec::Unix>.  This package overrides the
 implementation of these methods, not the semantics.
+
+Amongst the changes made for OS/2 are...
+
+=over 4
+
+=item tmpdir
+
+Modifies the list of places temp directory information is looked for.
+
+    $ENV{TMPDIR}
+    $ENV{TEMP}
+    $ENV{TMP}
+    /tmp
+    /
+
+=item splitpath
+
+Volumes can be drive letters or UNC sharenames (\\server\share).
+
+=back
+
+=cut