[all-commits] [llvm/llvm-project] b13448: [flang][docs][nfc] Refine FlangOptionsDocs.td

Andrzej Warzyński via All-commits all-commits at lists.llvm.org
Tue Aug 2 03:09:09 PDT 2022

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: b13448c56cf4d918d54ce6af063bcaa5f23f2118
  Author: Andrzej Warzynski <andrzej.warzynski at arm.com>
  Date:   2022-08-02 (Tue, 02 Aug 2022)

  Changed paths:
    M flang/docs/CMakeLists.txt
    A flang/docs/FlangOptionsDocs.td
    R flang/include/flang/FlangOptionsDocs.td

  Log Message:
  [flang][docs][nfc] Refine FlangOptionsDocs.td

Currently, FlangOptionsDocs.td doesn't specify `ExcludedFlags` which
means that in the generated documentation file we expose flags that:
  * we don't necessarily won't to advertise to our users (e.g. hidden flags), or
  * are not supported altogether (e.g. CL options).
This patch defines `ExcludeFlags` to fix that. The definition of
`ExcludeFlags` was copied from Clang so that LLVM frontends have
consistent documentation.

It might be a bit counter-intuitive that IncludeFlags alone is not
sufficient here. However, the current logic in ClangOptionDocEmitter.cpp
will parse IncludeFlags and print all options that contains one of the
included flags, as well as their aliases. So, for example, for -fopenmp
(which is a supported Flang option), one would also get /fopenmp (i.e.
CL mode equivalent for -fopenmp). By adding ExcludeFlags, we make sure
that such aliases are excluded.

I've also taken the liberty and moved FlangOptionsDocs.td. Originally it
was located in Flang's "flang/include" directory, but there shouldn't be
any implementation/documentation files there. Instead, I'm moving it to
the "flang/docs" directory.

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

More information about the All-commits mailing list