[flang-commits] [flang] eaff200 - [Flang] Move markdown files(.MD) from documentation/ to docs/
Sameeran joshi via flang-commits
flang-commits at lists.llvm.org
Tue Aug 18 02:46:04 PDT 2020
Author: sameeran joshi
Date: 2020-08-18T15:14:15+05:30
New Revision: eaff200429a3dcf36eebfae39d2e859d6815285e
URL: https://github.com/llvm/llvm-project/commit/eaff200429a3dcf36eebfae39d2e859d6815285e
DIFF: https://github.com/llvm/llvm-project/commit/eaff200429a3dcf36eebfae39d2e859d6815285e.diff
LOG: [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
Added:
flang/docs/ArrayComposition.md
flang/docs/BijectiveInternalNameUniquing.md
flang/docs/C++17.md
flang/docs/C++style.md
flang/docs/Calls.md
flang/docs/Character.md
flang/docs/ControlFlowGraph.md
flang/docs/Directives.md
flang/docs/Extensions.md
flang/docs/FortranForCProgrammers.md
flang/docs/FortranIR.md
flang/docs/IORuntimeInternals.md
flang/docs/ImplementingASemanticCheck.md
flang/docs/Intrinsics.md
flang/docs/LabelResolution.md
flang/docs/ModFiles.md
flang/docs/OpenMP-4.5-grammar.txt
flang/docs/OpenMP-semantics.md
flang/docs/OptionComparison.md
flang/docs/Overview.md
flang/docs/ParserCombinators.md
flang/docs/Parsing.md
flang/docs/Preprocessing.md
flang/docs/PullRequestChecklist.md
flang/docs/RuntimeDescriptor.md
flang/docs/Semantics.md
flang/docs/f2018-grammar.txt
flang/docs/flang-c-style.el
Modified:
flang/README.md
flang/lib/Evaluate/intrinsics.cpp
Removed:
flang/documentation/ArrayComposition.md
flang/documentation/BijectiveInternalNameUniquing.md
flang/documentation/C++17.md
flang/documentation/C++style.md
flang/documentation/Calls.md
flang/documentation/Character.md
flang/documentation/ControlFlowGraph.md
flang/documentation/Directives.md
flang/documentation/Extensions.md
flang/documentation/FortranForCProgrammers.md
flang/documentation/FortranIR.md
flang/documentation/IORuntimeInternals.md
flang/documentation/ImplementingASemanticCheck.md
flang/documentation/Intrinsics.md
flang/documentation/LabelResolution.md
flang/documentation/ModFiles.md
flang/documentation/OpenMP-4.5-grammar.txt
flang/documentation/OpenMP-semantics.md
flang/documentation/OptionComparison.md
flang/documentation/Overview.md
flang/documentation/ParserCombinators.md
flang/documentation/Parsing.md
flang/documentation/Preprocessing.md
flang/documentation/PullRequestChecklist.md
flang/documentation/RuntimeDescriptor.md
flang/documentation/Semantics.md
flang/documentation/f2018-grammar.txt
flang/documentation/flang-c-style.el
################################################################################
diff --git a/flang/README.md b/flang/README.md
index f7797ed55bd3..44573ae4b9b6 100644
--- a/flang/README.md
+++ b/flang/README.md
@@ -8,30 +8,30 @@ F18 was subsequently accepted into the LLVM project and rechristened as Flang.
## Getting Started
-Read more about flang in the [documentation directory](documentation).
-Start with the [compiler overview](documentation/Overview.md).
+Read more about flang in the [docs directory](docs).
+Start with the [compiler overview](docs/Overview.md).
To better understand Fortran as a language
and the specific grammar accepted by flang,
-read [Fortran For C Programmers](documentation/FortranForCProgrammers.md)
+read [Fortran For C Programmers](docs/FortranForCProgrammers.md)
and
-flang's specifications of the [Fortran grammar](documentation/f2018-grammar.txt)
+flang's specifications of the [Fortran grammar](docs/f2018-grammar.txt)
and
-the [OpenMP grammar](documentation/OpenMP-4.5-grammar.txt).
+the [OpenMP grammar](docs/OpenMP-4.5-grammar.txt).
Treatment of language extensions is covered
-in [this document](documentation/Extensions.md).
+in [this document](docs/Extensions.md).
To understand the compilers handling of intrinsics,
-see the [discussion of intrinsics](documentation/Intrinsics.md).
+see the [discussion of intrinsics](docs/Intrinsics.md).
To understand how a flang program communicates with libraries at runtime,
-see the discussion of [runtime descriptors](documentation/RuntimeDescriptor.md).
+see the discussion of [runtime descriptors](docs/RuntimeDescriptor.md).
If you're interested in contributing to the compiler,
-read the [style guide](documentation/C++style.md)
+read the [style guide](docs/C++style.md)
and
-also review [how flang uses modern C++ features](documentation/C++17.md).
+also review [how flang uses modern C++ features](docs/C++17.md).
## Supported C++ compilers
diff --git a/flang/documentation/ArrayComposition.md b/flang/docs/ArrayComposition.md
similarity index 99%
rename from flang/documentation/ArrayComposition.md
rename to flang/docs/ArrayComposition.md
index 099909c5ef0d..0f30af39f9e4 100644
--- a/flang/documentation/ArrayComposition.md
+++ b/flang/docs/ArrayComposition.md
@@ -1,4 +1,4 @@
-<!--===- documentation/ArrayComposition.md
+<!--===- docs/ArrayComposition.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/BijectiveInternalNameUniquing.md b/flang/docs/BijectiveInternalNameUniquing.md
similarity index 100%
rename from flang/documentation/BijectiveInternalNameUniquing.md
rename to flang/docs/BijectiveInternalNameUniquing.md
diff --git a/flang/documentation/C++17.md b/flang/docs/C++17.md
similarity index 99%
rename from flang/documentation/C++17.md
rename to flang/docs/C++17.md
index 18ea0b23e70e..87d5fc01f092 100644
--- a/flang/documentation/C++17.md
+++ b/flang/docs/C++17.md
@@ -1,4 +1,4 @@
-<!--===- documentation/C++17.md
+<!--===- docs/C++17.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/C++style.md b/flang/docs/C++style.md
similarity index 99%
rename from flang/documentation/C++style.md
rename to flang/docs/C++style.md
index ca532463ae83..4ab95393d758 100644
--- a/flang/documentation/C++style.md
+++ b/flang/docs/C++style.md
@@ -1,4 +1,4 @@
-<!--===- documentation/C++style.md
+<!--===- docs/C++style.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/Calls.md b/flang/docs/Calls.md
similarity index 99%
rename from flang/documentation/Calls.md
rename to flang/docs/Calls.md
index 79f0d972bc73..d70bc910d73d 100644
--- a/flang/documentation/Calls.md
+++ b/flang/docs/Calls.md
@@ -1,4 +1,4 @@
-<!--===- documentation/Calls.md
+<!--===- docs/Calls.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/Character.md b/flang/docs/Character.md
similarity index 99%
rename from flang/documentation/Character.md
rename to flang/docs/Character.md
index d1c7ca479a17..700db864f2da 100644
--- a/flang/documentation/Character.md
+++ b/flang/docs/Character.md
@@ -1,4 +1,4 @@
-<!--===- documentation/Character.md
+<!--===- docs/Character.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/ControlFlowGraph.md b/flang/docs/ControlFlowGraph.md
similarity index 99%
rename from flang/documentation/ControlFlowGraph.md
rename to flang/docs/ControlFlowGraph.md
index 6ed9183daf7c..b2b549845ebb 100644
--- a/flang/documentation/ControlFlowGraph.md
+++ b/flang/docs/ControlFlowGraph.md
@@ -1,4 +1,4 @@
-<!--===- documentation/ControlFlowGraph.md
+<!--===- docs/ControlFlowGraph.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/Directives.md b/flang/docs/Directives.md
similarity index 92%
rename from flang/documentation/Directives.md
rename to flang/docs/Directives.md
index e178a69714cc..c2e93c5f3de2 100644
--- a/flang/documentation/Directives.md
+++ b/flang/docs/Directives.md
@@ -1,4 +1,4 @@
-<!--===- documentation/Directives.md
+<!--===- docs/Directives.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/Extensions.md b/flang/docs/Extensions.md
similarity index 99%
rename from flang/documentation/Extensions.md
rename to flang/docs/Extensions.md
index 8bf5647bd60c..eaa600e2eea0 100644
--- a/flang/documentation/Extensions.md
+++ b/flang/docs/Extensions.md
@@ -1,4 +1,4 @@
-<!--===- documentation/Extensions.md
+<!--===- docs/Extensions.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/FortranForCProgrammers.md b/flang/docs/FortranForCProgrammers.md
similarity index 99%
rename from flang/documentation/FortranForCProgrammers.md
rename to flang/docs/FortranForCProgrammers.md
index ce4a0b7072b0..103def2a92ce 100644
--- a/flang/documentation/FortranForCProgrammers.md
+++ b/flang/docs/FortranForCProgrammers.md
@@ -1,4 +1,4 @@
-<!--===- documentation/FortranForCProgrammers.md
+<!--===- docs/FortranForCProgrammers.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/FortranIR.md b/flang/docs/FortranIR.md
similarity index 99%
rename from flang/documentation/FortranIR.md
rename to flang/docs/FortranIR.md
index ccdeb8fc4f56..5d83aaa8e34c 100644
--- a/flang/documentation/FortranIR.md
+++ b/flang/docs/FortranIR.md
@@ -1,4 +1,4 @@
-<!--===- documentation/FortranIR.md
+<!--===- docs/FortranIR.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/IORuntimeInternals.md b/flang/docs/IORuntimeInternals.md
similarity index 99%
rename from flang/documentation/IORuntimeInternals.md
rename to flang/docs/IORuntimeInternals.md
index c9b1ce4078ec..b4f3092a014e 100644
--- a/flang/documentation/IORuntimeInternals.md
+++ b/flang/docs/IORuntimeInternals.md
@@ -1,4 +1,4 @@
-<!--===- documentation/IORuntimeInternals.md
+<!--===- docs/IORuntimeInternals.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/ImplementingASemanticCheck.md b/flang/docs/ImplementingASemanticCheck.md
similarity index 99%
rename from flang/documentation/ImplementingASemanticCheck.md
rename to flang/docs/ImplementingASemanticCheck.md
index fc2e4f14061e..3bb16915cb88 100644
--- a/flang/documentation/ImplementingASemanticCheck.md
+++ b/flang/docs/ImplementingASemanticCheck.md
@@ -1,4 +1,4 @@
-<!--===- documentation/ImplementingASemanticCheck.md
+<!--===- docs/ImplementingASemanticCheck.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/Intrinsics.md b/flang/docs/Intrinsics.md
similarity index 99%
rename from flang/documentation/Intrinsics.md
rename to flang/docs/Intrinsics.md
index 8fd06766710c..7be0bf3e4a9c 100644
--- a/flang/documentation/Intrinsics.md
+++ b/flang/docs/Intrinsics.md
@@ -1,4 +1,4 @@
-<!--===- documentation/Intrinsics.md
+<!--===- docs/Intrinsics.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/LabelResolution.md b/flang/docs/LabelResolution.md
similarity index 99%
rename from flang/documentation/LabelResolution.md
rename to flang/docs/LabelResolution.md
index 87c7798c234e..e837b4fa6aec 100644
--- a/flang/documentation/LabelResolution.md
+++ b/flang/docs/LabelResolution.md
@@ -1,4 +1,4 @@
-<!--===- documentation/LabelResolution.md
+<!--===- docs/LabelResolution.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/ModFiles.md b/flang/docs/ModFiles.md
similarity index 99%
rename from flang/documentation/ModFiles.md
rename to flang/docs/ModFiles.md
index 7d7ceb4e0a0e..483341bdd0f4 100644
--- a/flang/documentation/ModFiles.md
+++ b/flang/docs/ModFiles.md
@@ -1,4 +1,4 @@
-<!--===- documentation/ModFiles.md
+<!--===- docs/ModFiles.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/OpenMP-4.5-grammar.txt b/flang/docs/OpenMP-4.5-grammar.txt
similarity index 99%
rename from flang/documentation/OpenMP-4.5-grammar.txt
rename to flang/docs/OpenMP-4.5-grammar.txt
index 01cfa1b65f94..c74072ba1ef2 100644
--- a/flang/documentation/OpenMP-4.5-grammar.txt
+++ b/flang/docs/OpenMP-4.5-grammar.txt
@@ -1,4 +1,4 @@
-#===-- documentation/OpenMP-4.5-grammar.txt --------------------------------===#
+#===-- docs/OpenMP-4.5-grammar.txt --------------------------------===#
#
# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
# See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/OpenMP-semantics.md b/flang/docs/OpenMP-semantics.md
similarity index 99%
rename from flang/documentation/OpenMP-semantics.md
rename to flang/docs/OpenMP-semantics.md
index 783acef6a4e0..4e2a81739cf8 100644
--- a/flang/documentation/OpenMP-semantics.md
+++ b/flang/docs/OpenMP-semantics.md
@@ -1,4 +1,4 @@
-<!--===- documentation/OpenMP-semantics.md
+<!--===- docs/OpenMP-semantics.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/OptionComparison.md b/flang/docs/OptionComparison.md
similarity index 99%
rename from flang/documentation/OptionComparison.md
rename to flang/docs/OptionComparison.md
index e8ccf57fbdf2..db5932411cc1 100644
--- a/flang/documentation/OptionComparison.md
+++ b/flang/docs/OptionComparison.md
@@ -1,4 +1,4 @@
-<!--===- documentation/OptionComparison.md
+<!--===- docs/OptionComparison.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/Overview.md b/flang/docs/Overview.md
similarity index 98%
rename from flang/documentation/Overview.md
rename to flang/docs/Overview.md
index 47ad18f023f9..75a8cd1c4cab 100644
--- a/flang/documentation/Overview.md
+++ b/flang/docs/Overview.md
@@ -1,4 +1,4 @@
-<!--===- documentation/Overview.md
+<!--===- docs/Overview.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/ParserCombinators.md b/flang/docs/ParserCombinators.md
similarity index 99%
rename from flang/documentation/ParserCombinators.md
rename to flang/docs/ParserCombinators.md
index 984a4d043439..4f3dc6fd07ae 100644
--- a/flang/documentation/ParserCombinators.md
+++ b/flang/docs/ParserCombinators.md
@@ -1,4 +1,4 @@
-<!--===- documentation/ParserCombinators.md
+<!--===- docs/ParserCombinators.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/Parsing.md b/flang/docs/Parsing.md
similarity index 99%
rename from flang/documentation/Parsing.md
rename to flang/docs/Parsing.md
index b961cd630ae1..fad9a4d57278 100644
--- a/flang/documentation/Parsing.md
+++ b/flang/docs/Parsing.md
@@ -1,4 +1,4 @@
-<!--===- documentation/Parsing.md
+<!--===- docs/Parsing.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/Preprocessing.md b/flang/docs/Preprocessing.md
similarity index 99%
rename from flang/documentation/Preprocessing.md
rename to flang/docs/Preprocessing.md
index eff3f921e43c..7f6f3951cfd1 100644
--- a/flang/documentation/Preprocessing.md
+++ b/flang/docs/Preprocessing.md
@@ -1,4 +1,4 @@
-<!--===- documentation/Preprocessing.md
+<!--===- docs/Preprocessing.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/PullRequestChecklist.md b/flang/docs/PullRequestChecklist.md
similarity index 98%
rename from flang/documentation/PullRequestChecklist.md
rename to flang/docs/PullRequestChecklist.md
index 9a43fa9b46e0..12a67be374a2 100644
--- a/flang/documentation/PullRequestChecklist.md
+++ b/flang/docs/PullRequestChecklist.md
@@ -1,4 +1,4 @@
-<!--===- documentation/PullRequestChecklist.md
+<!--===- docs/PullRequestChecklist.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/RuntimeDescriptor.md b/flang/docs/RuntimeDescriptor.md
similarity index 99%
rename from flang/documentation/RuntimeDescriptor.md
rename to flang/docs/RuntimeDescriptor.md
index bf8845265792..d819517fa979 100644
--- a/flang/documentation/RuntimeDescriptor.md
+++ b/flang/docs/RuntimeDescriptor.md
@@ -1,4 +1,4 @@
-<!--===- documentation/RuntimeDescriptor.md
+<!--===- docs/RuntimeDescriptor.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/Semantics.md b/flang/docs/Semantics.md
similarity index 99%
rename from flang/documentation/Semantics.md
rename to flang/docs/Semantics.md
index 3f185f9f52b8..6ea0b292de69 100644
--- a/flang/documentation/Semantics.md
+++ b/flang/docs/Semantics.md
@@ -1,4 +1,4 @@
-<!--===- documentation/Semantics.md
+<!--===- docs/Semantics.md
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/f2018-grammar.txt b/flang/docs/f2018-grammar.txt
similarity index 99%
rename from flang/documentation/f2018-grammar.txt
rename to flang/docs/f2018-grammar.txt
index 10d3747d1287..2de8cdfc1b8f 100644
--- a/flang/documentation/f2018-grammar.txt
+++ b/flang/docs/f2018-grammar.txt
@@ -1,4 +1,4 @@
-#===-- documentation/f2018-grammar.txt -------------------------------------===#
+#===-- docs/f2018-grammar.txt -------------------------------------===#
#
# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
# See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/documentation/flang-c-style.el b/flang/docs/flang-c-style.el
similarity index 92%
rename from flang/documentation/flang-c-style.el
rename to flang/docs/flang-c-style.el
index 001ab0750466..1749b5dd8570 100644
--- a/flang/documentation/flang-c-style.el
+++ b/flang/docs/flang-c-style.el
@@ -1,4 +1,4 @@
-;;===-- documentation/flang-c-style.el ------------------------------------===;;
+;;===-- docs/flang-c-style.el ------------------------------------===;;
;;
;; Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
;; See https://llvm.org/LICENSE.txt for license information.
diff --git a/flang/lib/Evaluate/intrinsics.cpp b/flang/lib/Evaluate/intrinsics.cpp
index ca9a91c98daf..9744c18fc2e4 100644
--- a/flang/lib/Evaluate/intrinsics.cpp
+++ b/flang/lib/Evaluate/intrinsics.cpp
@@ -30,7 +30,7 @@ class FoldingContext;
// This file defines the supported intrinsic procedures and implements
// their recognition and validation. It is largely table-driven. See
-// documentation/intrinsics.md and section 16 of the Fortran 2018 standard
+// docs/intrinsics.md and section 16 of the Fortran 2018 standard
// for full details on each of the intrinsics. Be advised, they have
// complicated details, and the design of these tables has to accommodate
// that complexity.
More information about the flang-commits
mailing list