[cland-tidy][NFC] Fixed documentation for modernize-make-shared check

[0hDEADBEAF]

I was surprised to see a different value for the MakeSmartPtrFunctionHeader option of the modernize-make-unique and modernize-make-shared clang-tidy checks. See, respectively: modernize-make-unique and modernize-make-shared.

From what I've read in the codebase, I believe both checks use the same default value for the MakeSmartPtrFunctionHeader: <memory> (from here).

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-clang-tidy

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

Author: 0xdeadbeaf (0hDEADBEAF)

Changes

I was surprised to see a different value for the MakeSmartPtrFunctionHeader option of the modernize-make-unique and modernize-make-shared clang-tidy checks. See, respectively: modernize-make-unique and modernize-make-shared.

From what I've read in the codebase, I believe both checks use the same default value for the MakeSmartPtrFunctionHeader: <memory> (from here).

---

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

2 Files Affected:

• (modified) clang-tools-extra/docs/ReleaseNotes.rst (+4)
• (modified) clang-tools-extra/docs/clang-tidy/checks/modernize/make-shared.rst (+1-1)

diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index 23d757b5e6f2e..3143bd3dbc435 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -248,6 +248,10 @@ Changes in existing checks
   <clang-tidy/checks/modernize/avoid-c-arrays>` to not diagnose array types
   which are part of an implicit instantiation of a template.
 
+- Improved :doc:`modernize-make-shared
+  <clang-tidy/checks/modernize/make-shared>` check by fixing documentation
+  for the default value for the ``MakeSmartPtrFunctionHeader`` option.
+
 - Improved :doc:`modernize-use-constraints
   <clang-tidy/checks/modernize/use-constraints>` check by fixing a crash on
   uses of non-standard ``enable_if`` with a signature different from
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/make-shared.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/make-shared.rst
index 982138fc5e781..cd953e7ee394d 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize/make-shared.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize/make-shared.rst
@@ -37,7 +37,7 @@ Options
 .. option:: MakeSmartPtrFunctionHeader
 
    A string specifying the corresponding header of make-shared-ptr function.
-   Default is `memory`.
+   Default is `<memory>`.
 
 .. option:: IncludeStyle
 

[vbvictor]

For changes in docs, we don't generally write release notes because it's an NFC change.
Functional changes are noted in ReleaseNotes.

[0hDEADBEAF]

Alright, removed the ReleaseNotes.rst changes!

[github-actions]

@0hDEADBEAF Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!