[all-commits] [llvm/llvm-project] 093aac: [clang][analyzer][doc] Migrate user-related docs ...

Endre Fülöp via All-commits all-commits at lists.llvm.org
Thu Jul 4 23:17:14 PDT 2024


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 093aaca2b0ad23ded5dcb45e8f837ffb7b21ffb3
      https://github.com/llvm/llvm-project/commit/093aaca2b0ad23ded5dcb45e8f837ffb7b21ffb3
  Author: Endre Fülöp <endre.fulop at sigmatechnology.com>
  Date:   2024-07-05 (Fri, 05 Jul 2024)

  Changed paths:
    A clang/docs/analyzer/images/analyzer_html.png
    A clang/docs/analyzer/images/analyzer_xcode.png
    A clang/docs/analyzer/images/scan_build_cmd.png
    M clang/docs/analyzer/user-docs.rst
    A clang/docs/analyzer/user-docs/CommandLineUsage.rst
    A clang/docs/analyzer/user-docs/FilingBugs.rst
    A clang/docs/analyzer/user-docs/Installation.rst
    A clang/docs/analyzer/user-docs/UsingWithXCode.rst
    M clang/www/analyzer/codechecker.html
    M clang/www/analyzer/command-line.html
    M clang/www/analyzer/filing_bugs.html
    M clang/www/analyzer/index.html
    M clang/www/analyzer/installation.html
    R clang/www/analyzer/latest_checker.html.incl
    M clang/www/analyzer/scan-build.html
    M clang/www/analyzer/xcode.html

  Log Message:
  -----------
   [clang][analyzer][doc] Migrate user-related docs from HTML to RST (#97034)



User documentation currently found at https://clang-analyzer.llvm.org is migrated to RST format.

This commit migrates all the relevant content, including suspicious or even clearly outdated parts. These issues will be cleaned up in separate follow-up commits (where the diff is not obscured by the format change). However, a few typos are fixed, and some parts (availability of binary releases, integration with XCode) are marked (with [Legacy] tags) to highlight that they are outdated.

The primary motivation for this change is to update the facts in the docs and make them discoverable from the RST-generated doc-tree as well (many subpages are not accessible at all, as the menu generation for the HTML-based page is not working at all).


This commit migrates all the relevant content, including parts that are
suspicious or even clearly outdated. These issues will be cleaned up in
separate follow-up commits (where the diff is not obscured by the format
change). However, a few typos are fixed and some parts (availability of
binary releases, integration with XCode) are marked (with [Legacy] tags)
to highlight that they are outdated.

The primary motivation for this change is to update the facts in the
docs and make them discoverable from the RST-generated doc-tree as well
(many subpages are not accessible **at all**, as the menu generation for
the HTML based page is not working at all).



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


More information about the All-commits mailing list