-
Notifications
You must be signed in to change notification settings - Fork 388
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
[report-converter] Improve documentation maintainability #4424
Open
gamesh411
wants to merge
1
commit into
Ericsson:master
Choose a base branch
from
gamesh411:improve-report-converter-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# CodeChecker Report Converter | ||
|
||
A Python tool to parse and convert various code analyzer outputs into CodeChecker format. It can create HTML reports from analyzer outputs and store them in a CodeChecker server. | ||
|
||
## Quick Start | ||
|
||
```bash | ||
# Create a Python virtualenv and set it as your environment | ||
make venv | ||
source $PWD/venv/bin/activate | ||
|
||
# Build and install report-converter package | ||
make package | ||
``` | ||
|
||
## Basic Usage | ||
|
||
```bash | ||
# Convert analyzer output to CodeChecker format | ||
report-converter --type clang-tidy --output /path/to/reports clang-tidy-output.txt | ||
|
||
# Generate HTML report | ||
plist-to-html --input /path/to/reports/*.plist --output /path/to/html | ||
``` | ||
|
||
## Documentation | ||
|
||
For comprehensive documentation, including: | ||
- Complete list of supported analyzers | ||
- Detailed usage examples | ||
- Configuration options | ||
- Troubleshooting guide | ||
|
||
Please visit our [official documentation](https://codechecker.readthedocs.io/en/latest/tools/report-converter/). | ||
|
||
## Requirements | ||
|
||
- Python >= 3.8 | ||
|
||
## License | ||
|
||
This project is licensed under the Apache License 2.0 - see the LICENSE.txt file for details. | ||
|
||
## Authors | ||
|
||
CodeChecker Team (Ericsson) |
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't find this
plist-to-html
script.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is an entry point defined for the report-converter package, which is named
plist-to-html
:/tools/report-converter/setup.py
This is a way for Python packages to provide a CLI script once installed.
I just went ahead and included this one in the docs as well.