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

File bin/CodeChecker can be irritating #3371

Open
rspielmann opened this issue Jun 30, 2021 · 0 comments
Open

File bin/CodeChecker can be irritating #3371

rspielmann opened this issue Jun 30, 2021 · 0 comments
Labels
documentation 📖 Changes to documentation. enhancement 🌟 usability 👍 Usability-related features

Comments

@rspielmann
Copy link

I cloned the CodeChecker repository and later downloaded the CodeChecker 6.16.0 source ZIP. I ran into the same issue in both cases. I followed the installation instructions. After make package had finished, I tried this:

(CodeChecker venv) spielmann@robert-dev ~/devtools/codechecker-6.16.0 $ bin/CodeChecker 
python3: can't open file '/home/spielmann/devtools/codechecker-6.16.0/lib/python3/codechecker_common/cli.py': [Errno 2] No such file or directory

I was obviously not smart enough to fully read the documentation, which does state that I should run build/CodeChecker/bin/CodeChecker, which works just fine. The trap I fell into was that, as a software engineer, I assumed that bin/CodeChecker would only materialize as the result of the build run. In fact it's there from the beginning.

Maybe it would make sense to point this out in the documentation for hasty people. This is just a cosmetic improvement suggestion. An alternative could be to move the file to a subdir with a different name, e.g. src.

@whisperity whisperity added documentation 📖 Changes to documentation. enhancement 🌟 usability 👍 Usability-related features labels Jul 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Changes to documentation. enhancement 🌟 usability 👍 Usability-related features
Projects
None yet
Development

No branches or pull requests

2 participants