Skip to content

clang-check: add page #18515

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

clang-check: add page #18515

wants to merge 2 commits into from
+20 −0

Conversation

julian-st
Copy link

@julian-st julian-st commented Oct 6, 2025 •
edited
Loading

see #6367

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@CLAassistant
Copy link

CLAassistant commented Oct 6, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Oct 6, 2025
@tldr-bot
Copy link

tldr-bot commented Oct 6, 2025

The build for this PR failed with the following error(s) at commit
cd980e5c27baabc1eaa63ffddde5a2deb6bd5a70:

pages/common/clang-check.md:10: TLDR104 Example descriptions should prefer infinitive tense (e.g. write) over present (e.g. writes) or gerund (e.g. writing)

Please fix the error(s) and push again.

@Managor Managor mentioned this pull request Oct 6, 2025
Open
Managor
Managor requested changes Oct 7, 2025
View reviewed changes
pages/common/clang-check.md
@@ -0,0 +1,20 @@
# clang-check

> A tool for basic error checking and working with Clang's Abstract Syntax Tree (AST). It is part of Clang's LibTooling and is useful for debugging and analyzing C/C++ code.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> A tool for basic error checking and working with Clang's Abstract Syntax Tree (AST). It is part of Clang's LibTooling and is useful for debugging and analyzing C/C++ code.
> Check basic erros and work with Clang's Abstract Syntax Tree (AST).
> Part of Clang's LibTooling and is useful for debugging and analyzing C/C++ code.

pages/common/clang-check.md

- Run default checks on a source file:

`clang-check {{path/to/file.cpp}} --`
Copy link
Member

Choose a reason for hiding this comment

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

What is the purpose of -- here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Managor Managor Managor requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@julian-st @CLAassistant @tldr-bot @Managor