perl5 icon indicating copy to clipboard operation
perl5 copied to clipboard

Add known problems with `class` feature to perldelta

Open johannessen opened this issue 1 year ago • 1 comments

When the experimental class feature was added in v5.38, it had some known problems that could cause segmentation faults, including #20956, #20947, and #20890 (duplicate: #21221).

As these issues persist to this day, I think they should be mentioned somewhere in Perl’s documentation. This change adds them to perl5380delta, and includes a brief erratum in the new v5.40 perldelta.

johannessen avatar May 25 '24 13:05 johannessen

I'm not sure perldelta is really the right place for this.

Leont avatar May 25 '24 13:05 Leont

Good to know about those specific cases.

Since there's no perlbugs, I'd go to perldelta by default to check the status for v5.38 updates, as a user.

rwp0 avatar May 26 '24 16:05 rwp0

The description of the ā€Known Problemsā€ section in perldelta_template.pod is as follows:

XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any tests that had to be TODOed for the release would be noted here. Unfixed platform specific bugs also go here.

There is certainly room to split some hairs about what exactly this language means. But I think it’s not meant to be exclusive.

The way I see it, the intention is that any unfixed platform-agnostic bugs which simply happen to not have TODO tests yet should indeed be listed as ā€œknown problems,ā€ too.

johannessen avatar May 26 '24 16:05 johannessen

We don't usually update perldelta like that (except minor edits like typos and broken links). Perhaps perlexperimental is a more logical place.

Leont avatar May 26 '24 18:05 Leont

I see your point, but a ā€œKNOWN PROBLEMSā€ section in perlexperiment might imply to readers that all known issues for experiments are listed. I’m not in a position to produce such a comprehensive list.

I suppose adding a ā€œBUGSā€ section to perlclass might work, plus a pointer in the new 5.40 perldelta for ā€œupdated documentation.ā€ Would that be more appropriate?

johannessen avatar May 26 '24 21:05 johannessen

@leonerd probably some ideas about where the best place would be

Leont avatar May 26 '24 21:05 Leont

I imagine a "KNOWN BUGS" section in perlclass.pod would be handy.

leonerd avatar May 30 '24 15:05 leonerd

Thank you all for your guidance! PR updated.

I’m not sure how much detail I should go into when describing the issues in perlclass.pod. I’ve opted for just a brief summary plus a GH link. Is that appropriate here?

johannessen avatar May 30 '24 19:05 johannessen