octoleo/qpdf
2
1
Fork 0
mirror of https://github.com/qpdf/qpdf.git synced 2025-04-08 01:01:50 +00:00
Code Issues Releases Wiki Activity

Discontinue ChangeLog; update release notes as you go

Browse Source
This commit is contained in:
Jay Berkenbilt 2025-02-19 09:07:52 -05:00
parent 80c43b60dc
commit 656b7b319b
3 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -1,6 +1,8 @@
2025-02-15 Jay Berkenbilt <ejb@ql.org> 2025-02-19 Jay Berkenbilt <ejb@ql.org>
* Disable PointerHolder by default. * END USE OF ChangeLog. From this point forward, please consult
the release notes for important changes and version control
history for detailed changes.
2025-02-15 Jay Berkenbilt <ejb@ql.org> 2025-02-15 Jay Berkenbilt <ejb@ql.org>

9
README-maintainer.md
View File

@ -23,6 +23,11 @@
## ROUTINE DEVELOPMENT ## ROUTINE DEVELOPMENT
**When making changes that users need to know about, update the release notes
(manual/release-notes.rst) as you go.** Major changes to the internal API can also be mentioned in
the release notes in a section called "Internal Changes" or similar. This removes ChangeLog as a
separate mechanism for tracking changes.
**Remember to check pull requests as well as issues in github.** **Remember to check pull requests as well as issues in github.**
Include `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` with cmake if using emacs lsp mode. Include `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` with cmake if using emacs lsp mode.
@ -536,12 +541,10 @@ When done, the following should happen:
`make_dist` verifies this consistency, and CI fails if they are `make_dist` verifies this consistency, and CI fails if they are
inconsistent. inconsistent.
* Update release notes in manual. Look at diffs and ChangeLog. * Update release notes in manual. Review version control history.
Update release date in `manual/release-notes.rst`. Change "not yet Update release date in `manual/release-notes.rst`. Change "not yet
released" to an actual date for the release. released" to an actual date for the release.
* Add a release entry to ChangeLog: "x.y.z: release"
* Commit changes with title "Prepare x.y.z release" * Commit changes with title "Prepare x.y.z release"
* Performance test is included with binary compatibility steps. Even * Performance test is included with binary compatibility steps. Even

6
manual/release-notes.rst
View File

@ -3,8 +3,10 @@
Release Notes Release Notes
============= =============
For a detailed list of changes, please see the file This is a curated list of user-facing and developer-facing changes.
:file:`ChangeLog` in the source distribution. Prior to version 12, file :file:`ChangeLog` contained more detail.
From version 12 onward, please consult version control history for
more detail.
.. x.y.z: not yet released .. x.y.z: not yet released