Add a README file for Coverity Static analysis #533
Merged
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
gitwallit
reviewed
Aug 3, 2022
gitwallit
previously approved these changes
Aug 3, 2022
gitwallit
previously approved these changes
Aug 3, 2022
gitwallit
previously approved these changes
Aug 3, 2022
archigup
reviewed
Aug 4, 2022
test/Coverity/README.md
Outdated
| - Extract the cmake download using `tar -xzvf cmake-3.13.0.tar.gz`. | ||
| - Go to the extracted folder (`cd cmake-3.13.0`) and run `./bootstrap`. | ||
| - Run `make -j$(nproc)` and then run `sudo make install`. | ||
| - Check the version using `cmake --version` command. |
Member
There was a problem hiding this comment.
For Debian based systems, we should recommend using a PPA, or for any Linux system we can recommend just unpacking a binary distribution of cmake to /opt and adding to PATH. Using sudo make install makes the system a mess and can cause conflicts with the system package manager
archigup
reviewed
Aug 4, 2022
test/Coverity/README.md
Outdated
| ## Getting Started | ||
| ### Prerequisites | ||
| You can run this on a platform supported by Coverity. The list and other details can be found [here](https://sig-docs.synopsys.com/polaris/topics/c_coverity-compatible-platforms.html). | ||
| To compile and run this project successfully, you must have the following: |
Member
There was a problem hiding this comment.
Suggested change
| To compile and run this project successfully, you must have the following: | |
| To compile and run the Coverity target successfully, you must have the following: |
archigup
reviewed
Aug 4, 2022
test/Coverity/README.md
Outdated
| ~~~ | ||
|
|
||
| You should now have the HTML formatted violations list in a directory named `html-output`. | ||
| With the current configuration and the provided project, you should see only one deviation from advisory rule 8.13 in file FreeRTOS_IP.c [here](https://github.com/alfred2g/FreeRTOS-Plus-TCP/blob/misra_remaining/source/FreeRTOS_IP.c#L236). This deviation has a justification outlined [here](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/MISRA.md#rule-813). With that justification in place, a coverity suppression statement has been added to the code. However, even with that suppression in place, the coverity tool continues to report the deviation. Thus, as an excpetion, we have allowed the deviation to be reported in the HTML formatted report. If you find a way around it, please help us fix this by creating a pull-request in this repository. |
Member
There was a problem hiding this comment.
This was fixed in a newer version of Coverity, if I recall correctly.
gitwallit
previously approved these changes
Aug 8, 2022
archigup
approved these changes
Aug 8, 2022
gitwallit
approved these changes
Aug 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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
This PR adds a REAME file in the
test/Coverityfolder to guide users on the process of building and analyzing the source code using Coverity static analysis tool.Also, it moves the Coverity config file to the
test/Coverityfolder to be consistent.Test Steps
Related Issue
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.