Fix make misspell hanging on internal/tools #2230
Merged
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.
Description:
When running
make
to run tests, themisspell
target is run on theinternal/tools
directory (since #2131).As there are no
.md
nor.yaml
files in this directory, theALL_DOC
variable (defined asALL_DOC := $(shell find . \( -name "*.md" -o -name "*.yaml" \) -type f | sort
) is empty.Therefore, the
misspell
target runsmisspell -error
without any argument, causingmisspell
to readstdin
, hanging. The only way to makemake
not hang is to sendEOF
(eg. withecho -n | make
).I suspect that this doesn't affect the CI as it automatically sends
EOF
to stdin.This PR fixes makes the
misspell -error
by making themisspell
command conditionally run, only ifALL_DOC
is defined and not empty.Link to tracking Issue: n/a
Testing: Run
make
before and after the fix. Check that themisspell
step doesn't hang after the fix.Documentation: n/a