[all-commits] [llvm/llvm-project] db16ab: [Flang] Move markdown files(.MD) from documentatio...

sameeranjoshi via All-commits all-commits at lists.llvm.org
Mon Aug 31 04:58:00 PDT 2020


  Branch: refs/heads/release/11.x
  Home:   https://github.com/llvm/llvm-project
  Commit: db16ab428bbae15b5c157fd518574baecf63f8dc
      https://github.com/llvm/llvm-project/commit/db16ab428bbae15b5c157fd518574baecf63f8dc
  Author: sameeran joshi <sameeranjayant.joshi at amd.com>
  Date:   2020-08-31 (Mon, 31 Aug 2020)

  Changed paths:
    M flang/README.md
    A flang/docs/ArrayComposition.md
    A flang/docs/BijectiveInternalNameUniquing.md
    A flang/docs/C++17.md
    A flang/docs/C++style.md
    A flang/docs/Calls.md
    A flang/docs/Character.md
    A flang/docs/ControlFlowGraph.md
    A flang/docs/Directives.md
    A flang/docs/Extensions.md
    A flang/docs/FortranForCProgrammers.md
    A flang/docs/FortranIR.md
    A flang/docs/IORuntimeInternals.md
    A flang/docs/ImplementingASemanticCheck.md
    A flang/docs/Intrinsics.md
    A flang/docs/LabelResolution.md
    A flang/docs/ModFiles.md
    A flang/docs/OpenMP-4.5-grammar.txt
    A flang/docs/OpenMP-semantics.md
    A flang/docs/OptionComparison.md
    A flang/docs/Overview.md
    A flang/docs/ParserCombinators.md
    A flang/docs/Parsing.md
    A flang/docs/Preprocessing.md
    A flang/docs/PullRequestChecklist.md
    A flang/docs/RuntimeDescriptor.md
    A flang/docs/Semantics.md
    A flang/docs/f2018-grammar.txt
    A flang/docs/flang-c-style.el
    R flang/documentation/ArrayComposition.md
    R flang/documentation/BijectiveInternalNameUniquing.md
    R flang/documentation/C++17.md
    R flang/documentation/C++style.md
    R flang/documentation/Calls.md
    R flang/documentation/Character.md
    R flang/documentation/ControlFlowGraph.md
    R flang/documentation/Directives.md
    R flang/documentation/Extensions.md
    R flang/documentation/FortranForCProgrammers.md
    R flang/documentation/FortranIR.md
    R flang/documentation/IORuntimeInternals.md
    R flang/documentation/ImplementingASemanticCheck.md
    R flang/documentation/Intrinsics.md
    R flang/documentation/LabelResolution.md
    R flang/documentation/ModFiles.md
    R flang/documentation/OpenMP-4.5-grammar.txt
    R flang/documentation/OpenMP-semantics.md
    R flang/documentation/OptionComparison.md
    R flang/documentation/Overview.md
    R flang/documentation/ParserCombinators.md
    R flang/documentation/Parsing.md
    R flang/documentation/Preprocessing.md
    R flang/documentation/PullRequestChecklist.md
    R flang/documentation/RuntimeDescriptor.md
    R flang/documentation/Semantics.md
    R flang/documentation/f2018-grammar.txt
    R flang/documentation/flang-c-style.el
    M flang/lib/Evaluate/intrinsics.cpp

  Log Message:
  -----------
  [Flang] Move markdown files(.MD) from documentation/ to docs/

Summary:
Other LLVM sub-projects use docs/ folder for documentation files.
Follow LLVM project policy.
Modify `documentation/` references in sources to `docs/`.
This patch doesn't modify files to reStructuredText(.rst) file format.

Reviewed By: DavidTruby, sscalpone

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

(cherry picked from commit eaff200429a3dcf36eebfae39d2e859d6815285e)


  Commit: e6b4ec963a0b303a5b9d193f8dfb0ae4ea09d66b
      https://github.com/llvm/llvm-project/commit/e6b4ec963a0b303a5b9d193f8dfb0ae4ea09d66b
  Author: Sameeran joshi <joshisameeran17 at gmail.com>
  Date:   2020-08-31 (Mon, 31 Aug 2020)

  Changed paths:
    M flang/README.md
    M flang/docs/conf.py

  Log Message:
  -----------
  [FLANG] Pick `.md` files when building sphinx documentation.

Need to build sphinx using below flags to Cmake
`-DLLVM_ENABLE_SPHINX=ON -DSPHINX_WARNINGS_AS_ERRORS=OFF`.
Generate html docs using cmake target
`docs-flang-html`
Generated html files should be at `build/tools/flang/docs/html`.
Patch in series from the dicussion on review
https://reviews.llvm.org/D85828

After this patch the markdown docmentation must be written using guide in-
`llvm/docs/MarkdownQuickstartTemplate.md`

Reviewed By: sscalpone

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

(cherry picked from commit bc9cdfa12bde46c77bcc6450707f2714133e9b2f)


Compare: https://github.com/llvm/llvm-project/compare/2c6a593b5e18...e6b4ec963a0b


More information about the All-commits mailing list