Merge the development deltas into a single perldelta #23842
Conversation
|
There is some work needed still:
|
book
force-pushed
the
book/merge-deltas
branch
from
cbba49e to
caf6318
Compare
book
force-pushed
the
book/merge-deltas
branch
2 times, most recently
from
e6654a9 to
f2b5442
Compare
|
I've dropped all previous changes, and went for a much simpler approach: just copy every relevant section from each development delta into the final one. This leaves more editing work to the release manager, but still removes the tedious and error-prone copy/pasting step (which was the original goal before I got carried away). It also avoids issues when the section being copied does not look exactly as expected and might be incompletely copied into the master document. |
book
force-pushed
the
book/merge-deltas
branch
from
f2b5442 to
29caac4
Compare
|
And this new version removes unmodified template sections from the final document. |
For now, the script simply copies the content of each relevant section into the same one in the master document (pod/perldelta.pod). It will die when encountering an unexpected =head1 header.
ericherman
force-pushed
the
book/merge-deltas
branch
from
b0ca0fd to
44a0d24
Compare
Co-authored-by: Philippe Bruhat (BooK) <book@cpan.org>
Co-authored-by: Philippe Bruhat (BooK) <book@cpan.org>
|
The change from the initial version which handled each section depending on the expected content ( Another useful aspect is the removal of whole sections when they have not been modified from the template. When preparing a blead final release, the steps will be:
This is removing toil of copying and pasting stuff from the development cycle perldeltas, allowing the releaser to focus on the actual work of copy-editing. |
| next | ||
| unless ref( $tree->[$pos] ) eq 'ARRAY'; | ||
| next unless $tree->[$pos][0] =~ /\Ahead([1-4])\z/; | ||
| next if $1 > $level; |
There was a problem hiding this comment.
Back indent expected?
|
|
||
| ./perl -Ilib Porting/merge-deltas.pl | ||
|
|
||
| The resulting F<pod/perldelta.pod> will need to be edited. In particular, |
There was a problem hiding this comment.
edited. In
Extra space?
| Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that | ||
| every section it lists is, if necessary, populated and complete. Copy | ||
| edit the whole document. | ||
| every section it lists is, if necessary, populated and complete. |
There was a problem hiding this comment.
I think I would have put this section out of a this paragraph and in its own, guarded by a =for checklist
But it's not a blocker to merge this change :)
| # tree_for & as_pod | ||
| { | ||
| my $pod = <<~ 'POD'; | ||
| =head2 CVE-2025-12345 |
There was a problem hiding this comment.
I would not use an actual existing CVE number
5 participants
This covers almost all cases. The goal is that the release manager will only have the editing work left, and not have to spend time copy/pasting sections from the individual deltas into the final one.
Solves #23365.