[fix] Fix missing CC_LIB_DIR when dev_package is used #4513
+1
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iIf you are developing CodeChecker, you should likely build the 'dev_package' target instead of 'package', as it symlinks instead of copied implementation files. However, CodeChecker will immediately crash if the CC_LIB_DIR environmental variable is not set. Based on the comment of @bruntib in Ericsson#4491, this is a one-line fix. The issue is that CodeChecker (for historical reasons) has a non-standar library layout. Instead of every library being on the same level (codechecker_analyzer, codechecker_client, codechecker_web etc), they are all over the place in the source code. The "package" make target that "builds" CodeChecker solves this by copying the libraries in the same directory, with them finally being on the same level. The "dev_package" target symlinks instead, so that changes in the actual source code are immediately refected without a need to build CodeChecker again. CC_LIB_DIR points to this copied and corrected layout. However, if it was symlinked, we mistakenly resolved that symlink through os.path.realpath() -- but that points to the different directory layout, so removing or adding a directory from this path will land you in the wrong place. The patch now no longer resolves this symlink.
bruntib
approved these changes
Mar 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If you are developing CodeChecker, you should likely build the 'dev_package' target instead of 'package', as it symlinks instead of copied implementation files. However, CodeChecker will immediately crash if the CC_LIB_DIR environmental variable is not set.
Based on the comment of @bruntib in #4491, this is a one-line fix. The issue is that CodeChecker (for historical reasons) has a non-standar library layout. Instead of every library being on the same level (codechecker_analyzer, codechecker_client, codechecker_web etc), they are all over the place in the source code. The "package" make target that "builds" CodeChecker solves this by copying the libraries in the same directory, with them finally being on the same level.
The "dev_package" target symlinks instead, so that changes in the actual source code are immediately refected without a need to build CodeChecker again.
CC_LIB_DIR points to this copied and corrected layout. However, if it was symlinked, we mistakenly resolved that symlink through os.path.realpath() -- but that points to the different directory layout, so removing or adding a directory from this path will land you in the wrong place.
Traditionally, we circumvented this by explicitly set the CC_LIB_DIR variable, in which case CodeChecker does no symlink resolving.
The patch now no longer resolves this symlink in any case.