docs: explain include paths for third-party libraries and drop a private-repo claim - #72
Merged
Merged
Conversation
…ate-repo claim Follows up on @2bndy5's comments on #62. **Third-party libraries in the clang-tidy guide.** Step 2 said to install dependencies before the configure step, but not why: clang-tidy finds a library's headers only through the `-I` paths the compiler gets for each file, which it reads from the compilation database. The bullet now says so, and shows how to pass those paths with `extra-args` when there is no build system (`-Ithird_party/fmt/include`, written without a space because `extra-args` splits on spaces). **Private repositories on the home page.** #70 said the step summary also works "in private repositories, where thread comments are turned off". That came from the note on `thread-comments` in cpp-linter-action's `action.yml`, but cpp-linter has no code that turns thread comments off for private repositories; its requests ask for `application/vnd.github.raw+json`, the change that addressed cpp-linter-action#142. As discussed on #62, whether thread comments work on a private repository still needs a test run, so the card no longer says anything about private repositories.
✅ Deploy Preview for cpp-linter-github-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
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.
Follows up on @2bndy5's comments on #62.
Third-party libraries in the clang-tidy guide. Step 2 said to install dependencies before the configure step, but not why: clang-tidy finds a library's headers only through the
-Ipaths the compiler gets for each file, which it reads from the compilation database. The bullet now says so, and shows how to pass those paths withextra-argswhen there is no build system (-Ithird_party/fmt/include, written without a space becauseextra-argssplits on spaces).Private repositories on the home page. #70 said the step summary also works "in private repositories, where thread comments are turned off". That came from the note on
thread-commentsin cpp-linter-action'saction.yml, but cpp-linter has no code that turns thread comments off for private repositories; its requests ask forapplication/vnd.github.raw+json, the change that addressed cpp-linter-action#142. As discussed on #62, whether thread comments work on a private repository still needs a test run, so the card no longer says anything about private repositories.