From 4375e838ae24b385ae79fa7b6918e613bedaaee6 Mon Sep 17 00:00:00 2001 From: Gurusamy Sarathy Date: Mon, 24 Apr 2000 06:11:56 +0000 Subject: [PATCH] various pod nits (from Larry Virden and others) p4raw-id: //depot/perl@5917 --- README.amiga | 10 +++++++++- README.hpux | 2 +- README.machten | 18 +++--------------- README.os2 | 6 +++--- README.os390 | 2 +- README.win32 | 4 ++++ embed.pl | 4 ++-- handy.h | 8 ++++---- lib/IPC/Open3.pm | 2 +- pod/Win32.pod | 2 +- pod/perl56delta.pod | 16 ++++++++-------- pod/perlapi.pod | 10 +++++----- pod/perlbook.pod | 2 +- pod/perlcompile.pod | 8 ++++---- pod/perldebguts.pod | 14 +++++++------- pod/perldiag.pod | 6 +++--- pod/perlfork.pod | 2 +- pod/perlfunc.pod | 18 +++++++++--------- pod/perlguts.pod | 6 +++--- pod/perlintern.pod | 4 ++-- pod/perlipc.pod | 2 +- pod/perlmod.pod | 12 ++++++------ pod/perlmodinstall.pod | 2 +- pod/perlnumber.pod | 2 +- pod/perlop.pod | 2 +- pod/perlport.pod | 6 +++--- pod/perlre.pod | 2 +- pod/perltrap.pod | 2 +- pod/perlunicode.pod | 8 +------- pod/perlvar.pod | 8 ++++---- pp.h | 2 +- 31 files changed, 93 insertions(+), 99 deletions(-) diff --git a/README.amiga b/README.amiga index c4bc6c5..8951f35 100644 --- a/README.amiga +++ b/README.amiga @@ -4,10 +4,18 @@ specially designed to be readable as is. =head1 NAME -perlamiga - Perl under Amiga OS +perlamiga - Perl under Amiga OS (possibly very outdated information) =head1 SYNOPSIS +NOTE: No one has reported building Perl on the Amiga in a long +time. The following information is highly unlikely to be correct. +If you would like to help the Amiga port to stay current, see: + + http://us.aminet.net/aminet/dirs/dev_gg.html + +for Amiga resources and information. + One can read this document in the following formats: man perlamiga diff --git a/README.hpux b/README.hpux index 4cdcf58..b5d1c0d 100644 --- a/README.hpux +++ b/README.hpux @@ -116,7 +116,7 @@ If these dependent libraries are not listed at shared library creation time, you will get fatal "Unresolved symbol" errors at run time when the library is loaded. -You may create a shared library that referers to another library, which +You may create a shared library that refers to another library, which may be either an archive library or a shared library. If it is a shared library, this is called a "dependent library". The dependent library's name is recorded in the main shared library, diff --git a/README.machten b/README.machten index 4310bbc..8e14fc7 100644 --- a/README.machten +++ b/README.machten @@ -57,25 +57,13 @@ and limited in its effect on practical Perl programs. =back -=head2 Using external modules - -If warnings are enabled with Perl's C<-w> command-line flag, you are -likely to see warnings when using external modules containing XS -(compiled) code: - - Subroutine DynaLoader::dl_error redefined at /usr/local/lib/perl5/5.6.0/powerpc-machten/DynaLoader.pm line 93. - -This is a harmless consequence of the static linking used for MachTen -perl. You can suppress the warnings by using the more modern -C<-Mwarnings> instead of the traditional C<-w>. (See L.) - =head2 Building external modules To add an external module to perl, build in the normal way, which is documented in L, or which can be driven automatically by the CPAN module (see L), which is part of the -standard distribution. If wou want to install a -module contains XS code (C or C++ source which compiles to object code +standard distribution. If you want to install a module which +contains XS code (C or C++ source which compiles to object code for linking with perl), you will have to replace your perl binary with a new version containing the new statically-linked object module. The build process tells you how to do this. @@ -98,4 +86,4 @@ Dominic Dunlop =head1 DATE -Version 1.0 2000-03-22 +Version 1.0.1 2000-03-27 diff --git a/README.os2 b/README.os2 index a69ea0d..1e7464b 100644 --- a/README.os2 +++ b/README.os2 @@ -1481,7 +1481,7 @@ this works as well under DOS if you use DOS-enabled port of pdksh B currently F of pdksh calls external programs via fork()/exec(), and there is I functioning exec() on -OS/2. exec() is emulated by EMX by asyncroneous call while the caller +OS/2. exec() is emulated by EMX by asynchronous call while the caller waits for child completion (to pretend that the C did not change). This means that 1 I copy of F is made active via fork()/exec(), which may lead to some resources taken from the system (even if we do @@ -1525,8 +1525,8 @@ as when processing B<-S> command-line switch. Perl uses its own malloc() under OS/2 - interpreters are usually malloc-bound for speed, but perl is not, since its malloc is lightning-fast. -Perl-memory-usage-tuned benchmarks show that Perl's malloc is 5 times quickier -than EMX one. I do not have convincing data about memory footpring, but +Perl-memory-usage-tuned benchmarks show that Perl's malloc is 5 times quicker +than EMX one. I do not have convincing data about memory footprint, but a (pretty random) benchmark showed that Perl one is 5% better. Combination of perl's malloc() and rigid DLL name resolution creates diff --git a/README.os390 b/README.os390 index 5fcdfc0..1821846 100644 --- a/README.os390 +++ b/README.os390 @@ -142,7 +142,7 @@ L, L, L. The Perl Institute (http://www.perl.org/) maintains a perl-mvs mailing list of interest to all folks building and/or -using perl on EBCDIC platforms. To subscibe, send a message of: +using perl on EBCDIC platforms. To subscribe, send a message of: subscribe perl-mvs diff --git a/README.win32 b/README.win32 index ce798f9..66482b9 100644 --- a/README.win32 +++ b/README.win32 @@ -127,6 +127,10 @@ Make sure you install the binaries that work with MSVCRT.DLL as indicated in the README for the GCC bundle. You may need to set up a few environment variables (usually run from a batch file). +The version of gcc-2.95.2-msvcrt.exe released 7 November 1999 left out +a fix for certain command line quotes, so be sure to download and install +fixes/quote-fix-msvcrt.exe too. + You also need dmake. See L above on how to get it. =back diff --git a/embed.pl b/embed.pl index 593ab19..952b7b8 100755 --- a/embed.pl +++ b/embed.pl @@ -1235,7 +1235,7 @@ perlintern - autogenerated documentation of purely B =head1 DESCRIPTION This file is the autogenerated documentation of functions in the -Perl intrepreter that are documented using Perl's internal documentation +Perl interpreter that are documented using Perl's internal documentation format but are not marked as part of the Perl API. In other words, B! @@ -1252,7 +1252,7 @@ print GUTS <<'END'; =head1 AUTHORS -The autodocumentation system was orignally added to the Perl core by +The autodocumentation system was originally added to the Perl core by Benjamin Stuhl. Documentation is by whoever was kind enough to document their functions. diff --git a/handy.h b/handy.h index 2c5d706..81f4745 100644 --- a/handy.h +++ b/handy.h @@ -260,18 +260,18 @@ C). /* =for apidoc Am|bool|isALNUM|char ch -Returns a boolean indicating whether the C C is an ascii alphanumeric +Returns a boolean indicating whether the C C is an ASCII alphanumeric character or digit. =for apidoc Am|bool|isALPHA|char ch -Returns a boolean indicating whether the C C is an ascii alphabetic +Returns a boolean indicating whether the C C is an ASCII alphabetic character. =for apidoc Am|bool|isSPACE|char ch Returns a boolean indicating whether the C C is whitespace. =for apidoc Am|bool|isDIGIT|char ch -Returns a boolean indicating whether the C C is an ascii +Returns a boolean indicating whether the C C is an ASCII digit. =for apidoc Am|bool|isUPPER|char ch @@ -524,7 +524,7 @@ The XSUB-writer's interface to the C C function. The C is the destination, C is the number of items, and C is the type. =for apidoc Am|void|StructCopy|type src|type dest|type -This is an architecture-independant macro to copy one structure to another. +This is an architecture-independent macro to copy one structure to another. =cut */ diff --git a/lib/IPC/Open3.pm b/lib/IPC/Open3.pm index 99709ac..46ebd68 100644 --- a/lib/IPC/Open3.pm +++ b/lib/IPC/Open3.pm @@ -49,7 +49,7 @@ failure: it just raises an exception matching C. However, C failures in the child are not detected. You'll have to trap SIGPIPE yourself. -open2() does not wait for and reap the child process after it exits. +open3() does not wait for and reap the child process after it exits. Except for short programs where it's acceptable to let the operating system take care of this, you need to do this yourself. This is normally as simple as calling C when you're done with the process. diff --git a/pod/Win32.pod b/pod/Win32.pod index 44ed3d1..bd1d065 100644 --- a/pod/Win32.pod +++ b/pod/Win32.pod @@ -132,7 +132,7 @@ same value. =item Win32::GetLongPathName(PATHNAME) -[CORE] Returns a representaion of PATHNAME composed of longname +[CORE] Returns a representation of PATHNAME composed of longname components (if any). The result may not necessarily be longer than PATHNAME. No attempt is made to convert PATHNAME to the absolute path. Compare with Win32::GetShortPathName and diff --git a/pod/perl56delta.pod b/pod/perl56delta.pod index cec774b..1ca4d7e 100644 --- a/pod/perl56delta.pod +++ b/pod/perl56delta.pod @@ -506,7 +506,7 @@ If the array is tied, the EXISTS() method in the corresponding tied package will be invoked. delete() may be used to remove an element from the array and return -it. The array element at that position returns to its unintialized +it. The array element at that position returns to its uninitialized state, so that testing for the same element with exists() will return false. If the element happens to be the one at the end, the size of the array also shrinks up to the highest element that tests true for @@ -780,7 +780,7 @@ under the Compiler, but there is still a significant way to go to achieve production quality compiled executables. NOTE: The Compiler suite remains highly experimental. The - generated code may not be correct, even it manages to execute + generated code may not be correct, even when it manages to execute without errors. =item Benchmark @@ -1007,7 +1007,7 @@ messages. For example: =head1 DESCRIPTION - B will read the given input file(s) and do someting + B will read the given input file(s) and do something useful with the contents thereof. =cut @@ -1039,7 +1039,7 @@ IO::Socket::accept now uses select() instead of alarm() for doing timeouts. IO::Socket::INET->new now sets $! correctly on failure. $@ is -still set for backwards compatability. +still set for backwards compatibility. =item JPL @@ -1582,7 +1582,7 @@ platform, but the possibility exists. =head2 VMS Numerous revisions and extensions to configuration, build, testing, and -installation process to accomodate core changes and VMS-specific options. +installation process to accommodate core changes and VMS-specific options. Expand %ENV-handling code to allow runtime mapping to logical names, CLI symbols, and CRTL environ array. @@ -1695,7 +1695,7 @@ been fixed. =head2 All compilation errors are true errors -Some "errors" encountered at compile time were by neccessity +Some "errors" encountered at compile time were by necessity generated as warnings followed by eventual termination of the program. This enabled more such errors to be reported in a single run, rather than causing a hard stop at the first error @@ -2147,7 +2147,7 @@ L for more on portability concerns. (W internal) A warning peculiar to VMS. Perl tried to read the CRTL's internal environ array, and encountered an element without the C<=> delimiter -used to spearate keys from values. The element is ignored. +used to separate keys from values. The element is ignored. =item Ill-formed message in prime_env_iter: |%s| @@ -2305,7 +2305,7 @@ could be a potential Year 2000 problem. =item pragma "attrs" is deprecated, use "sub NAME : ATTRS" instead -(W deprecated) You have written somehing like this: +(W deprecated) You have written something like this: sub doit { diff --git a/pod/perlapi.pod b/pod/perlapi.pod index e0ae4cf..0109b27 100644 --- a/pod/perlapi.pod +++ b/pod/perlapi.pod @@ -237,7 +237,7 @@ NOTE: the perl_ form of this function is deprecated. =item EXTEND Used to extend the argument stack for an XSUB's return values. Once -used, guarrantees that there is room for at least C to be pushed +used, guarantees that there is room for at least C to be pushed onto the stack. void EXTEND(SP, int nitems) @@ -662,21 +662,21 @@ Undefines the hash. =item isALNUM -Returns a boolean indicating whether the C C is an ascii alphanumeric +Returns a boolean indicating whether the C C is an ASCII alphanumeric character or digit. bool isALNUM(char ch) =item isALPHA -Returns a boolean indicating whether the C C is an ascii alphabetic +Returns a boolean indicating whether the C C is an ASCII alphabetic character. bool isALPHA(char ch) =item isDIGIT -Returns a boolean indicating whether the C C is an ascii +Returns a boolean indicating whether the C C is an ASCII digit. bool isDIGIT(char ch) @@ -1263,7 +1263,7 @@ wrapper for C). =item StructCopy -This is an architecture-independant macro to copy one structure to another. +This is an architecture-independent macro to copy one structure to another. void StructCopy(type src, type dest, type) diff --git a/pod/perlbook.pod b/pod/perlbook.pod index 3a693dd..1b322fb 100644 --- a/pod/perlbook.pod +++ b/pod/perlbook.pod @@ -9,7 +9,7 @@ by Larry Wall et al, is the definitive reference work covering nearly all of Perl. You can order it and other Perl books from O'Reilly & Associates, 1-800-998-9938. Local/overseas is +1 707 829 0515. If you can locate an O'Reilly order form, you can also fax to +1 707 829 0104. -If you're web-connected, you can even mosey on over to http://www.ora.com/ +If you're web-connected, you can even mosey on over to http://www.oreilly.com/ for an online order form. Other Perl books from various publishers and authors diff --git a/pod/perlcompile.pod b/pod/perlcompile.pod index 697cb80..e5544ec 100644 --- a/pod/perlcompile.pod +++ b/pod/perlcompile.pod @@ -308,7 +308,7 @@ I program that produces bytecode. This module is used by the B::CC back end. It walks "basic blocks". A basic block is a series of operations which is known to execute from -start to finish, with no possiblity of branching or halting. +start to finish, with no possibility of branching or halting. =item B::Bytecode @@ -369,12 +369,12 @@ can identify. See L for details about usage. =item B::Showlex This module prints out the my() variables used in a function or a -file. To gt a list of the my() variables used in the subroutine +file. To get a list of the my() variables used in the subroutine mysub() defined in the file myperlprogram: $ perl -MO=Showlex,mysub myperlprogram -To gt a list of the my() variables used in the file myperlprogram: +To get a list of the my() variables used in the file myperlprogram: $ perl -MO=Showlex myperlprogram @@ -419,7 +419,7 @@ names. The optimized C backend outputs code for more modules than it should (e.g., DirHandle). It also has little hope of properly handling -C outside the running subroutine (C is ok). +C outside the running subroutine (C is okay). C currently does not work at all in this backend. It also creates a huge initialization function that gives C compilers headaches. Splitting the initialization function gives diff --git a/pod/perldebguts.pod b/pod/perldebguts.pod index b74f3ef..2bf6ea4 100644 --- a/pod/perldebguts.pod +++ b/pod/perldebguts.pod @@ -13,8 +13,8 @@ intimate with Perl's guts to understand. Caveat lector. Perl has special debugging hooks at compile-time and run-time used to create debugging environments. These hooks are not to be confused -with the I command described in L, which are -usable only if a special Perl built per the instructions the +with the I command described in L, which is +usable only if a special Perl is built per the instructions in the F podpage in the Perl source tree. For example, whenever you call Perl's built-in C function @@ -630,7 +630,7 @@ Perl is a profligate wastrel when it comes to memory use. There is a saying that to estimate memory usage of Perl, assume a reasonable algorithm for memory allocation, multiply that estimate by 10, and while you still may miss the mark, at least you won't be quite so -astonished. This is not absolutely true, but may prvide a good +astonished. This is not absolutely true, but may provide a good grasp of what happens. Assume that an integer cannot take less than 20 bytes of memory, a @@ -666,7 +666,7 @@ the top level of the Perl source tree. If your perl is using Perl's malloc() and was compiled with the necessary switches (this is the default), then it will print memory -usage statistics after compiling your code hwen C<< $ENV{PERL_DEBUG_MSTATS} +usage statistics after compiling your code when C<< $ENV{PERL_DEBUG_MSTATS} > 1 >>, and before termination of the program when C<< $ENV{PERL_DEBUG_MSTATS} >= 1 >>. The report format is similar to the following example: @@ -720,7 +720,7 @@ of two--or possibly one page greater. In the second row, if present, the memory footprints of the buckets are between the memory footprints of two buckets "above". -For example, suppose under the pervious example, the memory footprints +For example, suppose under the previous example, the memory footprints were free: 8 16 32 64 128 256 512 1024 2048 4096 8192 @@ -804,7 +804,7 @@ To see this list, insert two C statements around the call: do 'lib/auto/POSIX/autosplit.ix'; warn('!!! "after"'); -and run it with PErl's B<-DL> option. The first warn() will print +and run it with Perl's B<-DL> option. The first warn() will print memory allocation info before parsing the file and will memorize the statistics at this point (we ignore what it prints). The second warn() prints increments with respect to these memorized data. This @@ -842,7 +842,7 @@ Here are explanations for other Is above: =item C<717> -CReates bigger C structures. In the case above, it +Creates bigger C structures. In the case above, it creates 3 Cs per subroutine, one for a list of lexical variable names, one for a scratchpad (which contains lexical variables and C), and one for the array of scratchpads needed for diff --git a/pod/perldiag.pod b/pod/perldiag.pod index 9ed7552..f559645 100644 --- a/pod/perldiag.pod +++ b/pod/perldiag.pod @@ -1610,7 +1610,7 @@ versions of Perl are likely to eliminate these arbitrary limitations. (W internal) A warning peculiar to VMS. Perl tried to read the CRTL's internal environ array, and encountered an element without the C<=> delimiter -used to spearate keys from values. The element is ignored. +used to separate keys from values. The element is ignored. =item Ill-formed message in prime_env_iter: |%s| @@ -2518,7 +2518,7 @@ Perl assumes that memory is now corrupted. See L. =item pragma "attrs" is deprecated, use "sub NAME : ATTRS" instead -(W deprecated) You have written somehing like this: +(W deprecated) You have written something like this: sub doit { @@ -2870,7 +2870,7 @@ repetitions of "xyz" is C, not C. =item Stub found while resolving method `%s' overloading `%s' in package `%s' (P) Overloading resolution over @ISA tree may be broken by importation stubs. -Stubs should never be implicitely created, but explicit calls to C +Stubs should never be implicitly created, but explicit calls to C may break this. =item Subroutine %s redefined diff --git a/pod/perlfork.pod b/pod/perlfork.pod index d930e93..a3dbf08 100644 --- a/pod/perlfork.pod +++ b/pod/perlfork.pod @@ -51,7 +51,7 @@ pseudo-processes are launched after others have been wait()-ed on. =item %ENV -Each pseudo-process maintains its own virtual enviroment. Modifications +Each pseudo-process maintains its own virtual environment. Modifications to %ENV affect the virtual environment, and are only visible within that pseudo-process, and in any processes (or pseudo-processes) launched from it. diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod index b973a15..6521f6e 100644 --- a/pod/perlfunc.pod +++ b/pod/perlfunc.pod @@ -146,11 +146,11 @@ C, C, C, C, C, C, C =item Keywords related to scoping -C, C, C, C, C, C +C, C, C, C, C, C, C =item Miscellaneous functions -C, C, C, C, C, C, C, +C, C, C, C, C, C, C, C, C, C, C =item Functions for processes and process groups @@ -200,8 +200,8 @@ C, C, C