Perl / perl5

🐪 The Perl programming language
https://dev.perl.org/perl5/
Other
1.98k stars 559 forks source link

pod: fix some typos #16510

Closed p5pRT closed 6 years ago

p5pRT commented 6 years ago

Migrated from rt.perl.org#133120 (status was 'resolved')

Searchable as RT133120$

p5pRT commented 6 years ago

From alexandr.savca89@gmail.com

Fix some typos in pod files. Patch for blead branch.

Regards\,

p5pRT commented 6 years ago

From alexandr.savca89@gmail.com

0001-pod-some-typo-fixes.patch ```diff From 5a948a3754b2f5a5a20be576ed0042a53e07c0a9 Mon Sep 17 00:00:00 2001 From: chinarulezzz Date: Wed, 18 Apr 2018 03:51:57 +0300 Subject: [PATCH] pod: some typo fixes --- pod/perlartistic.pod | 2 +- pod/perldiag.pod | 4 ++-- pod/perlfunc.pod | 2 +- pod/perlport.pod | 4 ++-- pod/perlre.pod | 2 +- pod/perlrebackslash.pod | 2 +- pod/perlrecharclass.pod | 2 +- pod/perlref.pod | 2 +- pod/perlsec.pod | 4 ++-- pod/perlsyn.pod | 2 +- pod/perlunicode.pod | 4 ++-- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/pod/perlartistic.pod b/pod/perlartistic.pod index 63813ff4fb..65565018ad 100644 --- a/pod/perlartistic.pod +++ b/pod/perlartistic.pod @@ -213,7 +213,7 @@ products derived from this software without specific prior written permission. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED -WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. =back diff --git a/pod/perldiag.pod b/pod/perldiag.pod index ce8ea11f2b..c66e372875 100644 --- a/pod/perldiag.pod +++ b/pod/perldiag.pod @@ -3899,7 +3899,7 @@ See L. (F) Transliteration (C and C) transliterates individual characters. But a named sequence by definition is more than an -individual charater, and hence doing this operation on it doesn't make +individual character, and hence doing this operation on it doesn't make sense. =item "my sub" not yet implemented @@ -4273,7 +4273,7 @@ find out what kind of ref it really was. See L. =item '#' not allowed immediately following a sigil in a subroutine signature (F) In a subroutine signature definition, a comment following a sigil -(C<$>, C<@> or C<%>), needs to be separated by whitespace or a commma etc., in +(C<$>, C<@> or C<%>), needs to be separated by whitespace or a comma etc., in particular to avoid confusion with the C<$#> variable. For example: # bad diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod index d505bc281a..2765a3603b 100644 --- a/pod/perlfunc.pod +++ b/pod/perlfunc.pod @@ -9394,7 +9394,7 @@ want a version of Perl older than the specified one. Specifying VERSION as a numeric argument of the form 5.024001 should generally be avoided as older less readable syntax compared to v5.24.1. Before perl 5.8.0 released in 2002 the more verbose numeric -orm was the only supported syntax, which is why you might see it in +form was the only supported syntax, which is why you might see it in use v5.24.1; # compile time version check use 5.24.1; # ditto diff --git a/pod/perlport.pod b/pod/perlport.pod index 45158d58d6..5ad2ffc3e6 100644 --- a/pod/perlport.pod +++ b/pod/perlport.pod @@ -436,7 +436,7 @@ too). The portable idiom to remove all the versions of a file is 1 while unlink "file"; -This will terminate if the file is undeleteable for some reason +This will terminate if the file is undeletable for some reason (protected, not there, and so on). Don't count on a specific environment variable existing in @@ -1362,7 +1362,7 @@ where Directory and File =~ m|[^\0- "\.\$\%\&:\@\\^\|\177]+| The default filename translation is roughly C, swapping dots -and slahes. +and slashes. Note that C<"ADFS::HardDisk.$.File" ne 'ADFS::HardDisk.$.File'> and that the second stage of C<$> interpolation in regular expressions will fall diff --git a/pod/perlre.pod b/pod/perlre.pod index 0c6ef15e9d..70c53f1536 100644 --- a/pod/perlre.pod +++ b/pod/perlre.pod @@ -192,7 +192,7 @@ want in the set. You do this by enclosing the list within C<[]> bracket characters. These are called "bracketed character classes" when we are being precise, but often the word "bracketed" is dropped. (Dropping it usually doesn't cause confusion.) This means that the C<"["> character -is another metacharacter. It doesn't match anything just by itelf; it +is another metacharacter. It doesn't match anything just by itself; it is used only to tell Perl that what follows it is a bracketed character class. If you want to match a literal left square bracket, you must escape it, like C<"\[">. The matching C<"]"> is also a metacharacter; diff --git a/pod/perlrebackslash.pod b/pod/perlrebackslash.pod index 4a1c546f74..01226e6a6e 100644 --- a/pod/perlrebackslash.pod +++ b/pod/perlrebackslash.pod @@ -596,7 +596,7 @@ sentence boundary. C<\b{sb}> works with text designed for word-processors which wrap lines automatically for display, but hard-coded line boundaries are considered to be essentially the ends of text blocks (paragraphs really), and hence -the ends of sententces. C<\b{sb}> doesn't do well with text containing +the ends of sentences. C<\b{sb}> doesn't do well with text containing embedded newlines, like the source text of the document you are reading. Such text needs to be preprocessed to get rid of the line separators before looking for sentence boundaries. Some people view this as a bug diff --git a/pod/perlrecharclass.pod b/pod/perlrecharclass.pod index 8c008507d1..3b5c5b12b1 100644 --- a/pod/perlrecharclass.pod +++ b/pod/perlrecharclass.pod @@ -641,7 +641,7 @@ Examples: # even on an EBCDIC platform. [\N{U+27}-\N{U+3F}] # Same. (U+27 is "'", and U+3F is "?") -As the final two examples above show, you can achieve portablity to +As the final two examples above show, you can achieve portability to non-ASCII platforms by using the C<\N{...}> form for the range endpoints. These indicate that the specified range is to be interpreted using Unicode values, so C<[\N{U+27}-\N{U+3F}]> means to match diff --git a/pod/perlref.pod b/pod/perlref.pod index fa9e033aee..cf3692212d 100644 --- a/pod/perlref.pod +++ b/pod/perlref.pod @@ -868,7 +868,7 @@ Combining that form with C and putting parentheses immediately around a hash are forbidden (because it is not clear what they should do): \local(@array) = foo(); # WRONG - \(%hash) = bar(); # wRONG + \(%hash) = bar(); # WRONG Assignment to references and non-references may be combined in lists and conditional ternary expressions, as long as the values on the right-hand diff --git a/pod/perlsec.pod b/pod/perlsec.pod index bf1c9b4974..b210445685 100644 --- a/pod/perlsec.pod +++ b/pod/perlsec.pod @@ -380,7 +380,7 @@ see which interpreter to run and when the (now-set-id) interpreter turns around and reopens the file to interpret it, the file in question may have changed, especially if you have symbolic links on your system. -Some Unices, especially more recent ones, are free of this +Some Unixes, especially more recent ones, are free of this inherent security bug. On such systems, when the kernel passes the name of the set-id script to open to the interpreter, rather than using a pathname subject to meddling, it instead passes I. This is a @@ -430,7 +430,7 @@ in C: Compile this wrapper into a binary executable and then make I rather than your script setuid or setgid. Note that this wrapper isn't doing -anything to santitise the execution environment other than ensuring +anything to sanitise the execution environment other than ensuring that a safe path to the script is used. It only avoids the shebang race condition. It relies on Perl's own features, and on the script itself being careful, to make it safe enough to run the script set-id. diff --git a/pod/perlsyn.pod b/pod/perlsyn.pod index 74e228d5d8..d63108f275 100644 --- a/pod/perlsyn.pod +++ b/pod/perlsyn.pod @@ -992,7 +992,7 @@ the form C, C<$foo !~ /REGEX/>, or C<$foo !~ EXPR>. A smart match that uses an explicit C<~~> operator, such as C. B You will often have to use C<$c ~~ $_> because the default case -uses C<$_ ~~ $c> , which is frequentlythe opposite of what you want. +uses C<$_ ~~ $c> , which is frequently the opposite of what you want. =item Z<>4. diff --git a/pod/perlunicode.pod b/pod/perlunicode.pod index 7515b1532c..9c9111dce0 100644 --- a/pod/perlunicode.pod +++ b/pod/perlunicode.pod @@ -394,7 +394,7 @@ other. You may be presented with strings in any of these equivalent forms. There is currently nothing in Perl 5 that ignores the differences. So -you'll have to specially hanlde it. The usual advice is to convert your +you'll have to specially handle it. The usual advice is to convert your inputs to C before processing further. For more detailed information, see L. @@ -1679,7 +1679,7 @@ See L. Because UTF-EBCDIC is so similar to UTF-8, the differences are mostly hidden from you; S> (and NOT something like -S>) declares the the script is in the platform's +S>) declares the script is in the platform's "native" 8-bit encoding of Unicode. (Similarly for the C<":utf8"> layer.) -- 2.15.1 ```
p5pRT commented 6 years ago

From @jkeenan

On Wed\, 18 Apr 2018 01​:21​:29 GMT\, alexandr.savca89@​gmail.com wrote​:

Fix some typos in pod files. Patch for blead branch.

Regards\,

With one exception\, I have applied these corrections to the jkeenan/133120-pod branch.

1.

sawyerX​: Okay to apply these corrections at this point in code freeze?

If I do not hear otherwise\, I will merge this to blead on Thursday April 19 (i.e.\, in time for perl-5.27.11).

2.

I held off on applying spelling correction in pod/perlartistic.pod. That's because this is a legal document which I believe is maintained by the Perl Foundation (see​: http​://www.perlfoundation.org/artistic_license_2_0). So I don't feel I have the authority to change it here. ping Perl Foundation.

Thank you very much.

-- James E Keenan (jkeenan@​cpan.org)

p5pRT commented 6 years ago

The RT System itself - Status changed from 'new' to 'open'

p5pRT commented 6 years ago

From @jkeenan

On Wed\, 18 Apr 2018 20​:50​:43 GMT\, jkeenan wrote​:

On Wed\, 18 Apr 2018 01​:21​:29 GMT\, alexandr.savca89@​gmail.com wrote​:

Fix some typos in pod files. Patch for blead branch.

Regards\,

With one exception\, I have applied these corrections to the jkeenan/133120-pod branch.

1.

sawyerX​: Okay to apply these corrections at this point in code freeze?

If I do not hear otherwise\, I will merge this to blead on Thursday April 19 (i.e.\, in time for perl-5.27.11).

Heard nothing unfavorable re item 1\, so pushed to blead in commit dabde021f60e09a0d267e2c1d21905e88314056d

2.

I held off on applying spelling correction in pod/perlartistic.pod. That's because this is a legal document which I believe is maintained by the Perl Foundation (see​: http​://www.perlfoundation.org/artistic_license_2_0). So I don't feel I have the authority to change it here. ping Perl Foundation.

Still awaiting feedback on item 2; ticket remains open.

-- James E Keenan (jkeenan@​cpan.org)

p5pRT commented 6 years ago

From @xsawyerx

On Thu\, 19 Apr 2018 08​:38​:09 -0700\, jkeenan wrote​:

On Wed\, 18 Apr 2018 20​:50​:43 GMT\, jkeenan wrote​:

On Wed\, 18 Apr 2018 01​:21​:29 GMT\, alexandr.savca89@​gmail.com wrote​:

Fix some typos in pod files. Patch for blead branch.

Regards\,

With one exception\, I have applied these corrections to the jkeenan/133120-pod branch.

1.

sawyerX​: Okay to apply these corrections at this point in code freeze?

If I do not hear otherwise\, I will merge this to blead on Thursday April 19 (i.e.\, in time for perl-5.27.11).

Heard nothing unfavorable re item 1\, so pushed to blead in commit dabde021f60e09a0d267e2c1d21905e88314056d

Sorry. I'm still catching up. Yes\, you can. :)

p5pRT commented 6 years ago

From @iabyn

On Thu\, Apr 19\, 2018 at 08​:38​:09AM -0700\, James E Keenan via RT wrote​:

2.

I held off on applying spelling correction in pod/perlartistic.pod. That's because this is a legal document which I believe is maintained by the Perl Foundation (see​: http​://www.perlfoundation.org/artistic_license_2_0). So I don't feel I have the authority to change it here. ping Perl Foundation.

Still awaiting feedback on item 2; ticket remains open.

pod/perlartistic.pod is just a podified version of the 'Artistic' text file in the top-level directory. If the spelling mistake were to be fixed\, it would need to be fixed in both files.

Artistic is the version 1.0 licence\, which has various problems\, hence the 2.0 rewrite by TPF\, which I assume perl6 uses.

Apart from tab -> whitespace expansion in 2011\, Artistic hasn't been touched since 1996.

I think we should let sleeping dogs lie.

-- Music lesson​: a symbiotic relationship whereby a pupil's embellishments concerning the amount of practice performed since the last lesson are rewarded with embellishments from the teacher concerning the pupil's progress over the corresponding period.

p5pRT commented 6 years ago

From @xsawyerx

On 04/19/2018 09​:10 PM\, Dave Mitchell wrote​:

On Thu\, Apr 19\, 2018 at 08​:38​:09AM -0700\, James E Keenan via RT wrote​:

2.

I held off on applying spelling correction in pod/perlartistic.pod. That's because this is a legal document which I believe is maintained by the Perl Foundation (see​: http​://www.perlfoundation.org/artistic_license_2_0). So I don't feel I have the authority to change it here. ping Perl Foundation.

Still awaiting feedback on item 2; ticket remains open. pod/perlartistic.pod is just a podified version of the 'Artistic' text file in the top-level directory. If the spelling mistake were to be fixed\, it would need to be fixed in both files.

Artistic is the version 1.0 licence\, which has various problems\, hence the 2.0 rewrite by TPF\, which I assume perl6 uses.

Apart from tab -> whitespace expansion in 2011\, Artistic hasn't been touched since 1996.

I think we should let sleeping dogs lie.

Agreed. That license is unlikely to receive an update and we should not be editing it locally.

p5pRT commented 6 years ago

From @jkeenan

On Thu\, 19 Apr 2018 19​:58​:14 GMT\, xsawyerx@​gmail.com wrote​:

On 04/19/2018 09​:10 PM\, Dave Mitchell wrote​:

On Thu\, Apr 19\, 2018 at 08​:38​:09AM -0700\, James E Keenan via RT wrote​:

2.

I held off on applying spelling correction in pod/perlartistic.pod. That's because this is a legal document which I believe is maintained by the Perl Foundation (see​: http​://www.perlfoundation.org/artistic_license_2_0). So I don't feel I have the authority to change it here. ping Perl Foundation.

Still awaiting feedback on item 2; ticket remains open. pod/perlartistic.pod is just a podified version of the 'Artistic' text file in the top-level directory. If the spelling mistake were to be fixed\, it would need to be fixed in both files.

Artistic is the version 1.0 licence\, which has various problems\, hence the 2.0 rewrite by TPF\, which I assume perl6 uses.

Apart from tab -> whitespace expansion in 2011\, Artistic hasn't been touched since 1996.

I think we should let sleeping dogs lie.

Agreed. That license is unlikely to receive an update and we should not be editing it locally.

Accordingly\, closing ticket.

-- James E Keenan (jkeenan@​cpan.org)

p5pRT commented 6 years ago

@jkeenan - Status changed from 'open' to 'pending release'

p5pRT commented 6 years ago

From @iabyn

On Thu\, Apr 19\, 2018 at 03​:20​:00PM -0700\, James E Keenan via RT wrote​:

On Thu\, 19 Apr 2018 19​:58​:14 GMT\, xsawyerx@​gmail.com wrote​:

Agreed. That license is unlikely to receive an update and we should not be editing it locally.

I've just had private approval from TPF to fix the typo in Artistic\, so have done so now with v5.27.11-31-gd6f040aa42.

-- No matter how many dust sheets you use\, you will get paint on the carpet.

p5pRT commented 6 years ago

From @khwilliamson

Thank you for filing this report. You have helped make Perl better.

With the release yesterday of Perl 5.28.0\, this and 185 other issues have been resolved.

Perl 5.28.0 may be downloaded via​: https://metacpan.org/release/XSAWYERX/perl-5.28.0

If you find that the problem persists\, feel free to reopen this ticket.

p5pRT commented 6 years ago

@khwilliamson - Status changed from 'pending release' to 'resolved'