Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Lots of spelling fixes in the POD (RT#45528)

git-svn-id: http://svn.perl.org/modules/Module-Build/trunk@12877 50811bd7-b8ce-0310-adc1-d9db26280581
  • Loading branch information...
commit f09c7075f0d58508c964bee92b5f1881ad94eec2 1 parent 6b9899d
Ken Williams kenahoo authored
2  .perltidyrc
@@ -20,7 +20,7 @@
20 20 --square-bracket-tightness=2
21 21 --brace-tightness=2
22 22
23   -# who uses space before the peterbuilt?
  23 +# who uses space before the peterbilt?
24 24 --nohanging-side-comments
25 25 --nospace-for-semicolon
26 26 --indent-block-comments
1  Changes
@@ -14,6 +14,7 @@ Revision history for Perl extension Module::Build.
14 14 - realclean might not delete Build.bat on Windows (RT#43863)
15 15 - include_dirs parameter now works correctly when given a single
16 16 string argument (RT#40177)
  17 + - Lots of spelling fixes in the POD (RT#45528)
17 18
18 19 Other
19 20 - On MSWin32, bumped File::Spec prereq to 3.30 for a variety of fixes
4 configs/darwin-Config.pm
@@ -891,7 +891,7 @@ sub FETCH {
891 891 } else {
892 892 $marker = "$_[1]=";
893 893 # return undef unless (($value) = $config_sh =~ m/^$_[1]='(.*)'\s*$/m);
894   - # Check for the common case, ' delimeted
  894 + # Check for the common case, ' delimited
895 895 $start = index($config_sh, "\n$marker$quote_type");
896 896 # If that failed, check for " delimited
897 897 if ($start == -1) {
@@ -1340,7 +1340,7 @@ the value is reset to a plain C<byacc> and is not useful.
1340 1340 From F<byteorder.U>:
1341 1341
1342 1342 This variable holds the byte order. In the following, larger digits
1343   -indicate more significance. The variable byteorder is either 4321
  1343 +indicate more significance. The variable C<byteorder> is either 4321
1344 1344 on a big-endian machine, or 1234 on a little-endian, or 87654321
1345 1345 on a Cray ... or 3412 with weird order !
1346 1346
4 configs/win2k-Config.pm
@@ -927,7 +927,7 @@ sub FETCH {
927 927 } else {
928 928 $marker = "$_[1]=";
929 929 # return undef unless (($value) = $config_sh =~ m/^$_[1]='(.*)'\s*$/m);
930   - # Check for the common case, ' delimeted
  930 + # Check for the common case, ' delimited
931 931 $start = index($config_sh, "\n$marker$quote_type");
932 932 # If that failed, check for " delimited
933 933 if ($start == -1) {
@@ -1377,7 +1377,7 @@ the value is reset to a plain C<byacc> and is not useful.
1377 1377 From F<byteorder.U>:
1378 1378
1379 1379 This variable holds the byte order. In the following, larger digits
1380   -indicate more significance. The variable byteorder is either 4321
  1380 +indicate more significance. The variable C<byteorder> is either 4321
1381 1381 on a big-endian machine, or 1234 on a little-endian, or 87654321
1382 1382 on a Cray ... or 3412 with weird order !
1383 1383
73 lib/Module/Build.pm
@@ -110,6 +110,11 @@ sub is_unixish { return ((os_type() || '') eq 'Unix') }
110 110
111 111 __END__
112 112
  113 +=for :stopwords
  114 +bindoc binhtml destdir distcheck distclean distdir distmeta distsign disttest
  115 +fakeinstall html installdirs installsitebin installsitescript installvendorbin
  116 +installvendorscript libdoc libhtml pardist ppd ppmdist realclean skipcheck
  117 +testall testcover testdb testpod testpodcoverage versioninstall
113 118
114 119 =head1 NAME
115 120
@@ -233,7 +238,7 @@ The following build actions are provided by default.
233 238 If you run the C<Build> script without any arguments, it runs the
234 239 C<build> action, which in turn runs the C<code> and C<docs> actions.
235 240
236   -This is analogous to the MakeMaker 'make all' target.
  241 +This is analogous to the C<MakeMaker> I<make all> target.
237 242
238 243 =item clean
239 244
@@ -247,7 +252,7 @@ C<_build/> directory and the C<Build> script itself).
247 252
248 253 [version 0.20]
249 254
250   -This action builds your codebase.
  255 +This action builds your code base.
251 256
252 257 By default it just creates a C<blib/> directory and copies any C<.pm>
253 258 and C<.pod> files from your C<lib/> directory into the C<blib/>
@@ -328,7 +333,7 @@ This directory is what the distribution tarball is created from.
328 333
329 334 Creates the F<META.yml> file that describes the distribution.
330 335
331   -F<META.yml> is a file containing various bits of "metadata" about the
  336 +F<META.yml> is a file containing various bits of I<metadata> about the
332 337 distribution. The metadata includes the distribution name, version,
333 338 abstract, prerequisites, license, and various other data about the
334 339 distribution. This file is created as F<META.yml> in YAML format.
@@ -363,13 +368,13 @@ that directory.
363 368
364 369 [version 0.20]
365 370
366   -This will generate documentation (e.g. Unix man pages and html
  371 +This will generate documentation (e.g. Unix man pages and HTML
367 372 documents) for any installable items under B<blib/> that
368 373 contain POD. If there are no C<bindoc> or C<libdoc> installation
369 374 targets defined (as will be the case on systems that don't support
370 375 Unix manpages) no action is taken for manpages. If there are no
371 376 C<binhtml> or C<libhtml> installation targets defined no action is
372   -taken for html documents.
  377 +taken for HTML documents.
373 378
374 379 =item fakeinstall
375 380
@@ -476,7 +481,7 @@ installed on your system.
476 481 Build a PPD file for your distribution.
477 482
478 483 This action takes an optional argument C<codebase> which is used in
479   -the generated ppd file to specify the (usually relative) URL of the
  484 +the generated PPD file to specify the (usually relative) URL of the
480 485 distribution. By default, this value is the distribution name without
481 486 any path information.
482 487
@@ -489,7 +494,7 @@ Example:
489 494 [version 0.23]
490 495
491 496 Generates a PPM binary distribution and a PPD description file. This
492   -action also invokes the 'ppd' action, so it can accept the same
  497 +action also invokes the C<ppd> action, so it can accept the same
493 498 C<codebase> argument described under that action.
494 499
495 500 This uses the same mechanism as the C<dist> action to tar & zip its
@@ -500,7 +505,7 @@ the result.
500 505
501 506 [version 0.32]
502 507
503   -This action prints out a Perl data structure of all prerequsites and the versions
  508 +This action prints out a Perl data structure of all prerequisites and the versions
504 509 required. The output can be loaded again using C<eval()>. This can be useful for
505 510 external tools that wish to query a Build script for prerequisites.
506 511
@@ -594,7 +599,7 @@ or use a C<glob()>-style pattern:
594 599
595 600 =item testall
596 601
597   -[verion 0.2807]
  602 +[version 0.2807]
598 603
599 604 [Note: the 'testall' action and the code snippets below are currently
600 605 in alpha stage, see
@@ -698,9 +703,9 @@ respective action.
698 703 NOTE: There is some preliminary support for options to use the more
699 704 familiar long option style. Most options can be preceded with the
700 705 C<--> long option prefix, and the underscores changed to dashes
701   -(e.g. --use-rcfile). Additionally, the argument to boolean options is
  706 +(e.g. C<--use-rcfile>). Additionally, the argument to boolean options is
702 707 optional, and boolean options can be negated by prefixing them with
703   -'no' or 'no-' (e.g. --noverbose or --no-verbose).
  708 +C<no> or C<no-> (e.g. C<--noverbose> or C<--no-verbose>).
704 709
705 710 =over 4
706 711
@@ -760,7 +765,7 @@ when you invoke C<perl Build.PL>.
760 765 --install_path html=/home/ken/docs/html
761 766
762 767 If you wish to locate your resource file in a different location, you
763   -can set the environment variable 'MODULEBUILDRC' to the complete
  768 +can set the environment variable C<MODULEBUILDRC> to the complete
764 769 absolute path of the file containing your options.
765 770
766 771
@@ -789,7 +794,7 @@ Usually pure-Perl module files ending in F<.pm>.
789 794 =item arch
790 795
791 796 "Architecture-dependent" module files, usually produced by compiling
792   -XS, Inline, or similar code.
  797 +XS, L<Inline>, or similar code.
793 798
794 799 =item script
795 800
@@ -817,11 +822,11 @@ pages belonging to the 'man3' category.
817 822
818 823 =item binhtml
819 824
820   -This is the same as C<bindoc> above, but applies to html documents.
  825 +This is the same as C<bindoc> above, but applies to HTML documents.
821 826
822 827 =item libhtml
823 828
824   -This is the same as C<bindoc> above, but applies to html documents.
  829 +This is the same as C<bindoc> above, but applies to HTML documents.
825 830
826 831 =back
827 832
@@ -851,7 +856,7 @@ parameter as follows:
851 856 binhtml => installhtml1dir installsitehtml1dir installvendorhtml1dir [*]
852 857 libhtml => installhtml3dir installsitehtml3dir installvendorhtml3dir [*]
853 858
854   - * Under some OS (eg. MSWin32) the destination for html documents is
  859 + * Under some OS (eg. MSWin32) the destination for HTML documents is
855 860 determined by the C<Config.pm> entry C<installhtmldir>.
856 861
857 862 The default value of C<installdirs> is "site". If you're creating
@@ -869,7 +874,7 @@ with perl itself (i.e. a "core module"), then you may set
869 874 C<installdirs> to "core" to overwrite the module in its present
870 875 location.
871 876
872   -(Note that the 'script' line is different from MakeMaker -
  877 +(Note that the 'script' line is different from C<MakeMaker> -
873 878 unfortunately there's no such thing as "installsitescript" or
874 879 "installvendorscript" entry in C<Config.pm>, so we use the
875 880 "installsitebin" and "installvendorbin" entries to at least get the
@@ -904,7 +909,7 @@ system, you'll install as follows:
904 909 binhtml => /home/ken/html
905 910 libhtml => /home/ken/html
906 911
907   -Note that this is I<different> from how MakeMaker's C<PREFIX>
  912 +Note that this is I<different> from how C<MakeMaker>'s C<PREFIX>
908 913 parameter works. C<install_base> just gives you a default layout under the
909 914 directory you specify, which may have little to do with the
910 915 C<installdirs=site> layout.
@@ -932,10 +937,10 @@ platform you're installing on.
932 937
933 938 =item prefix
934 939
935   -Provided for compatibility with ExtUtils::MakeMaker's PREFIX argument.
  940 +Provided for compatibility with C<ExtUtils::MakeMaker>'s PREFIX argument.
936 941 C<prefix> should be used when you wish Module::Build to install your
937 942 modules, documentation and scripts in the same place
938   -ExtUtils::MakeMaker does.
  943 +C<ExtUtils::MakeMaker> does.
939 944
940 945 The following are equivalent.
941 946
@@ -943,13 +948,13 @@ The following are equivalent.
943 948 perl Makefile.PL PREFIX=/tmp/foo
944 949
945 950 Because of the very complex nature of the prefixification logic, the
946   -behavior of PREFIX in MakeMaker has changed subtly over time.
  951 +behavior of PREFIX in C<MakeMaker> has changed subtly over time.
947 952 Module::Build's --prefix logic is equivalent to the PREFIX logic found
948   -in ExtUtils::MakeMaker 6.30.
  953 +in C<ExtUtils::MakeMaker> 6.30.
949 954
950   -If you do not need to retain compatibility with ExtUtils::MakeMaker or
951   -are starting a fresh Perl installation we recommand you use
952   -C<install_base> instead (and C<INSTALL_BASE> in ExtUtils::MakeMaker).
  955 +If you do not need to retain compatibility with C<ExtUtils::MakeMaker> or
  956 +are starting a fresh Perl installation we recommend you use
  957 +C<install_base> instead (and C<INSTALL_BASE> in C<ExtUtils::MakeMaker>).
953 958 See L<Module::Build::Cookbook/Instaling in the same location as
954 959 ExtUtils::MakeMaker> for further information.
955 960
@@ -960,13 +965,13 @@ ExtUtils::MakeMaker> for further information.
960 965 =head1 MOTIVATIONS
961 966
962 967 There are several reasons I wanted to start over, and not just fix
963   -what I didn't like about MakeMaker:
  968 +what I didn't like about C<MakeMaker>:
964 969
965 970 =over 4
966 971
967 972 =item *
968 973
969   -I don't like the core idea of MakeMaker, namely that C<make> should be
  974 +I don't like the core idea of C<MakeMaker>, namely that C<make> should be
970 975 involved in the build process. Here are my reasons:
971 976
972 977 =over 4
@@ -991,25 +996,25 @@ build/install process to do what they want.
991 996
992 997 =item *
993 998
994   -There are several architectural decisions in MakeMaker that make it
  999 +There are several architectural decisions in C<MakeMaker> that make it
995 1000 very difficult to customize its behavior. For instance, when using
996   -MakeMaker you do C<use ExtUtils::MakeMaker>, but the object created in
  1001 +C<MakeMaker> you do C<use ExtUtils::MakeMaker>, but the object created in
997 1002 C<WriteMakefile()> is actually blessed into a package name that's
998 1003 created on the fly, so you can't simply subclass
999 1004 C<ExtUtils::MakeMaker>. There is a workaround C<MY> package that lets
1000   -you override certain MakeMaker methods, but only certain explicitly
1001   -preselected (by MakeMaker) methods can be overridden. Also, the method
  1005 +you override certain C<MakeMaker> methods, but only certain explicitly
  1006 +preselected (by C<MakeMaker>) methods can be overridden. Also, the method
1002 1007 of customization is very crude: you have to modify a string containing
1003 1008 the Makefile text for the particular target. Since these strings
1004 1009 aren't documented, and I<can't> be documented (they take on different
1005 1010 values depending on the platform, version of perl, version of
1006   -MakeMaker, etc.), you have no guarantee that your modifications will
1007   -work on someone else's machine or after an upgrade of MakeMaker or
  1011 +C<MakeMaker>, etc.), you have no guarantee that your modifications will
  1012 +work on someone else's machine or after an upgrade of C<MakeMaker> or
1008 1013 perl.
1009 1014
1010 1015 =item *
1011 1016
1012   -It is risky to make major changes to MakeMaker, since it does so many
  1017 +It is risky to make major changes to C<MakeMaker>, since it does so many
1013 1018 things, is so important, and generally works. C<Module::Build> is an
1014 1019 entirely separate package so that I can work on it all I want, without
1015 1020 worrying about backward compatibility.
43 lib/Module/Build/API.pod
Source Rendered
@@ -2,6 +2,7 @@
2 2
3 3 Module::Build::API - API Reference for Module Authors
4 4
  5 +=for :stopwords apache bsd distdir distsign gpl installdirs lgpl mit mozilla packlists
5 6
6 7 =head1 DESCRIPTION
7 8
@@ -151,7 +152,7 @@ for the details of how requirements can be specified.
151 152 [version 0.28]
152 153
153 154 If true, this parameter tells Module::Build to create a F<.packlist>
154   -file during the C<install> action, just like ExtUtils::MakeMaker does.
  155 +file during the C<install> action, just like C<ExtUtils::MakeMaker> does.
155 156 The file is created in a subdirectory of the C<arch> installation
156 157 location. It is used by some other tools (CPAN, CPANPLUS, etc.) for
157 158 determining what files are part of an install.
@@ -196,9 +197,9 @@ that the C<license> parameter specifies a license that it knows about.
196 197
197 198 [version 0.19]
198 199
199   -This parameter lets you use Module::Build::Compat during the
  200 +This parameter lets you use C<Module::Build::Compat> during the
200 201 C<distdir> (or C<dist>) action to automatically create a Makefile.PL
201   -for compatibility with ExtUtils::MakeMaker. The parameter's value
  202 +for compatibility with C<ExtUtils::MakeMaker>. The parameter's value
202 203 should be one of the styles named in the L<Module::Build::Compat>
203 204 documentation.
204 205
@@ -211,7 +212,7 @@ file at the top level of your distribution. Currently it will simply
211 212 use C<Pod::Text> (or C<Pod::Readme> if it's installed) on the file
212 213 indicated by C<dist_version_from> and put the result in the F<README>
213 214 file. This is by no means the only recommended style for writing a
214   -README, but it seems to be one common one used on the CPAN.
  215 +F<README>, but it seems to be one common one used on the CPAN.
215 216
216 217 If you generate a F<README> in this way, it's probably a good idea to
217 218 create a separate F<INSTALL> file if that information isn't in the
@@ -629,7 +630,7 @@ locations based on their package name, i.e. where they would be found
629 630 in a "normal" Module::Build-style distribution. This parameter is
630 631 mainly intended to support alternative layouts of files.
631 632
632   -For instance, if you have an old-style MakeMaker distribution for a
  633 +For instance, if you have an old-style C<MakeMaker> distribution for a
633 634 module called C<Foo::Bar> and a F<Bar.pm> file at the top level of the
634 635 distribution, you could specify your layout in your C<Build.PL> like
635 636 this:
@@ -876,7 +877,7 @@ get or set on the build object.
876 877 print $build->pedantic, $/;
877 878 $build->pedantic(0);
878 879
879   -If the default value is a hash reference, this generetes a special-case
  880 +If the default value is a hash reference, this generates a special-case
880 881 accessor method, wherein individual key/value pairs may be set or fetched:
881 882
882 883 print "stuff{foo} is: ", $build->stuff( 'foo' ), $/;
@@ -1171,7 +1172,7 @@ when the C<realclean> action is performed.
1171 1172 Among the files created in C<_build/> is a F<_build/prereqs> file
1172 1173 containing the set of prerequisites for this distribution, as a hash
1173 1174 of hashes. This file may be C<eval()>-ed to obtain the authoritative
1174   -set of prereqs, which might be different from the contents of
  1175 +set of prerequisites, which might be different from the contents of
1175 1176 F<META.yml> (because F<Build.PL> might have set them dynamically).
1176 1177 But fancy developers take heed: do not put any fancy custom runtime
1177 1178 code in the F<_build/prereqs> file, leave it as a static declaration
@@ -1282,7 +1283,7 @@ Perl's C<system()>. It returns true or false to indicate success or
1282 1283 failure (the opposite of how C<system()> works, but more intuitive).
1283 1284
1284 1285 Note that if you supply a single argument to C<do_system()>, it
1285   -will/may be processed by the systems's shell, and any special
  1286 +will/may be processed by the system's shell, and any special
1286 1287 characters will do their special things. If you supply multiple
1287 1288 arguments, no shell will get involved and the command will be executed
1288 1289 directly.
@@ -1346,14 +1347,14 @@ want to set the relative install path for custom build elements.
1346 1347
1347 1348 With no argument, it returns a reference to a hash containing all
1348 1349 elements and their respective values. This hash should not be modified
1349   -directly; use the multi-argument below form to change values.
  1350 +directly; use the multiple argument below form to change values.
1350 1351
1351 1352 The single argument form returns the value associated with the
1352 1353 element C<$type>.
1353 1354
1354   -The multi-argument form allows you to set the paths for element types.
1355   -C<$value> must be a relative path using unix-like paths. (A series of
1356   -directories seperated by slashes. Eg 'foo/bar'.) The return value is a
  1355 +The multiple argument form allows you to set the paths for element types.
  1356 +C<$value> must be a relative path using Unix-like paths. (A series of
  1357 +directories separated by slashes, e.g. C<foo/bar>.) The return value is a
1357 1358 localized path based on C<$value>.
1358 1359
1359 1360 Assigning the value C<undef> to an element causes it to be removed.
@@ -1384,12 +1385,12 @@ like C<install_base()>.
1384 1385
1385 1386 With no argument, it returns a reference to a hash containing all
1386 1387 elements and their respective values. This hash should not be modified
1387   -directly; use the multi-argument below form to change values.
  1388 +directly; use the multiple argument below form to change values.
1388 1389
1389 1390 The single argument form returns the value associated with the
1390 1391 element C<$type>.
1391 1392
1392   -The multi-argument form allows you to set the paths for element types.
  1393 +The multiple argument form allows you to set the paths for element types.
1393 1394 The supplied C<$path> should be an absolute path to install elements
1394 1395 of C<$type>. The return value is C<$path>.
1395 1396
@@ -1412,7 +1413,7 @@ exist.
1412 1413
1413 1414 This is the name of the original action invoked by the user. This
1414 1415 value is set when the user invokes F<Build.PL>, the F<Build> script,
1415   -or programatically through the L<dispatch()|/"dispatch($action, %args)">
  1416 +or programmatically through the L<dispatch()|/"dispatch($action, %args)">
1416 1417 method. It does not change as sub-actions are executed as
1417 1418 dependencies are evaluated.
1418 1419
@@ -1432,7 +1433,7 @@ information about the build, and to share that information among
1432 1433 different entities involved in the build. See the example in the
1433 1434 C<current()> method.
1434 1435
1435   -The C<notes()> method is essentally a glorified hash access. With no
  1436 +The C<notes()> method is essentially a glorified hash access. With no
1436 1437 arguments, C<notes()> returns the entire hash of notes. With one argument,
1437 1438 C<notes($key)> returns the value associated with the given key. With two
1438 1439 arguments, C<notes($key, $value)> sets the value associated with the given key
@@ -1506,9 +1507,9 @@ use the three-argument below form to change values.
1506 1507 The two argument form returns the value associated with the
1507 1508 element C<$type>.
1508 1509
1509   -The multi-argument form allows you to set the paths for element types.
1510   -C<$value> must be a relative path using unix-like paths. (A series of
1511   -directories seperated by slashes. Eg 'foo/bar'.) The return value is a
  1510 +The multiple argument form allows you to set the paths for element types.
  1511 +C<$value> must be a relative path using Unix-like paths. (A series of
  1512 +directories separated by slashes, e.g. C<foo/bar>.) The return value is a
1512 1513 localized path based on C<$value>.
1513 1514
1514 1515 Assigning the value C<undef> to an element causes it to be removed.
@@ -1678,7 +1679,7 @@ call to C<new()>. This allows you to programmatically tell if C<perl Build.PL>
1678 1679 or any execution of C<./Build> had command line options specified that
1679 1680 override valid properties.
1680 1681
1681   -The C<runtime_params()> method is essentally a glorified read-only hash. With
  1682 +The C<runtime_params()> method is essentially a glorified read-only hash. With
1682 1683 no arguments, C<runtime_params()> returns the entire hash of properties
1683 1684 specified on the command line. With one argument, C<runtime_params($key)>
1684 1685 returns the value associated with the given key.
@@ -1772,7 +1773,7 @@ See L<http://module-build.sourceforge.net/META-spec-current.html#keywords>.
1772 1773
1773 1774 A list of additional resources available for users of the
1774 1775 distribution. This can include links to a homepage on the web, a
1775   -bugtracker, the repository location, a even subscription page for the
  1776 +bug tracker, the repository location, a even subscription page for the
1776 1777 distribution mailing list.
1777 1778
1778 1779 See L<http://module-build.sourceforge.net/META-spec-current.html#resources>.
4 lib/Module/Build/Authoring.pod
Source Rendered
@@ -100,7 +100,7 @@ Module::Build directly:
100 100 This is relatively straightforward, and is the best way to do things
101 101 if your My::Builder class contains lots of code. The
102 102 C<create_build_script()> method will ensure that the current value of
103   -C<@INC> (including the C</nonstandard/library/path>) is propogated to
  103 +C<@INC> (including the C</nonstandard/library/path>) is propagated to
104 104 the Build script, so that My::Builder can be found when running build
105 105 actions.
106 106
@@ -281,7 +281,7 @@ C<Build> script.
281 281
282 282 Note that if you want to provide both a F<Makefile.PL> and a
283 283 F<Build.PL> for your distribution, you probably want to add the
284   -following to C<WriteMakefile> in your F<Makefile.PL> so that MakeMaker
  284 +following to C<WriteMakefile> in your F<Makefile.PL> so that C<MakeMaker>
285 285 doesn't try to run your F<Build.PL> as a normal F<.PL> file:
286 286
287 287 PL_FILES => {},
22 lib/Module/Build/Base.pm
@@ -414,7 +414,7 @@ sub _perl_is_same {
414 414 }
415 415 }
416 416
417   -# Returns the absolute path of the perl interperter used to invoke
  417 +# Returns the absolute path of the perl interpreter used to invoke
418 418 # this process. The path is derived from $^X or $Config{perlpath}. On
419 419 # some platforms $^X contains the complete absolute path of the
420 420 # interpreter, on other it may contain a relative path, or simply
@@ -1075,11 +1075,11 @@ sub _pod_parse {
1075 1075 return $p->{$member} = $parser->$method();
1076 1076 }
1077 1077
1078   -sub version_from_file { # Method provided for backwards compatability
  1078 +sub version_from_file { # Method provided for backwards compatibility
1079 1079 return Module::Build::ModuleInfo->new_from_file($_[1])->version();
1080 1080 }
1081 1081
1082   -sub find_module_by_name { # Method provided for backwards compatability
  1082 +sub find_module_by_name { # Method provided for backwards compatibility
1083 1083 return Module::Build::ModuleInfo->find_module_by_name(@_[1,2]);
1084 1084 }
1085 1085
@@ -1701,7 +1701,7 @@ sub _read_arg {
1701 1701 }
1702 1702 }
1703 1703
1704   -# decide whether or not an option requires/has an opterand
  1704 +# decide whether or not an option requires/has an operand
1705 1705 sub _optional_arg {
1706 1706 my $self = shift;
1707 1707 my $opt = shift;
@@ -1801,7 +1801,7 @@ sub read_args {
1801 1801 for my $subkey (keys %{$args{$key}}) {
1802 1802 next if !defined $args{$key}{$subkey};
1803 1803 my $subkey_ext = $self->_detildefy($args{$key}{$subkey});
1804   - if ( $subkey eq 'html' ) { # translate for compatability
  1804 + if ( $subkey eq 'html' ) { # translate for compatibility
1805 1805 $args{$key}{binhtml} = $subkey_ext;
1806 1806 $args{$key}{libhtml} = $subkey_ext;
1807 1807 } else {
@@ -3374,7 +3374,7 @@ sub _write_default_maniskip {
3374 3374 \B\.svn\b
3375 3375 \B\.cvsignore$
3376 3376
3377   -# Avoid Makemaker generated and utility files.
  3377 +# Avoid MakeMaker generated and utility files.
3378 3378 \bMakefile$
3379 3379 \bblib
3380 3380 \bMakeMaker-\d
@@ -3382,7 +3382,7 @@ sub _write_default_maniskip {
3382 3382 \bblibdirs$
3383 3383 ^MANIFEST\.SKIP$
3384 3384
3385   -# Avoid VMS specific Makmaker generated files
  3385 +# Avoid VMS specific MakeMaker generated files
3386 3386 \bDescrip.MMS$
3387 3387 \bDESCRIP.MMS$
3388 3388 \bdescrip.mms$
@@ -3435,7 +3435,7 @@ sub ACTION_manifest {
3435 3435 ExtUtils::Manifest::mkmanifest();
3436 3436 }
3437 3437
3438   -# Case insenstive regex for files
  3438 +# Case insensitive regex for files
3439 3439 sub file_qr {
3440 3440 return File::Spec->case_tolerant ? qr($_[0])i : qr($_[0]);
3441 3441 }
@@ -3782,7 +3782,7 @@ sub find_dist_packages {
3782 3782 my @pm_files = grep {exists $dist_files{$_}} keys %{ $self->find_pm_files };
3783 3783
3784 3784 # First, we enumerate all packages & versions,
3785   - # seperating into primary & alternative candidates
  3785 + # separating into primary & alternative candidates
3786 3786 my( %prime, %alt );
3787 3787 foreach my $file (@pm_files) {
3788 3788 next if $dist_files{$file} =~ m{^t/}; # Skip things in t/
@@ -3825,7 +3825,7 @@ sub find_dist_packages {
3825 3825
3826 3826 if ( $result->{err} ) {
3827 3827 # Use the selected primary package, but there are conflicting
3828   - # errors amoung multiple alternative packages that need to be
  3828 + # errors among multiple alternative packages that need to be
3829 3829 # reported
3830 3830 $self->log_warn(
3831 3831 "Found conflicting versions for package '$package'\n" .
@@ -3888,7 +3888,7 @@ sub find_dist_packages {
3888 3888 return \%prime;
3889 3889 }
3890 3890
3891   -# seperate out some of the conflict resolution logic from
  3891 +# separate out some of the conflict resolution logic from
3892 3892 # $self->find_dist_packages(), above, into a helper function.
3893 3893 #
3894 3894 sub _resolve_module_versions {
61 lib/Module/Build/Compat.pm
@@ -398,6 +398,7 @@ sub _is_vms_mms {
398 398 1;
399 399 __END__
400 400
  401 +=for :stopwords passthrough
401 402
402 403 =head1 NAME
403 404
@@ -417,15 +418,15 @@ Module::Build::Compat - Compatibility with ExtUtils::MakeMaker
417 418
418 419 =head1 DESCRIPTION
419 420
420   -Because ExtUtils::MakeMaker has been the standard way to distribute
  421 +Because C<ExtUtils::MakeMaker> has been the standard way to distribute
421 422 modules for a long time, many tools (CPAN.pm, or your system
422   -administrator) may expect to find a working Makefile.PL in every
  423 +administrator) may expect to find a working F<Makefile.PL> in every
423 424 distribution they download from CPAN. If you want to throw them a
424   -bone, you can use Module::Build::Compat to automatically generate a
425   -Makefile.PL for you, in one of several different styles.
  425 +bone, you can use C<Module::Build::Compat> to automatically generate a
  426 +F<Makefile.PL> for you, in one of several different styles.
426 427
427   -Module::Build::Compat also provides some code that helps out the
428   -Makefile.PL at runtime.
  428 +C<Module::Build::Compat> also provides some code that helps out the
  429 +F<Makefile.PL> at runtime.
429 430
430 431
431 432 =head1 METHODS
@@ -434,11 +435,11 @@ Makefile.PL at runtime.
434 435
435 436 =item create_makefile_pl($style, $build)
436 437
437   -Creates a Makefile.PL in the current directory in one of several
438   -styles, based on the supplied Module::Build object C<$build>. This is
  438 +Creates a F<Makefile.PL> in the current directory in one of several
  439 +styles, based on the supplied C<Module::Build> object C<$build>. This is
439 440 typically controlled by passing the desired style as the
440   -C<create_makefile_pl> parameter to Module::Build's C<new()> method;
441   -the Makefile.PL will then be automatically created during the
  441 +C<create_makefile_pl> parameter to C<Module::Build>'s C<new()> method;
  442 +the F<Makefile.PL> will then be automatically created during the
442 443 C<distdir> action.
443 444
444 445 The currently supported styles are:
@@ -447,37 +448,37 @@ The currently supported styles are:
447 448
448 449 =item small
449 450
450   -A small Makefile.PL will be created that passes all functionality
451   -through to the Build.PL script in the same directory. The user must
452   -already have Module::Build installed in order to use this, or else
  451 +A small F<Makefile.PL> will be created that passes all functionality
  452 +through to the F<Build.PL> script in the same directory. The user must
  453 +already have C<Module::Build> installed in order to use this, or else
453 454 they'll get a module-not-found error.
454 455
455 456 =item passthrough
456 457
457   -This is just like the C<small> option above, but if Module::Build is
  458 +This is just like the C<small> option above, but if C<Module::Build> is
458 459 not already installed on the user's system, the script will offer to
459 460 use C<CPAN.pm> to download it and install it before continuing with
460 461 the build.
461 462
462 463 =item traditional
463 464
464   -A Makefile.PL will be created in the "traditional" style, i.e. it will
  465 +A F<Makefile.PL> will be created in the "traditional" style, i.e. it will
465 466 use C<ExtUtils::MakeMaker> and won't rely on C<Module::Build> at all.
466   -In order to create the Makefile.PL, we'll include the C<requires> and
  467 +In order to create the F<Makefile.PL>, we'll include the C<requires> and
467 468 C<build_requires> dependencies as the C<PREREQ_PM> parameter.
468 469
469 470 You don't want to use this style if during the C<perl Build.PL> stage
470 471 you ask the user questions, or do some auto-sensing about the user's
471   -environment, or if you subclass Module::Build to do some
472   -customization, because the vanilla Makefile.PL won't do any of that.
  472 +environment, or if you subclass C<Module::Build> to do some
  473 +customization, because the vanilla F<Makefile.PL> won't do any of that.
473 474
474 475 =back
475 476
476 477 =item run_build_pl(args => \@ARGV)
477 478
478   -This method runs the Build.PL script, passing it any arguments the
  479 +This method runs the F<Build.PL> script, passing it any arguments the
479 480 user may have supplied to the C<perl Makefile.PL> command. Because
480   -ExtUtils::MakeMaker and Module::Build accept different arguments, this
  481 +C<ExtUtils::MakeMaker> and C<Module::Build> accept different arguments, this
481 482 method also performs some translation between the two.
482 483
483 484 C<run_build_pl()> accepts the following named parameters:
@@ -498,8 +499,8 @@ This is the filename of the script to run - it defaults to C<Build.PL>.
498 499
499 500 =item write_makefile()
500 501
501   -This method writes a 'dummy' Makefile that will pass all commands
502   -through to the corresponding Module::Build actions.
  502 +This method writes a 'dummy' F<Makefile> that will pass all commands
  503 +through to the corresponding C<Module::Build> actions.
503 504
504 505 C<write_makefile()> accepts the following named parameters:
505 506
@@ -522,10 +523,10 @@ So, some common scenarios are:
522 523
523 524 =item 1.
524 525
525   -Just include a Build.PL script (without a Makefile.PL
526   -script), and give installation directions in a README or INSTALL
  526 +Just include a F<Build.PL> script (without a F<Makefile.PL>
  527 +script), and give installation directions in a F<README> or F<INSTALL>
527 528 document explaining how to install the module. In particular, explain
528   -that the user must install Module::Build before installing your
  529 +that the user must install C<Module::Build> before installing your
529 530 module.
530 531
531 532 Note that if you do this, you may make things easier for yourself, but
@@ -535,10 +536,10 @@ F<Makefile.PL>/C<ExtUtils::MakeMaker> way of doing things.
535 536
536 537 =item 2.
537 538
538   -Include a Build.PL script and a "traditional" Makefile.PL,
  539 +Include a F<Build.PL> script and a "traditional" F<Makefile.PL>,
539 540 created either manually or with C<create_makefile_pl()>. Users won't
540   -ever have to install Module::Build if they use the Makefile.PL, but
541   -they won't get to take advantage of Module::Build's extra features
  541 +ever have to install C<Module::Build> if they use the F<Makefile.PL>, but
  542 +they won't get to take advantage of C<Module::Build>'s extra features
542 543 either.
543 544
544 545 For good measure, of course, test both the F<Makefile.PL> and the
@@ -546,8 +547,8 @@ F<Build.PL> before shipping.
546 547
547 548 =item 3.
548 549
549   -Include a Build.PL script and a "pass-through" Makefile.PL
550   -built using Module::Build::Compat. This will mean that people can
  550 +Include a F<Build.PL> script and a "pass-through" F<Makefile.PL>
  551 +built using C<Module::Build::Compat>. This will mean that people can
551 552 continue to use the "old" installation commands, and they may never
552 553 notice that it's actually doing something else behind the scenes. It
553 554 will also mean that your installation process is compatible with older
12 lib/Module/Build/Cookbook.pm
@@ -147,15 +147,15 @@ discussion of how installation paths are determined.
147 147 =head2 Installing in the same location as ExtUtils::MakeMaker
148 148
149 149 With the introduction of C<--prefix> in Module::Build 0.28 and
150   -C<INSTALL_BASE> in ExtUtils::MakeMaker 6.31 its easy to get them both
  150 +C<INSTALL_BASE> in C<ExtUtils::MakeMaker> 6.31 its easy to get them both
151 151 to install to the same locations.
152 152
153 153 First, ensure you have at least version 0.28 of Module::Build
154   -installed and 6.31 of ExtUtils::MakeMaker. Prior versions have
  154 +installed and 6.31 of C<ExtUtils::MakeMaker>. Prior versions have
155 155 differing (and in some cases quite strange) installation behaviors.
156 156
157 157 The following installation flags are equivalent between
158   -ExtUtils::MakeMaker and Module::Build.
  158 +C<ExtUtils::MakeMaker> and C<Module::Build>.
159 159
160 160 MakeMaker Module::Build
161 161 PREFIX=... --prefix ...
@@ -168,7 +168,7 @@ ExtUtils::MakeMaker and Module::Build.
168 168 INC=... --extra_compiler_flags ...
169 169 POLLUTE=1 --extra_compiler_flags -DPERL_POLLUTE
170 170
171   -For example, if you are currently installing MakeMaker modules with
  171 +For example, if you are currently installing C<MakeMaker> modules with
172 172 this command:
173 173
174 174 perl Makefile.PL PREFIX=~
@@ -190,7 +190,7 @@ Perl on the same machine. Because of this, it's difficult to document
190 190 where C<prefix> will place your modules.
191 191
192 192 In contrast, C<install_base> has predictable, easy to explain
193   -installation locations. Now that Module::Build and MakeMaker both
  193 +installation locations. Now that C<Module::Build> and C<MakeMaker> both
194 194 have C<install_base> there is little reason to use C<prefix> other
195 195 than to preserve your existing installation locations. If you are
196 196 starting a fresh Perl installation we encourage you to use
@@ -381,7 +381,7 @@ John Peacock, author of the C<SVN-Notify-Mirror> distribution, says:
381 381 modules are available - SVN::Notify::Config and Net::SSH;
382 382
383 383 =item 2. If the S::N::Config module is loaded, I automatically
384   -generate testfiles for it during Build (using the C<PL_files>
  384 +generate test files for it during Build (using the C<PL_files>
385 385 property).
386 386
387 387 =item 3. If the C<ssh_feature> is available, I ask if the user wishes
20 lib/Module/Build/ModuleInfo.pm
@@ -29,7 +29,7 @@ my $VARNAME_REGEXP = qr{ # match fully-qualified VERSION name
29 29 ([\$*]) # sigil - $ or *
30 30 (
31 31 ( # optional leading package name
32   - (?:::|\')? # possibly starting like just :: (ala $::VERSION)
  32 + (?:::|\')? # possibly starting like just :: (la $::VERSION)
33 33 (?:\w+(?:::|\'))* # Foo::Bar:: ...
34 34 )?
35 35 VERSION
@@ -252,7 +252,7 @@ EOM
252 252 $vers{$pkg} = $v;
253 253 push( @pkgs, 'main' );
254 254
255   - # first non-comement line in undeclared packge defines package main
  255 + # first non-comment line in undeclared package defines package main
256 256 } elsif ( !exists($vers{main}) && $pkg eq 'main' && $line =~ /\w+/ ) {
257 257 $need_vers = 1;
258 258 $vers{main} = '';
@@ -371,9 +371,11 @@ sub pod {
371 371
372 372 __END__
373 373
  374 +=for :stopwords ModuleInfo
  375 +
374 376 =head1 NAME
375 377
376   -ModuleInfo - Gather package and POD information from a perl module files
  378 +ModuleInfo - Gather package and POD information from a perl module file
377 379
378 380
379 381 =head1 DESCRIPTION
@@ -382,16 +384,16 @@ ModuleInfo - Gather package and POD information from a perl module files
382 384
383 385 =item new_from_file($filename, collect_pod => 1)
384 386
385   -Construct a ModuleInfo object given the path to a file. Takes an optional
386   -arguement C<collect_pod> which is a boolean that determines whether
  387 +Construct a C<ModuleInfo> object given the path to a file. Takes an optional
  388 +argument C<collect_pod> which is a boolean that determines whether
387 389 POD data is collected and stored for reference. POD data is not
388 390 collected by default. POD headings are always collected.
389 391
390 392 =item new_from_module($module, collect_pod => 1, inc => \@dirs)
391 393
392   -Construct a ModuleInfo object given a module or package name. In addition
  394 +Construct a C<ModuleInfo> object given a module or package name. In addition
393 395 to accepting the C<collect_pod> argument as described above, this
394   -method accepts a C<inc> arguemnt which is a reference to an array of
  396 +method accepts a C<inc> argument which is a reference to an array of
395 397 of directories to search for the module. If none are given, the
396 398 default is @INC.
397 399
@@ -432,7 +434,7 @@ Returns the POD data in the given section.
432 434 =item find_module_by_name($module, \@dirs)
433 435
434 436 Returns the path to a module given the module or package name. A list
435   -of directories can be passed in as an optional paramater, otherwise
  437 +of directories can be passed in as an optional parameter, otherwise
436 438 @INC is searched.
437 439
438 440 Can be called as either an object or a class method.
@@ -441,7 +443,7 @@ Can be called as either an object or a class method.
441 443
442 444 Returns the entry in C<@dirs> (or C<@INC> by default) that contains
443 445 the module C<$module>. A list of directories can be passed in as an
444   -optional paramater, otherwise @INC is searched.
  446 +optional parameter, otherwise @INC is searched.
445 447
446 448 Can be called as either an object or a class method.
447 449
2  lib/Module/Build/Platform/MacOS.pm
@@ -111,7 +111,7 @@ The sole purpose of this module is to inherit from
111 111 C<Module::Build::Base> and override a few methods. Please see
112 112 L<Module::Build> for the docs.
113 113
114   -=head2 Overriden Methods
  114 +=head2 Overridden Methods
115 115
116 116 =over 4
117 117
2  lib/Module/Build/Platform/VMS.pm
@@ -357,7 +357,7 @@ sub _detildefy {
357 357 # Remove the tilde
358 358 $spec =~ s/^~//;
359 359
360   - # Remove any slash folloing the tilde if present.
  360 + # Remove any slash following the tilde if present.
361 361 $spec =~ s#^/##;
362 362
363 363 # break up the paths for the merge
4 lib/Module/Build/Platform/Windows.pm
@@ -43,7 +43,7 @@ sub ACTION_realclean {
43 43 my $full_progname = $0;
44 44 $full_progname =~ s/(?:\.bat)?$/.bat/i;
45 45
46   - # Vodoo required to have a batch file delete itself without error;
  46 + # Voodoo required to have a batch file delete itself without error;
47 47 # Syntax differs between 9x & NT: the later requires a null arg (???)
48 48 require Win32;
49 49 my $null_arg = (Win32::IsWinNT()) ? '""' : '';
@@ -90,7 +90,7 @@ sub make_executable {
90 90 }
91 91
92 92 # This routine was copied almost verbatim from the 'pl2bat' utility
93   -# distributed with perl. It requires too much vodoo with shell quoting
  93 +# distributed with perl. It requires too much voodoo with shell quoting
94 94 # differences and shortcomings between the various flavors of Windows
95 95 # to reliably shell out
96 96 sub pl2bat {
2  lib/Module/Build/YAML.pm
@@ -141,7 +141,7 @@ Module::Build::YAML - Provides just enough YAML support so that Module::Build wo
141 141
142 142 Provides just enough YAML support so that Module::Build works even if YAML.pm is not installed.
143 143
144   -Currently, this amounts to the ability to write META.yml files when "perl Build distmeta"
  144 +Currently, this amounts to the ability to write META.yml files when C<perl Build distmeta>
145 145 is executed via the Dump() and DumpFile() functions/methods.
146 146
147 147 =head1 AUTHOR
6 t/lib/DistGen.pm
@@ -278,8 +278,8 @@ sub regen {
278 278 if ( $opts{clean} ) {
279 279 $self->clean() if -d $dist_dirname;
280 280 } else {
281   - # TODO: This might leave dangling directories. Eg if the removed file
282   - # is 'lib/Simple/Simon.pm', The directory 'lib/Simple' will be left
  281 + # TODO: This might leave dangling directories; e.g. if the removed file
  282 + # is 'lib/Simple/Simon.pm', the directory 'lib/Simple' will be left
283 283 # even if there are no files left in it. However, clean() will remove it.
284 284 my @files = keys %{$self->{pending}{remove}};
285 285 foreach my $file ( @files ) {
@@ -598,7 +598,7 @@ Removes the entire distribution directory.
598 598 =head2 Editing Files
599 599
600 600 Note that C<$filename> should always be specified with unix-style paths,
601   -and are relative to the distribution root directory. Eg 'lib/Module.pm'
  601 +and are relative to the distribution root directory, e.g. C<lib/Module.pm>.
602 602
603 603 No filesystem action is performed until the distribution is regenerated.
604 604
2  t/moduleinfo.t
@@ -54,7 +54,7 @@ my @modules = (
54 54 package Simple;
55 55 our $VERSION = '1.23';
56 56 ---
57   - <<'---', # declared & defined on seperate lines with 'our'
  57 + <<'---', # declared & defined on separate lines with 'our'
58 58 package Simple;
59 59 our $VERSION;
60 60 $VERSION = '1.23';

0 comments on commit f09c707

Please sign in to comment.
Something went wrong with that request. Please try again.