Skip to content

Commit d436f3c

Browse files
committed
[io grant] Document IO::Spec::* don't do any validation
Addresses RT#130900: https://rt.perl.org/Ticket/Display.html?id=130900
1 parent 69b2082 commit d436f3c

File tree

5 files changed

+20
-0
lines changed

5 files changed

+20
-0
lines changed

doc/Type/IO/Spec.pod6

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ B<NOTE:> the C<IO::Spec::*> classes provide low-level path operations. Unless
1818
you're creating your own high-level path manipulation routines, you don't
1919
need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path» instead.
2020
21+
B<NOTE2:> no special validation is done by these classes (e.g. check whether
22+
path contains a NUL byte). It is the job of higher-level classes, like
23+
L«C<IO::Path>|/type/IO::Path», to do that.
24+
2125
=head1 Methods
2226
2327
=end pod

doc/Type/IO/Spec/Cygwin.pod6

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ B<NOTE:> the C<IO::Spec::*> classes provide low-level path operations. Unless
1313
you're creating your own high-level path manipulation routines, you don't
1414
need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path» instead.
1515
16+
B<NOTE2:> no special validation is done by these classes (e.g. check whether
17+
path contains a NUL byte). It is the job of higher-level classes, like
18+
L«C<IO::Path>|/type/IO::Path», to do that.
19+
1620
=head1 Methods
1721
1822
=head2 method abs2rel

doc/Type/IO/Spec/QNX.pod6

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ B<NOTE:> the C<IO::Spec::*> classes provide low-level path operations. Unless
1313
you're creating your own high-level path manipulation routines, you don't
1414
need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path» instead.
1515
16+
B<NOTE2:> no special validation is done by these classes (e.g. check whether
17+
path contains a NUL byte). It is the job of higher-level classes, like
18+
L«C<IO::Path>|/type/IO::Path», to do that.
19+
1620
=head1 Methods
1721
1822
=head2 method canonpath

doc/Type/IO/Spec/Unix.pod6

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ B<NOTE:> the C<IO::Spec::*> classes provide low-level path operations. Unless
1313
you're creating your own high-level path manipulation routines, you don't
1414
need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path» instead.
1515
16+
B<NOTE2:> no special validation is done by these classes (e.g. check whether
17+
path contains a NUL byte). It is the job of higher-level classes, like
18+
L«C<IO::Path>|/type/IO::Path», to do that.
19+
1620
=head1 Methods
1721
1822
=head2 method abs2rel

doc/Type/IO/Spec/Win32.pod6

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ B<NOTE:> the C<IO::Spec::*> classes provide low-level path operations. Unless
1414
you're creating your own high-level path manipulation routines, you don't
1515
need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path» instead..
1616
17+
B<NOTE2:> no special validation is done by these classes (e.g. check whether
18+
path contains a NUL byte). It is the job of higher-level classes, like
19+
L«C<IO::Path>|/type/IO::Path», to do that.
20+
1721
=head1 Methods
1822
1923
=head2 method basename

0 commit comments

Comments
 (0)