summaryrefslogtreecommitdiff
path: root/installhtml
diff options
context:
space:
mode:
authorJames E Keenan <jkeenan@cpan.org>2021-08-23 16:35:51 +0000
committerJames E Keenan <jkeenan@cpan.org>2021-09-11 13:30:47 +0000
commitf5e0f10e7065bfa21679406e5c9a604536f75585 (patch)
treee028dff2d4ea664f432adba57e5b941a6f9cf1e7 /installhtml
parent34aa3576a14efea0cbd14b0c0965b70ee9448535 (diff)
downloadperl-f5e0f10e7065bfa21679406e5c9a604536f75585.tar.gz
installhtml: set default podpath to './lib'
Previously (as reported nine years ago by Nick Clark in what is now https://github.com/Perl/perl5/issues/11859), the default setting for 'podpath' was '.'. This meant that, unless you explicitly set a colon-delimited list of directories as the value for 'podpath', all files containing POD under '.' were HTML-ified and installed. The only directories that always should have HTML-ized POD installed are 'lib' and 'pod' itself. Invoking 'installhtml' like the following should now DTRT: export HTMLDIR=$HOMEDIR/tmp/installhtml && \ ./perl -Ilib ./installhtml \ --htmldir=$HTMLDIR \ --htmlroot=$HTMLDIR \ --splithead=pod/perlipc \ --recurse \ --verbose 2>&1 | tee installhtml.log
Diffstat (limited to 'installhtml')
-rw-r--r--installhtml6
1 files changed, 3 insertions, 3 deletions
diff --git a/installhtml b/installhtml
index afb946198d..13d811fc98 100644
--- a/installhtml
+++ b/installhtml
@@ -46,7 +46,7 @@ Default is current directory.
=item B<--podpath> POD search path
The list of directories to search for .pod and .pm files to be converted.
-Default is 'podroot/.'.
+Default is 'podroot/lib'.
=item B<--recurse> recurse on subdirectories
@@ -122,7 +122,7 @@ Usage: $0 --help --podpath=<name>:...:<name> --podroot=<name>
--help - this message
--podpath - colon-separated list of directories containing .pod and
- .pm files to be converted (. by default).
+ .pm files to be converted ('lib/' by default).
--podroot - filesystem base directory from which all relative paths in
podpath stem (default is .).
--htmldir - directory to store resulting html files in relative
@@ -147,7 +147,7 @@ END_OF_USAGE
my (@podpath, $podroot, $htmldir, $htmlroot, $recurse, @splithead,
@splititem, $splitpod, $verbose, $pod2html, @ignore);
-@podpath = ( "." ); # colon-separated list of directories containing .pod
+@podpath = ( "lib" ); # colon-separated list of directories containing .pod
# and .pm files to be converted.
$podroot = "."; # assume the pods we want are here
$htmldir = ""; # nothing for now...