[flang-commits] [flang] [flang][docs] Reorganize the table of contents (PR #171240)

Yusuke MINATO via flang-commits flang-commits at lists.llvm.org
Thu Dec 11 20:50:19 PST 2025


https://github.com/yus3710-fj updated https://github.com/llvm/llvm-project/pull/171240

>From 221352ada06604a6ba2a5bfc66747d0a15326bf2 Mon Sep 17 00:00:00 2001
From: Yusuke MINATO <minato.yusuke at fujitsu.com>
Date: Mon, 8 Dec 2025 10:19:11 +0900
Subject: [PATCH 1/3] [flang][docs] Reorganize the table of contents

This patch creates a section for user guidance.
---
 flang/docs/index.md | 24 ++++++++++++++++--------
 1 file changed, 16 insertions(+), 8 deletions(-)

diff --git a/flang/docs/index.md b/flang/docs/index.md
index 016577bcb1e98..4a4a7847b1c01 100644
--- a/flang/docs/index.md
+++ b/flang/docs/index.md
@@ -16,6 +16,22 @@ on how to get in touch with us and to learn more about the current status.
    ReleaseNotes
 ```
 
+# Using Flang
+
+```{eval-rst}
+.. toctree::
+   :titlesonly:
+
+   Directives
+   Extensions
+   FlangCommandLineReference
+   FortranStandardsSupport
+   GettingStarted
+   OpenMPSupport
+   OptionComparison
+   Real16MathSupport
+```
+
 # Contributing to Flang
 
 ```{eval-rst}
@@ -26,11 +42,8 @@ on how to get in touch with us and to learn more about the current status.
    C++style
    DesignGuideline
    FortranForCProgrammers
-   FortranStandardsSupport
    GettingInvolved
-   GettingStarted
    ImplementingASemanticCheck
-   OpenMPSupport
    PullRequestChecklist
 ```
 
@@ -51,14 +64,11 @@ on how to get in touch with us and to learn more about the current status.
    ComplexOperations
    ControlFlowGraph
    DebugGeneration
-   Directives
    DoConcurrent
    DoConcurrentConversionToOpenMP
-   Extensions
    F202X
    FIRArrayOperations
    FIRLangRef
-   FlangCommandLineReference
    FlangDriver
    FortranFeatureHistory
    FortranIR
@@ -76,7 +86,6 @@ on how to get in touch with us and to learn more about the current status.
    OpenMP-declare-target
    OpenMP-descriptor-management
    OpenMP-semantics
-   OptionComparison
    Overview
    ParallelMultiImageFortranRuntime
    ParameterizedDerivedTypes
@@ -91,7 +100,6 @@ on how to get in touch with us and to learn more about the current status.
    Semantics
    f2018-grammar.md
    fstack-arrays
-   Real16MathSupport
    Unsigned
 ```
 

>From ba4d0548dad38e02551741ed085dab166674f72d Mon Sep 17 00:00:00 2001
From: Yusuke MINATO <minato.yusuke at fujitsu.com>
Date: Wed, 10 Dec 2025 09:29:49 +0900
Subject: [PATCH 2/3] organize contents in a more "natural" order

---
 flang/docs/index.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/flang/docs/index.md b/flang/docs/index.md
index 4a4a7847b1c01..0aa6007548680 100644
--- a/flang/docs/index.md
+++ b/flang/docs/index.md
@@ -22,14 +22,14 @@ on how to get in touch with us and to learn more about the current status.
 .. toctree::
    :titlesonly:
 
-   Directives
-   Extensions
+   GettingStarted
    FlangCommandLineReference
    FortranStandardsSupport
-   GettingStarted
+   Extensions
+   Directives
    OpenMPSupport
-   OptionComparison
    Real16MathSupport
+   OptionComparison
 ```
 
 # Contributing to Flang

>From 3ac55b7654a564b80dc8a36723fa24736b450275 Mon Sep 17 00:00:00 2001
From: Yusuke MINATO <minato.yusuke at fujitsu.com>
Date: Wed, 10 Dec 2025 15:45:53 +0900
Subject: [PATCH 3/3] Address comments

---
 flang/docs/index.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/flang/docs/index.md b/flang/docs/index.md
index 0aa6007548680..0d29c22814e99 100644
--- a/flang/docs/index.md
+++ b/flang/docs/index.md
@@ -29,7 +29,7 @@ on how to get in touch with us and to learn more about the current status.
    Directives
    OpenMPSupport
    Real16MathSupport
-   OptionComparison
+   Unsigned
 ```
 
 # Contributing to Flang
@@ -86,6 +86,7 @@ on how to get in touch with us and to learn more about the current status.
    OpenMP-declare-target
    OpenMP-descriptor-management
    OpenMP-semantics
+   OptionComparison
    Overview
    ParallelMultiImageFortranRuntime
    ParameterizedDerivedTypes
@@ -100,7 +101,6 @@ on how to get in touch with us and to learn more about the current status.
    Semantics
    f2018-grammar.md
    fstack-arrays
-   Unsigned
 ```
 
 # Indices and tables



More information about the flang-commits mailing list