DylanFleming-arm created this revision. Herald added subscribers: arphaman, mgorny. Herald added a reviewer: sscalpone. Herald added projects: Flang, All. DylanFleming-arm requested review of this revision. Herald added subscribers: cfe-commits, jdoerfert. Herald added a project: clang.
This patch aims to create a webpage to document Flang's command line options on https://flang.llvm.org/docs/ in a similar way to Clang's https://clang.llvm.org/docs/ClangCommandLineReference.html This is done by using clang tablegen to generate an .rst file from options.td (which is current shared with clang) For this to work, ClangOptionDocEmitter.cpp was updated to allow specific flang flags to be included, rather than bulk excluding clang flags. Repository: rG LLVM Github Monorepo https://reviews.llvm.org/D129864 Files: clang/utils/TableGen/ClangOptionDocEmitter.cpp flang/docs/CMakeLists.txt flang/docs/index.md flang/include/flang/FlangOptionsDocs.td
Index: flang/include/flang/FlangOptionsDocs.td =================================================================== --- /dev/null +++ flang/include/flang/FlangOptionsDocs.td @@ -0,0 +1,35 @@ +//==--- FlangOptionDocs.td - Option documentation -------------------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +def GlobalDocumentation { + code Intro =[{.. + ------------------------------------------------------------------- + NOTE: This file is automatically generated by running clang-tblgen + -gen-opt-docs. Do not edit this file by hand!! + ------------------------------------------------------------------- + +===================================== +Flang command line argument reference +===================================== +.. contents:: + :local: + +Introduction +============ + +}]; + + string Program = "flang"; + + list<string> ExcludedFlags = [""]; + list<string> IncludedFlags = ["FlangOption"]; + +} + + +include "../../../clang/include/clang/Driver/Options.td" Index: flang/docs/index.md =================================================================== --- flang/docs/index.md +++ flang/docs/index.md @@ -45,6 +45,7 @@ DoConcurrent Extensions FIRLangRef + FlangCommandLineReference FlangDriver FortranIR FortranLLVMTestSuite Index: flang/docs/CMakeLists.txt =================================================================== --- flang/docs/CMakeLists.txt +++ flang/docs/CMakeLists.txt @@ -91,6 +91,16 @@ endif() endif() +function (gen_rst_file_from_td output_file td_option source docs_target) + if (NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${source}") + message(FATAL_ERROR "Cannot find source file: ${source} in ${CMAKE_CURRENT_SOURCE_DIR}") + endif() + get_filename_component(TABLEGEN_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${source}" DIRECTORY) + list(APPEND LLVM_TABLEGEN_FLAGS "-I${TABLEGEN_INCLUDE_DIR}") + clang_tablegen(Source/${output_file} ${td_option} SOURCE ${source} TARGET "gen-${output_file}") + add_dependencies(${docs_target} "gen-${output_file}") +endfunction() + if (LLVM_ENABLE_SPHINX) include(AddSphinxTarget) if (SPHINX_FOUND) @@ -114,6 +124,7 @@ COMMAND "${Python3_EXECUTABLE}" ARGS ${CMAKE_CURRENT_BINARY_DIR}/Source/FIR/CreateFIRLangRef.py) + gen_rst_file_from_td(FlangCommandLineReference.rst -gen-opt-docs ../include/flang/FlangOptionsDocs.td docs-flang-html) endif() if (${SPHINX_OUTPUT_MAN}) add_sphinx_target(man flang) Index: clang/utils/TableGen/ClangOptionDocEmitter.cpp =================================================================== --- clang/utils/TableGen/ClangOptionDocEmitter.cpp +++ clang/utils/TableGen/ClangOptionDocEmitter.cpp @@ -168,6 +168,30 @@ return false; } +bool isIncluded(const Record *OptionOrGroup, const Record *DocInfo) { + if (!DocInfo->getValue("IncludedFlags")) + return true; + for (StringRef Inclusion : DocInfo->getValueAsListOfStrings("IncludedFlags")) + if (hasFlag(OptionOrGroup, Inclusion)) + return true; + return false; +} + +bool isGroupIncluded(const DocumentedGroup &Group, const Record *DocInfo) { + if (isIncluded(Group.Group, DocInfo)) + return true; + for (auto &O : Group.Options) + if (isIncluded(O.Option, DocInfo)) + return true; + for (auto &G : Group.Groups) { + if (isIncluded(G.Group, DocInfo)) + return true; + if (isGroupIncluded(G, DocInfo)) + return true; + } + return false; +} + bool isExcluded(const Record *OptionOrGroup, const Record *DocInfo) { // FIXME: Provide a flag to specify the set of exclusions. for (StringRef Exclusion : DocInfo->getValueAsListOfStrings("ExcludedFlags")) @@ -302,7 +326,7 @@ void emitOption(const DocumentedOption &Option, const Record *DocInfo, raw_ostream &OS) { - if (isExcluded(Option.Option, DocInfo)) + if (isExcluded(Option.Option, DocInfo) || !isIncluded(Option.Option, DocInfo)) return; if (Option.Option->getValueAsDef("Kind")->getName() == "KIND_UNKNOWN" || Option.Option->getValueAsDef("Kind")->getName() == "KIND_INPUT") @@ -376,7 +400,7 @@ void emitGroup(int Depth, const DocumentedGroup &Group, const Record *DocInfo, raw_ostream &OS) { - if (isExcluded(Group.Group, DocInfo)) + if (isExcluded(Group.Group, DocInfo) || !isGroupIncluded(Group, DocInfo)) return; emitHeading(Depth,
_______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
