Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

installhtml installs private pod #11859

Closed
p5pRT opened this issue Jan 10, 2012 · 9 comments
Closed

installhtml installs private pod #11859

p5pRT opened this issue Jan 10, 2012 · 9 comments
Assignees
Labels
distro-All installhtml Problems with 'installhtml' program or 'make' target type-utilities

Comments

@p5pRT
Copy link

p5pRT commented Jan 10, 2012

Migrated from rt.perl.org#107880 (status was 'open')

Searchable as RT107880$

@p5pRT
Copy link
Author

p5pRT commented Jan 10, 2012

From @nwc10

./installhtml is installing pod that it isn't meant to.

$ cd /home/nick/Sandpit/snap-v5.15.6-450-g6ca15f9/lib/perl5/5.15.6/html
$ ls -l lib/XS/*.html Porting/*
-rw-r--r-- 1 nick nick 847 Jan 10 18​:21 Porting/GitUtils.html
-rw-r--r-- 1 nick nick 105825 Jan 10 18​:21 Porting/epigraphs.html
-rw-r--r-- 1 nick nick 12274 Jan 10 18​:21 Porting/how_to_write_a_perldelta.html
-rw-r--r-- 1 nick nick 15160 Jan 10 18​:21 Porting/perldelta_template.html
-rw-r--r-- 1 nick nick 49944 Jan 10 18​:21 Porting/release_managers_guide.html
-rw-r--r-- 1 nick nick 5635 Jan 10 18​:21 Porting/release_schedule.html
-rw-r--r-- 1 nick nick 9614 Jan 10 18​:30 lib/XS/APItest.html
-rw-r--r-- 1 nick nick 2477 Jan 10 18​:30 lib/XS/Typemap.html

None of these should be installed, given that installperl installs none of
their raw Pods, and installman installs none of them as man pages.

Probably installhtml should be refactored to use the same exclusion lists
as installman, by calling pods_to_install() in Porting/pod_lib.pl

I don't know if this is a regression from perl 5.14.0

Nicholas Clark

@p5pRT
Copy link
Author

p5pRT commented Feb 7, 2012

From @nwc10

On Tue Jan 10 11​:28​:11 2012, nicholas wrote​:

./installhtml is installing pod that it isn't meant to.

$ cd /home/nick/Sandpit/snap-v5.15.6-450-
g6ca15f9/lib/perl5/5.15.6/html
$ ls -l lib/XS/*.html Porting/*

and TestInit.html, from TestInit.pm

Likely this is all a side effect of it scanning from the top of the
distribution tree, instead of from lib/

Nicholas Clark

@p5pRT
Copy link
Author

p5pRT commented Feb 7, 2012

@nwc10 - Status changed from 'new' to 'open'

@p5pRT
Copy link
Author

p5pRT commented Jul 23, 2012

From @jkeenan

Another potential problem with 'installhtml' has been described in #12257

@jkeenan jkeenan added the installhtml Problems with 'installhtml' program or 'make' target label Jan 31, 2021
@jkeenan
Copy link
Contributor

jkeenan commented Jan 31, 2021

Back in 2012, @nwc10 was reporting that the following files should not have been installed:

$ ls -l lib/XS/*.html Porting/*
-rw-r--r-- 1 nick nick 847 Jan 10 18​:21 Porting/GitUtils.html
-rw-r--r-- 1 nick nick 105825 Jan 10 18​:21 Porting/epigraphs.html
-rw-r--r-- 1 nick nick 12274 Jan 10 18​:21 Porting/how_to_write_a_perldelta.html
-rw-r--r-- 1 nick nick 15160 Jan 10 18​:21 Porting/perldelta_template.html
-rw-r--r-- 1 nick nick 49944 Jan 10 18​:21 Porting/release_managers_guide.html
-rw-r--r-- 1 nick nick 5635 Jan 10 18​:21 Porting/release_schedule.html
-rw-r--r-- 1 nick nick 9614 Jan 10 18​:30 lib/XS/APItest.html
-rw-r--r-- 1 nick nick 2477 Jan 10 18​:30 lib/XS/Typemap.html

and

and TestInit.html, from ./TestInit.pm

Attempting to understand this problem (I don't customarily use installhtml for anything), this evening I installed blead into $TESTINGDIR, then used this command:

perl $SECONDARY_CHECKOUT_DIR/installhtml \
  --podroot=$TESTINGDIR/blead     \
  --htmldir=/tmp/gh-11859-html     \
  --htmlroot=/tmp/gh-11859-html    \
  --recurse \
  --verbose

I got 858 .html files installed under /tmp/gh-11859-html/lib/perl5/5.33.7. But I didn't get any among those Nick listed.

Have I invoked installhtml plausibly? If so, can we close this ticket on the assumption that the problem was fixed somewhere along the line?

Thank you very much.
Jim Keenan

@jkeenan jkeenan added the Closable? We might be able to close this ticket, but we need to check with the reporter label Jan 31, 2021
jkeenan added a commit to jkeenan/perl5 that referenced this issue Aug 23, 2021
This will facilitate debugging of tickets like
Perl#19052 and
Perl#11859.
jkeenan added a commit to jkeenan/perl5 that referenced this issue Aug 23, 2021
Previously (as reported nine years ago by Nick Clark in what is now
Perl#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
@jkeenan jkeenan removed documentation Closable? We might be able to close this ticket, but we need to check with the reporter labels Aug 23, 2021
@jkeenan
Copy link
Contributor

jkeenan commented Aug 23, 2021

Should be addressed by #19075.

@jkeenan
Copy link
Contributor

jkeenan commented Sep 4, 2021

Should be addressed by #19075.

Am taking this ticket for the purpose of closing it within 7 days unless we hear otherwise from @nwc10 or others.

@jkeenan jkeenan self-assigned this Sep 4, 2021
@jkeenan jkeenan added the Closable? We might be able to close this ticket, but we need to check with the reporter label Sep 4, 2021
@jkeenan
Copy link
Contributor

jkeenan commented Sep 4, 2021

Should be addressed by #19075.

Am taking this ticket for the purpose of closing it within 7 days unless we hear otherwise from @nwc10 or others.

CORRECTION: There's a pull request needing review for this issue.

@jkeenan jkeenan removed the Closable? We might be able to close this ticket, but we need to check with the reporter label Sep 4, 2021
jkeenan added a commit that referenced this issue Sep 11, 2021
This will facilitate debugging of tickets like
#19052 and
#11859.
jkeenan added a commit that referenced this issue Sep 11, 2021
Previously (as reported nine years ago by Nick Clark in what is now
#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
@jkeenan
Copy link
Contributor

jkeenan commented Sep 11, 2021

Should be addressed by #19075.

Am taking this ticket for the purpose of closing it within 7 days unless we hear otherwise from @nwc10 or others.

CORRECTION: There's a pull request needing review for this issue.

The code for #19075 has been merged into blead. That should resolve this ticket.

Thank you very much.
Jim Keenan

@jkeenan jkeenan closed this as completed Sep 11, 2021
nicomen pushed a commit to nicomen/pumpkin-perl that referenced this issue Oct 11, 2021
This will facilitate debugging of tickets like
Perl/perl5#19052 and
Perl/perl5#11859.
nicomen pushed a commit to nicomen/pumpkin-perl that referenced this issue Oct 11, 2021
Previously (as reported nine years ago by Nick Clark in what is now
Perl/perl5#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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
distro-All installhtml Problems with 'installhtml' program or 'make' target type-utilities
Projects
None yet
Development

No branches or pull requests

2 participants