develooper Front page | perl.perl5.porters | Postings from April 2011

Re: Editing old perldelta's to fix broken links

Jesse Vincent
April 27, 2011 00:42
Re: Editing old perldelta's to fix broken links
Message ID:

On Mon 25.Apr'11 at  9:41:11 -0600, Karl Williamson wrote:
> Some people believe that old perldeltas should never be modified.
> But what to do when a change external to them causes a broken link.
> For example, perlrepository no longer exists, or the name of an
> =head has changed?

Correcting old perldelta files to fix dangerous factual errors makes
sense.  I'm not acutally sure that it's worthwhile to go through and 
fix the name of every POD we remove after the fact.

Editing to correct the name of an =head makes some sense. 

Editing to replace perlrepository with perlgit in historical deltas
leads to weird problems, like what to do about the entry announcing that
perlrepository.pod came into being.  The files are, after all,
descriptions of what changed between those two historical releases.

In general, I'm not sure that it's worth the effort to update old
perldeltas instead of spending that effort on the living docs, but I
don't think it's desperately wrong to do so.

-Jesse Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About