Warn about whatsnew changelog reference

This commit is contained in:
Ned Deily 2020-05-19 06:28:27 -04:00
parent 42349627be
commit 273ce26c75
No known key found for this signature in database
GPG Key ID: 2D347EA6AA65421D
1 changed files with 8 additions and 1 deletions

View File

@ -612,7 +612,14 @@ the main repo.
- Add a new ``whatsnew/3.x.rst`` file (with the comment near the top
and the toplevel sections copied from the previous file) and
add it to the toctree in ``whatsnew/index.rst``.
add it to the toctree in ``whatsnew/index.rst``. But beware that
the initial ``whatsnew/3.x.rst`` checkin from previous releases
may be incorrect due to the initial midstream change to ``blurb``
that propagates from release to release! Help break the cycle: if
necessary make the following change::
- For full details, see the :source:`Misc/NEWS` file.
+ For full details, see the :ref:`changelog <changelog>`.
- Update the version number in ``configure.ac`` and re-run ``autoconf``.