[all-commits] [llvm/llvm-project] 21e58e: [NFC][analyzer][docs] Migrate 'annotations.html' t...

[Donát Nagy via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 21e58ee9f7de60a7e9202ad3f424ec3ad5a6fce5
      https://github.com/llvm/llvm-project/commit/21e58ee9f7de60a7e9202ad3f424ec3ad5a6fce5
  Author: Donát Nagy <donat.nagy at ericsson.com>
  Date:   2025-01-13 (Mon, 13 Jan 2025)

  Changed paths:
    M clang/docs/LanguageExtensions.rst
    M clang/docs/UsersManual.rst
    A clang/docs/analyzer/images/example_attribute_nonnull.png
    A clang/docs/analyzer/images/example_cf_returns_retained.png
    A clang/docs/analyzer/images/example_ns_returns_retained.png
    M clang/docs/analyzer/user-docs.rst
    A clang/docs/analyzer/user-docs/Annotations.rst
    M clang/docs/analyzer/user-docs/FAQ.rst
    M clang/include/clang/Basic/AttrDocs.td
    M clang/www/analyzer/annotations.html
    R clang/www/analyzer/images/example_attribute_nonnull.png
    R clang/www/analyzer/images/example_cf_returns_retained.png
    R clang/www/analyzer/images/example_ns_returns_retained.png

  Log Message:
  -----------
  [NFC][analyzer][docs] Migrate 'annotations.html' to RST (#122246)

This commit migrates the contents of 'annotations.html' in the old
HTML-based documentation of the Clang static analyzer to the new
RST-based documentation.

During this conversion I reordered the sections of this documentation
file by placing the section "Custom Assertion Handlers" as a subsection
of "Annotations to Enhance Generic Checks". (The primary motivation was
that Sphinx complained about inconsistent section levels; with this
change I preserved that sections describing individual annotations are
all on the same level.)

Apart from this change and the format conversion, I didn't review,
validate or edit the contents of this documentation file because I think
it would be better to place any additional changes in separate commits.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications