summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorHaojian Wu <hokein@google.com>2017-10-26 08:23:20 +0000
committerHaojian Wu <hokein@google.com>2017-10-26 08:23:20 +0000
commit2310743d9c29baefb4ef92be3ef1acac8900ce83 (patch)
tree1807e663a5f57f0abc793a0cdf3d0463c67e5d6a /docs
parentdb993457ec958b29537790327b9ca78b2f90e5b8 (diff)
[clang-tidy ObjC] [1/3] New module `objc` for Objective-C checks
Summary: This is part 1 of 3 of a series of changes to improve Objective-C linting in clang-tidy. This introduces a new clang-tidy module, `objc`, specifically for Objective-C / Objective-C++ checks. The module is currently empty; D39142 adds the first check. Test Plan: `ninja check-clang-tools` Patch by Ben Hamilton! Reviewers: hokein, alexfh Reviewed By: hokein Subscribers: Wizard, mgorny Differential Revision: https://reviews.llvm.org/D39188 git-svn-id: https://llvm.org/svn/llvm-project/clang-tools-extra/trunk@316643 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/ReleaseNotes.rst2
-rw-r--r--docs/clang-tidy/index.rst7
2 files changed, 9 insertions, 0 deletions
diff --git a/docs/ReleaseNotes.rst b/docs/ReleaseNotes.rst
index 71e00ba4..4dc34834 100644
--- a/docs/ReleaseNotes.rst
+++ b/docs/ReleaseNotes.rst
@@ -57,6 +57,8 @@ The improvements are...
Improvements to clang-tidy
--------------------------
+- New module `objc` for Objective-C style checks.
+
- Renamed checks to use correct term "implicit conversion" instead of "implicit
cast" and modified messages and option names accordingly:
diff --git a/docs/clang-tidy/index.rst b/docs/clang-tidy/index.rst
index 69136e6e..e1e33414 100644
--- a/docs/clang-tidy/index.rst
+++ b/docs/clang-tidy/index.rst
@@ -68,6 +68,7 @@ Name prefix Description
``modernize-`` Checks that advocate usage of modern (currently "modern"
means "C++11") language constructs.
``mpi-`` Checks related to MPI (Message Passing Interface).
+``objc-`` Checks related to Objective-C coding conventions.
``performance-`` Checks that target performance-related issues.
``readability-`` Checks that target readability-related issues that don't
relate to any particular coding style.
@@ -341,6 +342,11 @@ The Directory Structure
|-- LLVMTidyModule.cpp
|-- LLVMTidyModule.h
...
+ |-- objc/ # Objective-C clang-tidy module.
+ |-+
+ |-- ObjCTidyModule.cpp
+ |-- ObjCTidyModule.h
+ ...
|-- tool/ # Sources of the clang-tidy binary.
...
test/clang-tidy/ # Integration tests.
@@ -349,6 +355,7 @@ The Directory Structure
|-- ClangTidyTest.h
|-- GoogleModuleTest.cpp
|-- LLVMModuleTest.cpp
+ |-- ObjCModuleTest.cpp
...