[DOC PATCH] pod syntax fixups for File::Spec::* modules

Message-ID: <20011013231555.A18071@rafael>

p4raw-id: //depot/perl@12428

diff --git a/lib/File/Spec.pm b/lib/File/Spec.pm
index 023005f..e0a7391 100644 (file)
--- a/lib/File/Spec.pm
+++ b/lib/File/Spec.pm
@@ -75,14 +75,14 @@ forms of these methods.
 
 =over 2
 
-=item canonpath
+=item canonpath()
 
 No physical check on the filesystem, but a logical cleanup of a
 path.
 
     $cpath = File::Spec->canonpath( $path ) ;
 
-=item catdir
+=item catdir()
 
 Concatenate two or more directory names to form a complete path ending
 with a directory. But remove the trailing slash from the resulting
@@ -200,7 +200,7 @@ Unlike just splitting the directories on the separator, empty
 directory names (C<''>) can be returned, because these are significant
 on some OSs (e.g. MacOS).
 
-=item catpath
+=item catpath()
 
 Takes volume, directory and file portions and returns an entire path. Under
 Unix, $volume is ignored, and directory and file are catenated.  A '/' is
@@ -216,9 +216,9 @@ from the base path to the destination path:
     $rel_path = File::Spec->abs2rel( $path ) ;
     $rel_path = File::Spec->abs2rel( $path, $base ) ;
 
-If $base is not present or '', then L<cwd()> is used. If $base is relative, 
+If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative, 
 then it is converted to absolute form using L</rel2abs()>. This means that it
-is taken to be relative to L<cwd()>.
+is taken to be relative to L<cwd()|Cwd>.
 
 On systems with the concept of a volume, this assumes that both paths 
 are on the $destination volume, and ignores the $base volume. 
@@ -228,7 +228,7 @@ $base filename as well. Otherwise all path components are assumed to be
 directories.
 
 If $path is relative, it is converted to absolute form using L</rel2abs()>.
-This means that it is taken to be relative to L<cwd()>.
+This means that it is taken to be relative to L<cwd()|Cwd>.
 
 No checks against the filesystem are made on most systems.  On MacOS,
 the filesystem may be consulted (see
@@ -238,16 +238,16 @@ macros are expanded.
 
 Based on code written by Shigio Yamaguchi.
 
-=item rel2abs
+=item rel2abs()
 
 Converts a relative path to an absolute path. 
 
     $abs_path = File::Spec->rel2abs( $path ) ;
     $abs_path = File::Spec->rel2abs( $path, $base ) ;
 
-If $base is not present or '', then L<cwd()> is used. If $base is relative, 
+If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative, 
 then it is converted to absolute form using L</rel2abs()>. This means that it
-is taken to be relative to L<cwd()>.
+is taken to be relative to L<cwd()|Cwd>.
 
 On systems with the concept of a volume, this assumes that both paths 
 are on the $base volume, and ignores the $path volume. 

diff --git a/lib/File/Spec/Epoc.pm b/lib/File/Spec/Epoc.pm
index 23c99fb..036bcca 100644 (file)
--- a/lib/File/Spec/Epoc.pm
+++ b/lib/File/Spec/Epoc.pm
@@ -67,7 +67,7 @@ sub path {
     return undef;
 }
 
-=item canonpath
+=item canonpath()
 
 No physical check on the filesystem, but a logical cleanup of a
 path. On UNIX eliminated successive slashes and successive "/.".
@@ -134,7 +134,7 @@ sub splitpath {
 
 =item splitdir
 
-The opposite of L</catdir()>.
+The opposite of L<catdir()|File::Spec/catdir()>.
 
     @dirs = File::Spec->splitdir( $directories );
 
@@ -221,9 +221,9 @@ from the base path to the destination path:
     $rel_path = File::Spec->abs2rel( $destination ) ;
     $rel_path = File::Spec->abs2rel( $destination, $base ) ;
 
-If $base is not present or '', then L</cwd()> is used. If $base is relative, 
+If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative, 
 then it is converted to absolute form using L</rel2abs()>. This means that it
-is taken to be relative to L<cwd()>.
+is taken to be relative to L<cwd()|Cwd>.
 
 On systems with the concept of a volume, this assumes that both paths 
 are on the $destination volume, and ignores the $base volume.
@@ -233,7 +233,7 @@ $base filename as well. Otherwise all path components are assumed to be
 directories.
 
 If $path is relative, it is converted to absolute form using L</rel2abs()>.
-This means that it is taken to be relative to L</cwd()>.
+This means that it is taken to be relative to L<cwd()|Cwd>.
 
 Based on code written by Shigio Yamaguchi.
 
@@ -311,16 +311,16 @@ sub abs2rel {
     ) ;
 }
 
-=item rel2abs
+=item rel2abs()
 
 Converts a relative path to an absolute path. 
 
     $abs_path = File::Spec->rel2abs( $destination ) ;
     $abs_path = File::Spec->rel2abs( $destination, $base ) ;
 
-If $base is not present or '', then L<cwd()> is used. If $base is relative, 
+If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative, 
 then it is converted to absolute form using L</rel2abs()>. This means that it
-is taken to be relative to L</cwd()>.
+is taken to be relative to L<cwd()|Cwd>.
 
 Assumes that both paths are on the $base volume, and ignores the 
 $destination volume. 

diff --git a/lib/File/Spec/Mac.pm b/lib/File/Spec/Mac.pm
index 6b62747..ebddd71 100644 (file)
--- a/lib/File/Spec/Mac.pm
+++ b/lib/File/Spec/Mac.pm
@@ -37,7 +37,7 @@ sub canonpath {
     return $path;
 }
 
-=item catdir
+=item catdir()
 
 Concatenate two or more directory names to form a path separated by colons
 (":") ending with a directory.  Automatically puts a trailing ":" on the
@@ -401,7 +401,7 @@ sub splitdir {
 }
 
 
-=item catpath
+=item catpath()
 
     $path = File::Spec->catpath($volume,$directory,$file);
 

diff --git a/lib/File/Spec/Unix.pm b/lib/File/Spec/Unix.pm
index 6d26660..01d5f48 100644 (file)
--- a/lib/File/Spec/Unix.pm
+++ b/lib/File/Spec/Unix.pm
@@ -25,7 +25,7 @@ override specific methods.
 
 =over 2
 
-=item canonpath
+=item canonpath()
 
 No physical check on the filesystem, but a logical cleanup of a
 path. On UNIX eliminates successive slashes and successive "/.".
@@ -50,7 +50,7 @@ sub canonpath {
     return "$node$path";
 }
 
-=item catdir
+=item catdir()
 
 Concatenate two or more directory names to form a complete path ending
 with a directory. But remove the trailing slash from the resulting
@@ -294,7 +294,7 @@ sub splitdir {
 }
 
 
-=item catpath
+=item catpath()
 
 Takes volume, directory and file portions and returns an entire path. Under
 Unix, $volume is ignored, and directory and file are catenated.  A '/' is
@@ -327,9 +327,9 @@ from the base path to the destination path:
     $rel_path = File::Spec->abs2rel( $path ) ;
     $rel_path = File::Spec->abs2rel( $path, $base ) ;
 
-If $base is not present or '', then L<cwd()> is used. If $base is relative, 
+If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative, 
 then it is converted to absolute form using L</rel2abs()>. This means that it
-is taken to be relative to L<cwd()>.
+is taken to be relative to L<cwd()|Cwd>.
 
 On systems with the concept of a volume, this assumes that both paths 
 are on the $destination volume, and ignores the $base volume. 
@@ -339,7 +339,7 @@ $base filename as well. Otherwise all path components are assumed to be
 directories.
 
 If $path is relative, it is converted to absolute form using L</rel2abs()>.
-This means that it is taken to be relative to L<cwd()>.
+This means that it is taken to be relative to L<cwd()|Cwd>.
 
 No checks against the filesystem are made on most systems.  On MacOS,
 the filesystem may be consulted (see
@@ -401,16 +401,16 @@ sub abs2rel {
     return $self->canonpath( $path ) ;
 }
 
-=item rel2abs
+=item rel2abs()
 
 Converts a relative path to an absolute path. 
 
     $abs_path = File::Spec->rel2abs( $path ) ;
     $abs_path = File::Spec->rel2abs( $path, $base ) ;
 
-If $base is not present or '', then L<cwd()> is used. If $base is relative, 
+If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative, 
 then it is converted to absolute form using L</rel2abs()>. This means that it
-is taken to be relative to L<cwd()>.
+is taken to be relative to L<cwd()|Cwd>.
 
 On systems with the concept of a volume, this assumes that both paths 
 are on the $base volume, and ignores the $path volume. 

diff --git a/lib/File/Spec/Win32.pm b/lib/File/Spec/Win32.pm
index 7ee10a1..4b10a7f 100644 (file)
--- a/lib/File/Spec/Win32.pm
+++ b/lib/File/Spec/Win32.pm
@@ -163,7 +163,7 @@ sub splitpath {
 
 =item splitdir
 
-The opposite of L</catdir()>.
+The opposite of L<catdir()|File::Spec/catdir()>.
 
     @dirs = File::Spec->splitdir( $directories );