perl5
perl5 copied to clipboard
Add known problems with `class` feature to perldelta
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.
I'm not sure perldelta is really the right place for this.
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.
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.
We don't usually update perldelta like that (except minor edits like typos and broken links). Perhaps perlexperimental is a more logical place.
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?
@leonerd probably some ideas about where the best place would be
I imagine a "KNOWN BUGS" section in perlclass.pod would be handy.
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?