Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #1374 the PDNS documentation was amended, but the author forgot to re-generate the docs.
We do have a validation check in the main workflow, but it didn't catch the change because the underlying Makefile target was broken.
This commit replaces the Makefile conditional with an equivalent shell conditional.
Explanation
The conditional checking for a dirty working directory ran before generating the documentation. In effect,
make validate-doc
onlydid the right thing on the second invokation.
Consider this simplified Makefile example:
The order of evaluation for
make validate
is:generate
target, no dependencies,generate
target toaaaa
,validate
target, with dependencygenerate
,bbbb
, compare with empty string,validate
target tocccc
validate
target todddd
generate
→ executeaaaa
(generate
is a dependency ofvalidate
),validate
→ executecccc
ordddd
.This also means that step 4 is also (unnecessarily) executed when the
validate
target is never invoked.