Skip to content

[clang-tidy][doc] align the title style in clang-tidy/index.rst #119938

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

Merged
merged 2 commits into from
Dec 14, 2024

Conversation

HerrCai0907
Copy link
Contributor

Uppercase each word in title and toctree

Originally posted by @nicovank in #119842 (comment).

Uppercase each word in title and toctree

_Originally posted by @nicovank in llvm#119842 (comment).
@llvmbot
Copy link
Member

llvmbot commented Dec 14, 2024

@llvm/pr-subscribers-clang-tidy

@llvm/pr-subscribers-clang-tools-extra

Author: Congcong Cai (HerrCai0907)

Changes

Uppercase each word in title and toctree

Originally posted by @nicovank in #119842 (comment).


Full diff: https://github.com/llvm/llvm-project/pull/119938.diff

1 Files Affected:

  • (modified) clang-tools-extra/docs/clang-tidy/index.rst (+2-2)
diff --git a/clang-tools-extra/docs/clang-tidy/index.rst b/clang-tools-extra/docs/clang-tidy/index.rst
index a4233d5d8e2694..26f11426c1dc4d 100644
--- a/clang-tools-extra/docs/clang-tidy/index.rst
+++ b/clang-tools-extra/docs/clang-tidy/index.rst
@@ -9,7 +9,7 @@ See also:
 .. toctree::
    :maxdepth: 1
 
-   The list of clang-tidy checks <checks/list>
+   The List of Clang-Tidy Checks <checks/list>
    Clang-tidy IDE/Editor Integrations <Integrations>
    Getting Involved <Contributing>
    External Clang-Tidy Examples <ExternalClang-TidyExamples>
@@ -21,7 +21,7 @@ static analysis. :program:`clang-tidy` is modular and provides a convenient
 interface for writing new checks.
 
 
-Using clang-tidy
+Using Clang-Tidy
 ================
 
 :program:`clang-tidy` is a `LibTooling`_-based tool, and it's easier to work

Copy link
Contributor

@nicovank nicovank left a comment

Choose a reason for hiding this comment

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

Ctrl+F -ing for lowercase clang-tidy reveals a couple more places where it should maybe be updated: lines 331, 350 and 352 (:program:`clang-tidy`?). It's very minor anyway.

@HerrCai0907
Copy link
Contributor Author

Ctrl+F -ing for lowercase clang-tidy reveals a couple more places where it should maybe be updated: lines 331, 350 and 352 (:program:`clang-tidy`?). It's very minor anyway.

IMO and ref to clang in clang's doc. clang-tidy should be treat as normal work so it can be uppercase or lowercase. In clang, all title in use uppercase word and in the content, clang still be lowercase.

@HerrCai0907 HerrCai0907 merged commit 2291e5a into llvm:main Dec 14, 2024
9 checks passed
@HerrCai0907 HerrCai0907 deleted the clang-tidy/docs branch December 14, 2024 06:02
@llvm-ci
Copy link
Collaborator

llvm-ci commented Dec 14, 2024

LLVM Buildbot has detected a new failure on builder llvm-clang-x86_64-sie-win running on sie-win-worker while building clang-tools-extra at step 7 "test-build-unified-tree-check-all".

Full details are available at: https://lab.llvm.org/buildbot/#/builders/46/builds/9200

Here is the relevant piece of the build log for the reference
Step 7 (test-build-unified-tree-check-all) failure: test (failure)
******************** TEST 'Clang :: AST/builtins-arm-strex-rettype.c' FAILED ********************
Exit Code: 1

Command Output (stdout):
--
# RUN: at line 1
z:\b\llvm-clang-x86_64-sie-win\build\bin\clang.exe -cc1 -internal-isystem Z:\b\llvm-clang-x86_64-sie-win\build\lib\clang\20\include -nostdsysteminc -triple thumbv7m-apple-darwin-eabi -ast-dump Z:\b\llvm-clang-x86_64-sie-win\llvm-project\clang\test\AST\builtins-arm-strex-rettype.c | z:\b\llvm-clang-x86_64-sie-win\build\bin\filecheck.exe Z:\b\llvm-clang-x86_64-sie-win\llvm-project\clang\test\AST\builtins-arm-strex-rettype.c
# executed command: 'z:\b\llvm-clang-x86_64-sie-win\build\bin\clang.exe' -cc1 -internal-isystem 'Z:\b\llvm-clang-x86_64-sie-win\build\lib\clang\20\include' -nostdsysteminc -triple thumbv7m-apple-darwin-eabi -ast-dump 'Z:\b\llvm-clang-x86_64-sie-win\llvm-project\clang\test\AST\builtins-arm-strex-rettype.c'
# .---command stderr------------
# | Z:\b\llvm-clang-x86_64-sie-win\llvm-project\clang\test\AST\builtins-arm-strex-rettype.c:7:12: error: use of unknown builtin '__builtin_arm_strex' [-Wimplicit-function-declaration]
# |     7 |   } while (__builtin_arm_strex(a, b));
# |       |            ^
# | 1 error generated.
# `-----------------------------
# error: command failed with exit status: 1
# executed command: 'z:\b\llvm-clang-x86_64-sie-win\build\bin\filecheck.exe' 'Z:\b\llvm-clang-x86_64-sie-win\llvm-project\clang\test\AST\builtins-arm-strex-rettype.c'

--

********************


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants