-
Notifications
You must be signed in to change notification settings - Fork 2
perlclass: work out the initial document structure #25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
bcb8f7e to
7b073f3
Compare
7b073f3 to
06162c8
Compare
|
I have studied test cases in This document should look much better now. |
06162c8 to
bc6d23c
Compare
|
I think that doc looks good to start with. I'll try to merge it in for now and have a go at continuing to adjust and edit it as I go. Many thanks. I think attempting to "merge" this PR exactly will probably break a lot of things due to the rebasing history, so I'll probably just cherrypick out that one commit that actually added the doc. |
|
@leonerd no worries, I just rebased myself. Should be good to just merge now |
bc6d23c to
9a9d319
Compare
|
Looks like it got cherry picked anyway - closing |
v6.0.0 - 2024-07-10 - Drop support for Perl 5.10. podlators now requires Perl 5.12 or later. - podlators now uses semantic versioning for the package and module versions, with a v prefix to work with Perl's packaging system. - Pod::Man now translates all "-" characters in the input into *roff "\-" escapes (normally rendered as an ASCII hyphen-minus, U+002D) rather than using fragile heuristics to decide which characters represent true hyphens and which represent ASCII hyphen-minus. The previous heuristics misrendered command names such as apt-get, causing search and cut-and-paste issues. This change may cause line-break issues with long hyphenated phrases. In cases where the intent is a true hyphen, consider using UTF-8 as the POD character set (declared with =encoding) and using true Unicode hyphens instead of the ASCII "-" character. - Pod::Man now disables the special *roff interpretation of "`" and "'" characters as paired quotes everywhere, not just in verbatim text, thus forcing them to be interpreted as the regular ASCII characters. This also disables the use of "``" and "''" for paired double-quotes. The rationale is similar to that for hyphens: there is no way to tell from the POD source that the special interpretation as quotes is intended. To produce paired typographic quotes in the output, use UTF-8 and Unicode paired quote characters. - Man page references in L<> that are detected as such by Pod::Simple are now always formatted as man page references even if our normal heuristic would not detect them. This fixes the formatting of constructions such as @@RXVT_NAME@@Perl(3), which are used by packages that format a man page with POD and then substitute variables into it at build time. Thanks to Marco Sirabella for the analysis and an initial patch. (GitHub #21) - Add a workaround to Pod::Man to force persistent ragged-right justification under nroff with groff 1.23.0. Thanks to Guillem Jover for the report and G. Branden Robinson for the analysis. (GitHub Perl#23) - Fix wrapping of text with S<> markup in all subclasses of Pod::Text. Thanks to Jim Avera for the report. (GitHub #24) - Pod::Man now forces a blank line after a nested list contains only =item tags without bodies. In previous versions, the blank line before the next item in the surrounding =over block was not included. Thanks to Julien ÉLIE for the report. (GitHub #26) - Import PerlIO before checking for layers so that PerlIO::F_UTF8 is available, which fixes double-encoding of output when a :utf8 layer is in place and PerlIO is not imported. Thanks to youpong for the bug report, James Keenan for the elaboration, and Graham Knop for the fix. (GitHub #25) - pod2text --help now exits with status 0, not 1, matching normal UNIX command behavior and the behavior of pod2man. (GitHub #19) - Fix tests when NO_COLOR is set in the environment. (GitHub #20) v6.0.1 - 2024-07-12 - Remove autodie from the module build process. When built as part of Perl core, podlators is built before autodie is available. Thanks to James E Keenan for the report and a draft patch. (GitHub Perl#33) v6.0.2 - 2024-07-14 - Fix removal of scripts/pod2man and scripts/pod2text by make realclean, broken in the v6.0.0 release. Thanks to James E Keenan for the report.
Some parts of what I wrote probably are not true. Other parts surely need more clarification. However, I think it's a good start.