POD2TEST(1p)

📦
version 1.20 · 3 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💅 POD2TEST(1p) — bestie, we're so back (but also, we're deprecated 😭)

okay so hi. this is the manual page for pod2test, a lil Perl script living in the User Contributed Perl Documentation section of your man pages, section 1p. it's giving ✨legacy✨ and honestly? iconic behaviour. let's get into it.

🌸 NAME 🌸

pod2test — (DEPRECATED) Convert embedded tests and code examples to .t files

like... it takes your tests and your example code that are chillin' inside your POD, and it turns them into actual .t files. yes queen, that's the whole job. deprecated though, so keep that in mind, bestie 🫶

🎀 SYNOPSIS 🎀

pod2test [-Mmodule] [input [output]]

short. sweet. slay. 💅

✨ DESCRIPTION ✨

okay so pod2test is a front-end for Pod::Tests (which used to be called Test::Inline 1, throwback fr fr). what it does is it generates TAP-compatible .t testing scripts from your embedded tests and your code examples. no cap. 🧚

here's the tea on where everything goes:

  • if output is not specified, the resulting .t file goes straight to STDOUT 💫
  • otherwise, it goes to the output file you gave it
  • if input is not given, it will draw from STDIN 🫶

and now the sad part 😭 if the file you gave it contains no tests and no code examples, then:

  • no output will be given
  • no output file will be created
  • and pod2test will exit with 1

so like, it just leaves. no note. no text back. 💀

also! the Test::More module is made available to the testing blocks using the 'no_plan' feature. any further modules that should be used are specified with -M. UNIMPLEMENTED — yes bestie, that's literally all it says, i'm not making that up, it's in the source. 🙈

💀 BUGS and CAVEATS 💀

this is a very simple rough cut, okay? it only does very rudimentary tests on the examples. that's it. that's the vibe. it's giving "we'll fix it later" and later never came. 🔥

🌈 SUPPORT 🌈

so this script has been superceded by "inline2test" from the newer Test::Inline 2. moving on up, we love to see it ✨

the good news: most testing code that currently works with "pod2test" should continue to work with the new version. ate.

the notable exceptions are "=for begin" and "=for end" — those are deprecated in the newer version. so if you're leaning on those, heads up, bestie. 😭

after upgrading Test::Inline, Pod::Tests and "pod2test" were split out to provide a compatibility package for legacy code. that's the whole origin story. 🫶

"pod2test" will stay in CPAN, but it should remain unchanged indefinately, with the exception of any minor bugs that will require squishing. (yes, "indefinately" — that's how it's spelled in the original and i am nothing if not faithful to the text 💅)

bugs in this dist should be reported via the following URL. feature requests should not be submitted, as further development is now occuring in Test::Inline. 🚫

<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Tests>

not me telling you to read the rules, but like... read the rules bestie. bugs only. no feature requests. periodt. 👑

👑 AUTHOR 👑

  • Michael G Schwern <schwern@pobox.com>
  • Adam Kennedy <adamk@cpan.org>

legends. both of them. 💜

🔥 SEE ALSO 🔥

  • Pod::Tests
  • Test::Inline

go read those if you wanna know the lore, iykyk 🦋

  • Copyright 2005 - 2008 Adam Kennedy.
  • Copyright 2001 - 2003 Michael G Schwern.

this program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. 🌸

the full text of the license can be found in the LICENSE file included with this module.

and that's the whole page, bestie!! this was generated from perl v5.38.2 and dated 2024-02-21, so like... this manual page is a lil vintage, and honestly? vintage is a vibe. 🎀 now go forth and convert your embedded tests, you gorgeous genius. mwah. 💅✨
📦 where this page comes from