RFC 286 (v1) Add a "emit pod" runtime option to Perl

[email protected] (Perl6 RFC Librarian) 25 Sep 2000 06:00:35 -0000
Newsgroups perl.perl6.stdlib,perl.perl6.announce.rfc
Message-ID <[email protected]>
This and other RFCs are available on the web at
  http://dev.perl.org/rfc/

=head1 TITLE

Add a "emit pod" runtime option to Perl

=head1 VERSION

  Maintainer: Adam Turoff <[email protected]>
  Date: 24 Sep 2000
  Mailing List: [email protected]
  Number: 286
  Version: 1
  Status: Developing

=head1 ABSTRACT

It would be really handy if there were a core mechanism to emit the
documentation embedded in a Perl program/module.

=head1 DESCRIPTION

Tom Christiansen proposed this in his perl6storm message:

	=item perl6storm #0004

	Need perl to spit out pod/non-pod, like cc -E.  Pod is too hard to parse.
	This would make catpod trivially implemented as a compiler filter.

This feature would be quite useful, aside from just Tom's example of 'catpod'.

=head1 IMPLEMENTATION

Many options exist, including mucking around with the core to have a simple
commandline flag (e.g. C<perl -E>)

The most sensible implementation would be to write a standard module
that was a compiler backend, and invoked easliy, as in:

	perl -MPOD -e "emit()" *.pl *.pm t/*.t

=head1 REFERENCES

perl6storm