[flang-commits] [flang] 19b6e70 - [flang][docs] Update the top "doc" page

Andrzej Warzynski via flang-commits flang-commits at lists.llvm.org
Thu Feb 24 02:42:39 PST 2022


Author: Andrzej Warzynski
Date: 2022-02-24T10:41:53Z
New Revision: 19b6e70554996f44f8ba533c39c2596acc8ae0ef

URL: https://github.com/llvm/llvm-project/commit/19b6e70554996f44f8ba533c39c2596acc8ae0ef
DIFF: https://github.com/llvm/llvm-project/commit/19b6e70554996f44f8ba533c39c2596acc8ae0ef.diff

LOG: [flang][docs] Update the top "doc" page

* Added a note about "Classic Flang"
* sorted entries in ToC

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

Added: 
    

Modified: 
    flang/docs/index.md

Removed: 
    


################################################################################
diff  --git a/flang/docs/index.md b/flang/docs/index.md
index d1ea4dc2af953..555c0ccdb1437 100644
--- a/flang/docs/index.md
+++ b/flang/docs/index.md
@@ -1,6 +1,13 @@
 # Welcome to Flang's documentation
 
-Flang is LLVM's Fortran frontend
+Flang is LLVM's Fortran frontend that can be found
+[here](https://github.com/llvm/llvm-project/tree/main/flang). It is often
+referred to as "LLVM Flang" to 
diff erentiate itself from ["Classic
+Flang"](https://github.com/flang-compiler/flang) - these are two separate and
+independent Fortran compilers. LLVM Flang is under active development. While it
+is capable of generating executables for a number of examples, some
+functionality is still missing. See [GettingInvolved](GettingInvolved) for tips
+on how to get in touch with us and to learn more about the current status.
 
 ```eval_rst
 .. toctree::
@@ -15,12 +22,12 @@ Flang is LLVM's Fortran frontend
 .. toctree::
    :titlesonly:
 
-   GettingInvolved
-   FortranForCProgrammers
-   C++style
    C++17
-   PullRequestChecklist
+   C++style
+   FortranForCProgrammers
+   GettingInvolved
    ImplementingASemanticCheck
+   PullRequestChecklist
 ```
 
 # Design Documents
@@ -29,31 +36,32 @@ Flang is LLVM's Fortran frontend
 .. toctree::
    :titlesonly:
 
-   Overview
-   Preprocessing
-   Parsing
-   LabelResolution
-   ModFiles
-   Semantics
-   OpenMP-semantics
+   ArrayComposition
+   BijectiveInternalNameUniquing
+   Calls
+   Character
    ControlFlowGraph
-   FortranIR
-   IORuntimeInternals
-   f2018-grammar.md
-   OpenMP-4.5-grammar.md
    Directives
+   DoConcurrent
    Extensions
+   FlangDriver
+   FortranIR
+   FortranLLVMTestSuite
+   IORuntimeInternals
    Intrinsics
+   LabelResolution
+   ModFiles
+   OpenMP-4.5-grammar.md
+   OpenMP-semantics
    OptionComparison
+   Overview
    ParserCombinators
+   Parsing
+   Preprocessing
    RuntimeDescriptor
    RuntimeTypeInfo
-   Calls
-   Character
-   ArrayComposition
-   BijectiveInternalNameUniquing
-   DoConcurrent
-   FortranLLVMTestSuite
+   Semantics
+   f2018-grammar.md
 ```
 
 # Indices and tables


        


More information about the flang-commits mailing list