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

Fix make misspell hanging on internal/tools #2230

Merged
merged 1 commit into from
Dec 1, 2020

Conversation

KSerrania
Copy link
Contributor

@KSerrania KSerrania commented Dec 1, 2020

Description:

When running make to run tests, the misspell target is run on the internal/tools directory (since #2131).
As there are no .md nor .yaml files in this directory, the ALL_DOC variable (defined as ALL_DOC := $(shell find . \( -name "*.md" -o -name "*.yaml" \) -type f | sort) is empty.
Therefore, the misspell target runs misspell -error without any argument, causing misspell to read stdin, hanging. The only way to make make not hang is to send EOF (eg. with echo -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 the misspell command conditionally run, only if ALL_DOC is defined and not empty.

Link to tracking Issue: n/a

Testing: Run make before and after the fix. Check that the misspell step doesn't hang after the fix.

Documentation: n/a

@KSerrania KSerrania requested a review from a team December 1, 2020 10:00
@codecov
Copy link

codecov bot commented Dec 1, 2020

Codecov Report

Merging #2230 (98f6013) into master (511cdaa) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2230   +/-   ##
=======================================
  Coverage   91.98%   91.98%           
=======================================
  Files         271      271           
  Lines       15664    15656    -8     
=======================================
- Hits        14408    14401    -7     
  Misses        854      854           
+ Partials      402      401    -1     
Impacted Files Coverage Δ
internal/data/bytesid.go 76.92% <0.00%> (-4.03%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 511cdaa...98f6013. Read the comment docs.

Copy link
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

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

I tested that it correctly solves the problem on my machine

@bogdandrutu bogdandrutu merged commit 14047fd into open-telemetry:master Dec 1, 2020
hughesjj pushed a commit to hughesjj/opentelemetry-collector that referenced this pull request Apr 27, 2023
Troels51 pushed a commit to Troels51/opentelemetry-collector that referenced this pull request Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants