Skip to content

Commit eaff200

Browse files
sameeran joshiSameeranjoshi
sameeran joshi
authored andcommitted
[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
1 parent 9b32ef9 commit eaff200

30 files changed

+38
-38
lines changed

flang/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,30 @@ F18 was subsequently accepted into the LLVM project and rechristened as Flang.
88

99
## Getting Started
1010

11-
Read more about flang in the [documentation directory](documentation).
12-
Start with the [compiler overview](documentation/Overview.md).
11+
Read more about flang in the [docs directory](docs).
12+
Start with the [compiler overview](docs/Overview.md).
1313

1414
To better understand Fortran as a language
1515
and the specific grammar accepted by flang,
16-
read [Fortran For C Programmers](documentation/FortranForCProgrammers.md)
16+
read [Fortran For C Programmers](docs/FortranForCProgrammers.md)
1717
and
18-
flang's specifications of the [Fortran grammar](documentation/f2018-grammar.txt)
18+
flang's specifications of the [Fortran grammar](docs/f2018-grammar.txt)
1919
and
20-
the [OpenMP grammar](documentation/OpenMP-4.5-grammar.txt).
20+
the [OpenMP grammar](docs/OpenMP-4.5-grammar.txt).
2121

2222
Treatment of language extensions is covered
23-
in [this document](documentation/Extensions.md).
23+
in [this document](docs/Extensions.md).
2424

2525
To understand the compilers handling of intrinsics,
26-
see the [discussion of intrinsics](documentation/Intrinsics.md).
26+
see the [discussion of intrinsics](docs/Intrinsics.md).
2727

2828
To understand how a flang program communicates with libraries at runtime,
29-
see the discussion of [runtime descriptors](documentation/RuntimeDescriptor.md).
29+
see the discussion of [runtime descriptors](docs/RuntimeDescriptor.md).
3030

3131
If you're interested in contributing to the compiler,
32-
read the [style guide](documentation/C++style.md)
32+
read the [style guide](docs/C++style.md)
3333
and
34-
also review [how flang uses modern C++ features](documentation/C++17.md).
34+
also review [how flang uses modern C++ features](docs/C++17.md).
3535

3636
## Supported C++ compilers
3737

flang/documentation/ArrayComposition.md renamed to flang/docs/ArrayComposition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/ArrayComposition.md
1+
<!--===- docs/ArrayComposition.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/C++17.md renamed to flang/docs/C++17.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/C++17.md
1+
<!--===- docs/C++17.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/C++style.md renamed to flang/docs/C++style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/C++style.md
1+
<!--===- docs/C++style.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/Calls.md renamed to flang/docs/Calls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/Calls.md
1+
<!--===- docs/Calls.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/Character.md renamed to flang/docs/Character.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/Character.md
1+
<!--===- docs/Character.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/ControlFlowGraph.md renamed to flang/docs/ControlFlowGraph.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/ControlFlowGraph.md
1+
<!--===- docs/ControlFlowGraph.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/Directives.md renamed to flang/docs/Directives.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/Directives.md
1+
<!--===- docs/Directives.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/Extensions.md renamed to flang/docs/Extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/Extensions.md
1+
<!--===- docs/Extensions.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/FortranForCProgrammers.md renamed to flang/docs/FortranForCProgrammers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/FortranForCProgrammers.md
1+
<!--===- docs/FortranForCProgrammers.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/FortranIR.md renamed to flang/docs/FortranIR.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/FortranIR.md
1+
<!--===- docs/FortranIR.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/IORuntimeInternals.md renamed to flang/docs/IORuntimeInternals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/IORuntimeInternals.md
1+
<!--===- docs/IORuntimeInternals.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/ImplementingASemanticCheck.md renamed to flang/docs/ImplementingASemanticCheck.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/ImplementingASemanticCheck.md
1+
<!--===- docs/ImplementingASemanticCheck.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/Intrinsics.md renamed to flang/docs/Intrinsics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/Intrinsics.md
1+
<!--===- docs/Intrinsics.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/LabelResolution.md renamed to flang/docs/LabelResolution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/LabelResolution.md
1+
<!--===- docs/LabelResolution.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/ModFiles.md renamed to flang/docs/ModFiles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/ModFiles.md
1+
<!--===- docs/ModFiles.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/OpenMP-4.5-grammar.txt renamed to flang/docs/OpenMP-4.5-grammar.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#===-- documentation/OpenMP-4.5-grammar.txt --------------------------------===#
1+
#===-- docs/OpenMP-4.5-grammar.txt --------------------------------===#
22
#
33
# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
# See https://llvm.org/LICENSE.txt for license information.

flang/documentation/OpenMP-semantics.md renamed to flang/docs/OpenMP-semantics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/OpenMP-semantics.md
1+
<!--===- docs/OpenMP-semantics.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/OptionComparison.md renamed to flang/docs/OptionComparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/OptionComparison.md
1+
<!--===- docs/OptionComparison.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/Overview.md renamed to flang/docs/Overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/Overview.md
1+
<!--===- docs/Overview.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/ParserCombinators.md renamed to flang/docs/ParserCombinators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/ParserCombinators.md
1+
<!--===- docs/ParserCombinators.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/Parsing.md renamed to flang/docs/Parsing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/Parsing.md
1+
<!--===- docs/Parsing.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/Preprocessing.md renamed to flang/docs/Preprocessing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/Preprocessing.md
1+
<!--===- docs/Preprocessing.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/PullRequestChecklist.md renamed to flang/docs/PullRequestChecklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/PullRequestChecklist.md
1+
<!--===- docs/PullRequestChecklist.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/RuntimeDescriptor.md renamed to flang/docs/RuntimeDescriptor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/RuntimeDescriptor.md
1+
<!--===- docs/RuntimeDescriptor.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/Semantics.md renamed to flang/docs/Semantics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--===- documentation/Semantics.md
1+
<!--===- docs/Semantics.md
22
33
Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
See https://llvm.org/LICENSE.txt for license information.

flang/documentation/f2018-grammar.txt renamed to flang/docs/f2018-grammar.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#===-- documentation/f2018-grammar.txt -------------------------------------===#
1+
#===-- docs/f2018-grammar.txt -------------------------------------===#
22
#
33
# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
# See https://llvm.org/LICENSE.txt for license information.

flang/documentation/flang-c-style.el renamed to flang/docs/flang-c-style.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
;;===-- documentation/flang-c-style.el ------------------------------------===;;
1+
;;===-- docs/flang-c-style.el ------------------------------------===;;
22
;;
33
;; Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
;; See https://llvm.org/LICENSE.txt for license information.

flang/lib/Evaluate/intrinsics.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class FoldingContext;
3030

3131
// This file defines the supported intrinsic procedures and implements
3232
// their recognition and validation. It is largely table-driven. See
33-
// documentation/intrinsics.md and section 16 of the Fortran 2018 standard
33+
// docs/intrinsics.md and section 16 of the Fortran 2018 standard
3434
// for full details on each of the intrinsics. Be advised, they have
3535
// complicated details, and the design of these tables has to accommodate
3636
// that complexity.

0 commit comments

Comments
 (0)