[all-commits] [llvm/llvm-project] 684ee2: [clang/docs] Fix various sphinx warnings/errors in...

Florian Hahn via All-commits all-commits at lists.llvm.org
Sat Mar 21 09:07:01 PDT 2020


  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: 684ee2057f5d695832314c2b0d7d4c1f2d30dab5
      https://github.com/llvm/llvm-project/commit/684ee2057f5d695832314c2b0d7d4c1f2d30dab5
  Author: Florian Hahn <flo at fhahn.com>
  Date:   2020-03-21 (Sat, 21 Mar 2020)

  Changed paths:
    M clang/docs/InternalsManual.rst
    M clang/docs/LanguageExtensions.rst
    M clang/docs/OpenMPSupport.rst
    M clang/docs/analyzer/checkers.rst
    M clang/docs/analyzer/developer-docs/DebugChecks.rst
    M clang/include/clang/Basic/AttrDocs.td
    M clang/include/clang/Basic/DiagnosticGroups.td

  Log Message:
  -----------
  [clang/docs] Fix various sphinx warnings/errors in docs.

There are a few places with unexpected indents that trip over sphinx and
other syntax errors.

Also, the C++ syntax highlighting does not work for
    class [[gsl::Owner(int)]] IntOwner {

Use a regular code:: block instead.

There are a few other warnings errors remaining, of the form
'Duplicate explicit target name: "cmdoption-clang--prefix"'. They seem
to be caused by the following
  .. option:: -B<dir>, --prefix <arg>, --prefix=<arg>

I am no Restructured Text expert, but it seems like sphinx 1.8.5
tries to generate the same target for the --prefix <arg> and
--prefix=<arg>. This pops up in a lot of places and I am not sure how to
best resolve it

Reviewers: jfb, Bigcheese, dexonsmith, rjmccall

Reviewed By: rjmccall

Differential Revision: https://reviews.llvm.org/D76534




More information about the All-commits mailing list