Skip to content
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.

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

build should not unconditionally rewrite pickle file #5501

Closed
eqvinox opened this issue Oct 1, 2018 · 2 comments
Closed

build should not unconditionally rewrite pickle file #5501

eqvinox opened this issue Oct 1, 2018 · 2 comments
Labels
Milestone

Comments

@eqvinox
Copy link
Contributor

eqvinox commented Oct 1, 2018

Starting as of 1.8.0, with the change in commit 20f625b, sphinx-build unconditionally writes the environment.pickle file. This breaks the build system expectation that a
-b pickle run can be done first, and then various output formats can be built off that file.

Before the above commit, the timestamp of the pickle file could be compared against an output format's timestamp to determine whether it is out of date; now it's always out of date since it keeps getting rewritten.

Reference build system integration: https://github.com/FRRouting/frr/blob/master/doc/subdir.am#L32 (uses text instead of pickle to support older sphinx versions)

@eqvinox
Copy link
Contributor Author

eqvinox commented Oct 1, 2018

(sorry, forgot mention @blueyed for commit relation)

eqvinox added a commit to eqvinox/sphinx that referenced this issue Oct 11, 2018
This reverts commit 20f625b, which
introduced a regression in dependency tracking for build systems
invoking sphinx-build (described in issue sphinx-doc#5501.)

The correct solution is to properly track when the pickle file needs to
be written;  unfortunately I don't know enough about sphinx to implement
this.  Also, I'm not sure the intersphinx cache belongs into this at
all.
eqvinox added a commit to eqvinox/sphinx that referenced this issue Oct 11, 2018
This reverts commit 20f625b, which
introduced a regression in dependency tracking for build systems
invoking sphinx-build (described in issue sphinx-doc#5501.)

The correct solution is to properly track when the pickle file needs to
be written;  unfortunately I don't know enough about sphinx to implement
this.  Also, I'm not sure the intersphinx cache belongs into this at
all.
@tk0miya tk0miya added this to the 1.8.2 milestone Oct 16, 2018
@tk0miya
Copy link
Member

tk0miya commented Nov 6, 2018

#5525 is merged now.
Thanks,

Note: I opened #5594 for the original issue of 20f625b.

@tk0miya tk0miya closed this as completed Nov 6, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants