-
Notifications
You must be signed in to change notification settings - Fork 384
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
[doc] remove dead links in README.md #3512
Conversation
After commit Ericsson#3462 the links in the README.md broke in the Common Tools section. This commit removes those links as they seem to no longer be necessary. @csordasmarton
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.
These links are not removed but the documentations were moved to a different place.
* [Report Converter Tool (to convert analysis results from other analyzers to the codechecker report directory format))](/docs/tools/report-converter.md) | ||
* [Translation Unit Collector (to collect source files of a translation unit or to get source files which depend on the given header files)](/docs/tools/tu_collector.md) | ||
* [Report Hash generator (to generate unique hash identifiers for reports)](/docs/tools/codechecker_report_hash.md) |
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.
The documentation is moved to here: https://github.com/Ericsson/codechecker/blob/master/docs/tools/report-converter.md#report-hash-generation-module
@@ -195,10 +195,8 @@ For details see | |||
Useful tools that can also be used outside CodeChecker. | |||
|
|||
* [Build Logger (to generate JSON Compilation Database from your builds)](/analyzer/tools/build-logger/README.md) | |||
* [Plist to HTML converter (to generate HTML files from the given plist files)](/docs/tools/plist_to_html.md) |
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.
The documentation is moved to here: https://github.com/Ericsson/codechecker/blob/master/docs/tools/report-converter.md#plist-to-html-tool
@extract Thanks for the fix. However, the pointed documentations are not missing, but moved to other locations as @csordasmarton mentioned. Could you please fix these instead of removing them? Thank you! |
After commit Ericsson#3462 the links in the README.md broke in the Common Tools section. This commit changes those to the correct link.
link was broken, made it an anchor instead. * [Usage](#plist-to-html-usage) does not seem to link anywhere either, consider removing
temporary fix for usage, but should probably get a better anchor name.
hi Sorry took some time, it should now be correct. I also fixed in report-converter.md as the table of content was linking incorrectly. |
Thank you very much for the contribution. I'll merge it soon. |
After commit #3462 the links in the README.md broke in the Common Tools section. This commit removes those links as they seem to no longer be necessary.
@csordasmarton