Skip to content
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

Merged
merged 5 commits into from
Aug 17, 2022
Merged

Conversation

extract
Copy link
Contributor

@extract extract commented Nov 19, 2021

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

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
Copy link
Contributor

@csordasmarton csordasmarton left a 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@csordasmarton csordasmarton added documentation 📖 Changes to documentation. bugfix 🔨 labels Dec 1, 2021
@bruntib
Copy link
Contributor

bruntib commented Aug 17, 2022

@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!

extract and others added 2 commits August 17, 2022 17:46
After commit Ericsson#3462 the links in the README.md broke in the Common Tools section. This commit changes those to the correct link.
@bruntib bruntib added this to the release 6.20.0 milestone Aug 17, 2022
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.
@extract
Copy link
Contributor Author

extract commented Aug 17, 2022

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.

@bruntib
Copy link
Contributor

bruntib commented Aug 17, 2022

Thank you very much for the contribution. I'll merge it soon.

@bruntib bruntib merged commit e15abff into Ericsson:master Aug 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix 🔨 documentation 📖 Changes to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants