[clang-tidy][doc] Deprecate the AnalyzeTemporaryDtors option

[carlosgalvezp]

Summary

It's not used anywhere, and we should not keep it
for eternity. Document it as deprecated and announce
its removal 2 releases later, so people have time
to update their .clang-tidy files.

[carlosgalvezp]

If we could get this in before 24th of January (release cut) it would be great, then we don't need to wait for clang-tidy 19 :)

[Eugene.Zelenko]

clang-tools-extra/docs/ReleaseNotes.rst

106

Clang-tidy

[carlosgalvezp]

Update clang-tidy formatting.

[carlosgalvezp]

clang-tools-extra/docs/ReleaseNotes.rst

106

I find current style in the documentation inconsistent, using either :program:clang-tidy or just plain clang-tidy as I have written it here, but never Clang-tidy with capital C and backticks. I'll go for the former.

[Eugene.Zelenko]

clang-tools-extra/docs/ReleaseNotes.rst

107

But isn't such naming artifact of packaging? May be ":program:clang-tidy" version 18?

[carlosgalvezp]

Fix name

[carlosgalvezp]

Thanks for reviewing! I can also add that the actual code using the option was removed around 5 years ago, so it's about time :) @njames93 Do you have any concerns with this?

[njames93]

In D141583#4047975, @carlosgalvezp wrote:

Thanks for reviewing! I can also add that the actual code using the option was removed around 5 years ago, so it's about time :) @njames93 Do you have any concerns with this?

Fine by me.

clang-tools-extra/clang-tidy/ClangTidyOptions.cpp

 }
 
 template <> struct MappingTraits<ClangTidyOptions> {
   static void mapping(IO &IO, ClangTidyOptions &Options) {
     bool Ignored = false;
     IO.mapOptional("Checks", Options.Checks);
     IO.mapOptional("WarningsAsErrors", Options.WarningsAsErrors);
     IO.mapOptional("HeaderFilterRegex", Options.HeaderFilterRegex);
-    IO.mapOptional("AnalyzeTemporaryDtors", Ignored); // legacy compatibility
+    IO.mapOptional("AnalyzeTemporaryDtors", Ignored); // deprecated
     IO.mapOptional("FormatStyle", Options.FormatStyle);
     IO.mapOptional("User", Options.User);
     IO.mapOptional("CheckOptions", Options.CheckOptions);
     IO.mapOptional("ExtraArgs", Options.ExtraArgs);
     IO.mapOptional("ExtraArgsBefore", Options.ExtraArgsBefore);
     IO.mapOptional("InheritParentConfig", Options.InheritParentConfig);
     IO.mapOptional("UseColor", Options.UseColor);
   }

clang-tools-extra/docs/ReleaseNotes.rst

 --------------------------
 
 - Change to Python 3 in the shebang of `add_new_check.py` and `rename_check.py`,
   as the existing code is not compatible with Python 2.
 
 - Fix a minor bug in `add_new_check.py` to only traverse subdirectories
   when updating the list of checks in the documentation.
 
+- Deprecate the global configuration file option `AnalyzeTemporaryDtors`,
+  which is no longer in use. The option will be fully removed in clang-tidy 18.
+
 New checks
 ^^^^^^^^^^
 
 - New :doc:`bugprone-suspicious-realloc-usage
   <clang-tidy/checks/bugprone/suspicious-realloc-usage>` check.
 
   Finds usages of ``realloc`` where the return value is assigned to the
   same expression as passed to the first argument.