Front page | perl.perl5.porters |
Postings from April 2003
"Sean M. Burke" <sburke@cpan.org> writes:
> At 4/26/2003 09:01 PM +0200, Slaven Rezic wrote:
> >I really like the HISTORY section which occurs on almost every BSD
> >manpage. [...] I think it would be very useful to have this section as a
> >standard in perl's Pod pages. [...]
>
> So, not in the perl*.pod pages, but in the modules in the standard dist?
> It's not a bad idea, but I'm not quite sure what problem it's meant to
> solve. (That's to say nothing of how exactly one makes a
> section "standard" in Pod.)
It's to help module and script authors to preserve backward
compatibility. It seems easier than grepping through all
perldelta*.pod pages.
> Also, are you asking this on other lists? As much as I am loathe to refer
> anyone to p5p, maybe this question should be posted there.
>
This mail goes now also to p5p. The original article was:
| I really like the HISTORY section which occurs on almost every BSD
| manpage. Some examples:
|
| (from err(3))
| HISTORY
| The err() and warn() functions first appeared in 4.4BSD. The
| err_set_exit() and err_set_file() functions first appeared in
| FreeBSD 2.1. The errc() and warnc() functions first appeared in
| FreeBSD 3.0.
|
| (from fork(2))
| HISTORY
| A fork() function call appeared in Version 6 AT&T UNIX.
|
| I think it would be very useful to have this section as a standard in
| perl's Pod pages. As a first step the information from
| Module::CoreList (which standard modules occurred in which perl
| distributions) could be used to autogenerate HISTORY sections in
| standard perl modules, e.g.
|
| (for Storable)
| HISTORY
| Storable is part of the standard perl distribution since 5.7.3.
|
| Later some *important* module API changes (not every little bugfix)
| could be manually added to the HISTORY section.
Regards,
Slaven
--
Slaven Rezic - slaven@rezic.de
babybike - routeplanner for cyclists in Berlin
handheld (e.g. Compaq iPAQ with Linux) version of bbbike
http://bbbike.sourceforge.net
Thread Previous