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
Pod::Checker should be switched to use Pod::Simple #12716
Comments
From @rjbsCreated by @rjbsPod::Checker should be rewritten/reworked to use Pod::Simple exclusively, This work was done, in great part, by Marc Green. It needs to be finished, Perl Info
|
From @rjbsA few months ago, I posted a notice about some of this work: http://markmail.org/thread/wwuo7gkjbaef6y6s The biggest problem right now is that the Pod::Checker code is "acting weird" with the "garbled I have pushed a lousy "shove all Marc's work into the dist" here: https://github.com/rjbs/Pod-Checker/commits/pod-simple-checker Once that's done, the next steps are to release it to CPAN and to bring it into a branch in core. I expect there will be some bitrot! :-( We'll need to get porting/podcheck.t passing with the new Pod-Checker before it can be cored. -- |
From [Unknown Contact. See original ticket]A few months ago, I posted a notice about some of this work: http://markmail.org/thread/wwuo7gkjbaef6y6s The biggest problem right now is that the Pod::Checker code is "acting weird" with the "garbled I have pushed a lousy "shove all Marc's work into the dist" here: https://github.com/rjbs/Pod-Checker/commits/pod-simple-checker Once that's done, the next steps are to release it to CPAN and to bring it into a branch in core. I expect there will be some bitrot! :-( We'll need to get porting/podcheck.t passing with the new Pod-Checker before it can be cored. -- |
@rjbs - Status changed from 'new' to 'open' |
From @jkeenanOn Mon Mar 18 19:51:02 2013, rjbs wrote:
rjbs: When I go to http://cpansearch.perl.org/src/MAREKR/Pod-Checker-1.71/lib/Pod/Checker.pm, I read in the documentation: ##### If so, what is left to do on this ticket? Thank you very much. |
From @rjbs* James E Keenan via RT <perlbug-followup@perl.org> [2014-08-08T20:40:25]
Note that latest isn't in core. And if you import it, everything breaks. Importing it without everything breaking is what is left to do. -- |
From @jkeenanOn Fri Aug 08 17:54:32 2014, rjbs wrote:
If by "everything breaks", you mean that t/porting/podcheck.t fails even to compile, then I see your point.
I've been staring at this ticket for several days. The work involved in adapting podcheck.t to using a Pod::Simple-based Pod::Checker rather than a Pod::Parser-based Pod::Checker is non-trivial. This is so for a number of reasons: * podcheck.t is really three programs in one: a program to test the validity of POD in the core distribution and two programs to modify a database of "known issues". The three programs co-exist in one file by means of different command-line options. Speaking for myself, that's too many things for one file to do in a maintainable way. Moreover, I believe that in Perl, a file whose name ends in ".t" should be a test file and nothing but a test file. It should not also be a file that changes the state of files distributed with core; the ".pl" extension should be used for that. If some of the code in podcheck.t is used by more than one of the three variants, it should be refactored out into a module. * podcheck.t has dependencies on Pod::Parser in two different areas. A subroutine called extract_pod() explicitly calls Pod::Parser::new() and Pod::Parser::parse_from_filehandle(). But parse_from_filehandle() is also invoked inside internal package My::Pod::Parser, which is the location where podcheck.t's dependency on the "old" Pod::Checker -- the version currently found in core -- is greatest. * podcheck.t invokes Pod::Checker methods which are not found in the latest version of Pod::Checker on CPAN. So we not only have to remove all dependencies on Pod::Parser; we have to remove all dependencies on methods no longer offered by Pod::Checker. * podcheck.t simply attempts to do much, much more than apply the "podchecker" utility to a file in the core distribution -- regardless of whether that "podchecker" is based on the "old" Pod::Checker (Pod::Parser-based) or the "new" Pod::Checker (Pod::Simple-based). Before investing a lot of time in refactoring, however, I would like to know if others agree with the analysis I have presented. Thank you very much. |
From @khwilliamsonOn 08/10/2014 07:53 PM, James E Keenan via RT wrote:
I'm not sure what I think about the separating out or not; so I guess I thought there was more to do than rjbs indicated. I had been planning There is a version of podcheck.t that inherits from Pod::Simple. It's |
From @jkeenanOn Mon Aug 11 10:41:09 2014, public@khwilliamson.com wrote:
Do you know where that version of podcheck.t is available?
I'm glad you mentioned that. If we were able to replace the current, Pod::Parser-based extract_pod() subroutine with one based on Pod::Simple, we'd be halfway there. But when I looked at Pod::Simple yesterday, I didn't see any obvious way to simply extract the POD from a file and get it back as a single string. Thank you very much. |
From @jkeenanOn Sun Aug 10 18:53:29 2014, jkeenan wrote:
Today, for reasons that are not clear, t/porting/podcheck.t in blead *does* compile for me. ##### $ ./perl -Ilib -c t/porting/podcheck.t |
From @khwilliamsonOn Mon Aug 11 17:46:37 2014, jkeenan wrote:
It should compile unless you remove Pod::Checker, so I don't understand. |
From @jkeenanOn Mon Aug 11 18:25:56 2014, khw wrote:
Error on my part: I was switching between branches without re-compiling. Please ignore. |
From @khwilliamsonOn 08/11/2014 12:39 PM, James E Keenan via RT wrote:
There's been a significant amount of bit rot, and I don't have many |
From @khwilliamsonThis has been fixed by 1f44a80 |
@khwilliamson - Status changed from 'open' to 'pending release' |
From @rjbsOn Fri May 27 11:09:06 2016, khw wrote:
Thanks, Karl! I know that this was a bunch of unglamorous work that won't get oohs and aahs from most future users, and also that I found it tedious enough that I trailed off partway through. I appreciate you picking up the ball and getting it across the finish line! -- |
From @jkeenanOn Fri May 27 15:29:54 2016, rjbs wrote:
I second rjbs's gratitude; this was a major refactoring effort! -- |
From @xsawyerxOn 05/28/2016 01:44 AM, James E Keenan via RT wrote:
Having seen some of the work from the side-lines until of late, I third |
From @khwilliamsonThank you for filing this report. You have helped make Perl better. With the release today of Perl 5.26.0, this and 210 other issues have been Perl 5.26.0 may be downloaded via: If you find that the problem persists, feel free to reopen this ticket. |
@khwilliamson - Status changed from 'pending release' to 'resolved' |
Migrated from rt.perl.org#116467 (status was 'resolved')
Searchable as RT116467$
The text was updated successfully, but these errors were encountered: