8000 [3.5] bpo-31036: use an existing Misc/NEWS rather than trying to use blurb by ned-deily · Pull Request #2874 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

[3.5] bpo-31036: use an existing Misc/NEWS rather than trying to use blurb #2874

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 27, 2017
Merged

[3.5] bpo-31036: use an existing Misc/NEWS rather than trying to use blurb #2874

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0104a4e
bpo-31036: use an existing Misc/NEWS rather than trying to use blurb
ned-deily Jul 25, 2017
ddffe21
bpo-31036: avoid echoing comments
ned-deily Jul 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
bpo-31036: use an existing Misc/NEWS rather than trying to use blurb
  • Loading branch information
@ned-deily
ned-deily committed Jul 25, 2017
commit 0104a4e6c06fbfac66e9258f1b23c410194e3828
14 changes: 13 additions & 1 deletion Doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,19 @@ help:

build:
-mkdir -p build
$(BLURB) merge -f build/NEWS
# Look first for a Misc/NEWS file (building from a source release tarball
# or old repo) and use that, otherwise look for a Misc/NEWS.d directory
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, those comments need to be dedented otherwise they seem to echo.

# (building from a newer repo) and use blurb to generate the NEWS file.
@if [ -f ../Misc/NEWS ] ; then \
echo "Using existing Misc/NEWS file"; \
cp ../Misc/NEWS build/NEWS; \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be worth it to use $INSTALL_DATA rather than cp?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so. $INSTALL_DATA is not currently used in the Doc Makefile and we're not installing anything. The cp is just for a temporary build file.

elif [ -d ../Misc/NEWS.d ]; then \
echo "Building NEWS from Misc/NEWS.d with blurb"; \
$(BLURB) merge -f build/NEWS; \
else \
echo "Neither Misc/NEWS.d nor Misc/NEWS found; cannot build docs"; \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, as I discovered several times (inadvertently), the docs will build without a valid NEWS file. whatsnew/changelog.html will be empty but otherwise the build is unharmed. I agree that we should probably fail noisily here, I merely offer as an alternative that we could complain noisily but allow the build to continue.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, we could make that non-fatal. But one or the other (Misc/NEWS or Misc/NEWS.d should be there, I'd think. And the previous Docs build did assume that Misc/NEWS was in the parent directory so that's not new; it might be nice to allow for out of tree builds but that's a separate feature.

exit 1; \
fi
$(SPHINXBUILD) $(ALLSPHINXOPTS)
@echo

Expand Down
0