This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author ned.deily
Recipients benjamin.peterson, doko, georg.brandl, larry, matrixise, ned.deily, vstinner
Date 2017-07-25.22:59:51
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1501023591.88.0.874314655813.issue31036@psf.upfronthosting.co.za>
In-reply-to
Content
The good news is that the released tarballs starting now and going forward will already have a generated Misc/NEWS just like they always have had.  So blurb is not needed if you are building docs from such tarballs (like 3.5.4rc1).  We did forget about building docs directly from the tarball so we'll fix the Doc Makefile to use an existing Misc/NEWS file and not use blurb at all in that case. I think that should cover your first use case.

(If you are building from a git repo, you will need to use blurb as Misc/NEWS is no longer a checked-in file.  As I've tried to explain before, just running "make venv" and "make html" currently isn't sufficient; one needs to either activate the virtual env or fiddle with Doc Makefile variables PYTHON, SPHINXBUILD, and/or now BLURB.  I'm trying to see if I can make that smarter.)

Your second use case is more complicated, if I understand it correctly.  If you are generating the diff from a repo, going forward there won't be a unified Misc/NEWS file in the repo, rather there will be individual files added to Misc/NEWS.d for each checkin with a NEWS entry and those individual files have metadata meaningful to blurb.  When the release tarball is made, Misc/NEWS.d/* is removed and replaced by a blurb-generated Misc/NEWS file.  So if you are adding upstream pre-release diffs, you would have to run blurb as part of the process of building the docs. But I don't think blurb currently is designed to to handle the case of combining an existing generated Misc/NEWS file (from the tarball) with additional NEWS.d files. So I guess one solution would be you need to build the docs from the Git repo or at least copy the Misc/NEWS.d from the repo at the release tag and add the NEWS.d files for the cherrypicked pre-release fixes to it and then run blurb on it.  But I may have misunderstand and I should let Larry speak for blurb.
History
Date User Action Args
2017-07-25 22:59:51ned.deilysetrecipients: + ned.deily, georg.brandl, doko, vstinner, larry, benjamin.peterson, matrixise
2017-07-25 22:59:51ned.deilysetmessageid: <1501023591.88.0.874314655813.issue31036@psf.upfronthosting.co.za>
2017-07-25 22:59:51ned.deilylinkissue31036 messages
2017-07-25 22:59:51ned.deilycreate