[doc] Documentation for report identification #3070
Merged
Conversation
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
dkrupp
previously requested changes
Dec 1, 2020
There was a problem hiding this comment.
I am missing the references from the user guide to this document. I even did not know that document existed. I think we should refer to this doc from the user_guide.
Please see my comments in the issue also about the missing intro section of the user guide.
"The user guide should have an intro section explaining and summarizing the Features of the CodeChecker command and its subcommands (each one sentences).
The user guide should also have a separate section on Report hashes, because it is a particularly important topic.
Now it is hidden in the help of the check command
"
gyorb
suggested changes
Dec 8, 2020
| for hash generation to make the hash independent of the | ||
| indentation | ||
| Unique report identifiers are required to compare analysis results. If an | ||
| analyzer (`Clang Static Analyzer`, `Clang Tidy`) do not generate a unique |
There was a problem hiding this comment.
Suggested change
| analyzer (`Clang Static Analyzer`, `Clang Tidy`) do not generate a unique | |
| analyzer (`Clang Static Analyzer`, `Clang Tidy`) does not generate a unique |
csordasmarton
force-pushed
the
report_identification_doc
branch
from
a90fa71 to
678c0ec
Compare
Describe each hash methods in the documentation.
csordasmarton
force-pushed
the
report_identification_doc
branch
from
678c0ec to
15f680f
Compare
gyorb
approved these changes
Dec 16, 2020
|
@dkrupp do you have any further comments to this change? |
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.
Describe each hash methods in the documentation.