[clang-tidy] readability-identifier-naming.HungarianNotation: rename CharPrinter to CharPointer

[amurzeau]

Summary

The CharPrinter is a typo and should have been named CharPointer as it
configures the hungarian notation prefix for char pointers (char*).

As all configuration options within
readability-identifier-naming.HungarianNotation.CString.* were not read
at all in the previous clang-tidy version (fixed in D144431), this option
rename won't break existing users.

A note in release notes is added to let users know these options were
renamed.

[carlosgalvezp]

Good catch, thanks for fixing!

clang-tools-extra/clang-tidy/readability/IdentifierNamingCheck.cpp

for (const auto &Type : HNDerivedTypes) {
     Buffer.truncate(DefSize);
     Buffer.append(Type);
     StringRef Val = Options.get(Buffer, "");
     if (!Val.empty())
       HNOption.DerivedType[Type] = Val.str();
   }
 
   static constexpr std::pair<StringRef, StringRef> HNCStrings[] = {
-      {"CharPrinter", "char*"},
+      {"CharPointer", "char*"},
       {"CharArray", "char[]"},
-      {"WideCharPrinter", "wchar_t*"},
+      {"WideCharPointer", "wchar_t*"},
       {"WideCharArray", "wchar_t[]"}};
 
   Buffer = {Section, "CString."};
   DefSize = Buffer.size();
   for (const auto &CStr : HNCStrings) {
     Buffer.truncate(DefSize);
     Buffer.append(CStr.first);
     StringRef Val = Options.get(Buffer, "");

clang-tools-extra/docs/ReleaseNotes.rst

- Deprecated check-local options `HeaderFileExtensions`
   in :doc:`misc-unused-using-decls
   <clang-tidy/checks/misc/unused-using-decls>` check.
   Global options of the same name should be used instead.
 
 - Fixed reading `HungarianNotation.CString.*` options in
   :doc:`readability-identifier-naming
   <clang-tidy/checks/readability/identifier-naming>` check.
 
+- Renamed `HungarianNotation.CString` options `CharPrinter` and
+  `WideCharPrinter` to `CharPointer` and `WideCharPointer` respectively in
+  :doc:`readability-identifier-naming
+  <clang-tidy/checks/readability/identifier-naming>` check.
+
 - Fixed a false positive in :doc:`readability-container-size-empty
   <clang-tidy/checks/readability/container-size-empty>` check when comparing
   ``std::array`` objects to default constructed ones. The behavior for this and
   other relevant classes can now be configured with a new option.
 
 Removed checks
 ^^^^^^^^^^^^^^
 

clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst

 ------------------------------
 
 - :option:`HungarianNotation.General.TreatStructAsClass`
 
 - :option:`HungarianNotation.DerivedType.Array`
 - :option:`HungarianNotation.DerivedType.Pointer`
 - :option:`HungarianNotation.DerivedType.FunctionPointer`
 
-- :option:`HungarianNotation.CString.CharPrinter`
+- :option:`HungarianNotation.CString.CharPointer`
 - :option:`HungarianNotation.CString.CharArray`
-- :option:`HungarianNotation.CString.WideCharPrinter`
+- :option:`HungarianNotation.CString.WideCharPointer`
 - :option:`HungarianNotation.CString.WideCharArray`
 
 - :option:`HungarianNotation.PrimitiveType.*`
 - :option:`HungarianNotation.UserDefinedType.*`
 
 .. option:: HungarianNotation.General.TreatStructAsClass
 
     When defined, the check will treat naming of struct as a class.
.. code-block:: c++
     // Pointer
     void *pDataBuffer = NULL;
 
     // FunctionPointer
     typedef void (*FUNC_PTR)();
     FUNC_PTR fnFuncPtr = NULL;
 
 
-.. option:: HungarianNotation.CString.CharPrinter
+.. option:: HungarianNotation.CString.CharPointer
 
     When defined, the check will ensure variable name will add the prefix with
     the given string. The default prefix is `sz`.
 
 .. option:: HungarianNotation.CString.CharArray
 
     When defined, the check will ensure variable name will add the prefix with
     the given string. The default prefix is `sz`.
 
-.. option:: HungarianNotation.CString.WideCharPrinter
+.. option:: HungarianNotation.CString.WideCharPointer
 
     When defined, the check will ensure variable name will add the prefix with
     the given string. The default prefix is `wsz`.
 
 .. option:: HungarianNotation.CString.WideCharArray
 
     When defined, the check will ensure variable name will add the prefix with
     the given string. The default prefix is `wsz`.
 
 
 Before:
 
 .. code-block:: c++
 
-    // CharPrinter
+    // CharPointer
     const char *NamePtr = "Name";
 
     // CharArray
     const char NameArray[] = "Name";
 
-    // WideCharPrinter
+    // WideCharPointer
     const wchar_t *WideNamePtr = L"Name";
 
     // WideCharArray
     const wchar_t WideNameArray[] = L"Name";
 
 After:
 
 .. code-block:: c++
 
-    // CharPrinter
+    // CharPointer
     const char *szNamePtr = "Name";
 
     // CharArray
     const char szNameArray[] = "Name";
 
-    // WideCharPrinter
+    // WideCharPointer
     const wchar_t *wszWideNamePtr = L"Name";
 
     // WideCharArray
     const wchar_t wszWideNameArray[] = L"Name";
 
 
 .. option:: HungarianNotation.PrimitiveType.*
 

clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/identifier-naming/hungarian-notation2/.clang-tidy

CheckOptions:
   - key:    readability-identifier-naming.HungarianNotation.General.TreatStructAsClass
     value:  true
   - key:    readability-identifier-naming.HungarianNotation.DerivedType.Array
     value:  custa
   - key:    readability-identifier-naming.HungarianNotation.DerivedType.Pointer
     value:  custp
   - key:    readability-identifier-naming.HungarianNotation.DerivedType.FunctionPointer
     value:  custfn
-  - key:    readability-identifier-naming.HungarianNotation.CString.CharPrinter
+  - key:    readability-identifier-naming.HungarianNotation.CString.CharPointer
     value:  custsz
   - key:    readability-identifier-naming.HungarianNotation.CString.CharArray
     value:  custsz
-  - key:    readability-identifier-naming.HungarianNotation.CString.WideCharPrinter
+  - key:    readability-identifier-naming.HungarianNotation.CString.WideCharPointer
     value:  custwsz
   - key:    readability-identifier-naming.HungarianNotation.CString.WideCharArray
     value:  custwsz
   - key:    readability-identifier-naming.HungarianNotation.PrimitiveType.int8_t
     value:  custi8
   - key:    readability-identifier-naming.HungarianNotation.PrimitiveType.int16_t
     value:  custi16
   - key:    readability-identifier-naming.HungarianNotation.PrimitiveType.int32_t