Skip to content

docs: explain include paths for third-party libraries and drop a private-repo claim - #72

Merged
shenxianpeng merged 1 commit into
mainfrom
bugfix/step-summary-and-include-paths
Sep 30, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
bugfix/step-summary-and-include-paths

Conversation

@shenxianpeng

Copy link
Copy Markdown
Member

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.

…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.
@netlify

netlify Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for cpp-linter-github-io ready!

Name Link
🔨 Latest commit cd064cb
🔍 Latest deploy log https://app.netlify.com/projects/cpp-linter-github-io/deploys/6abcdc5b583b9500081cf864
😎 Deploy Preview https://deploy-preview-72--cpp-linter-github-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@shenxianpeng
shenxianpeng merged commit 7a541ac into main Sep 30, 2026
7 checks passed
@shenxianpeng
shenxianpeng deleted the bugfix/step-summary-and-include-paths branch September 30, 2026 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant