[Mlir-commits] [mlir] 55de49a - [mlir][docs] Refactor the layout of the docs folder

[River Riddle]

Author: River Riddle
Date: 2020-04-11T11:47:01-07:00
New Revision: 55de49ac1c3c4ae0d4ff5de54c25cf832e756e75

URL: https://github.com/llvm/llvm-project/commit/55de49ac1c3c4ae0d4ff5de54c25cf832e756e75
DIFF: https://github.com/llvm/llvm-project/commit/55de49ac1c3c4ae0d4ff5de54c25cf832e756e75.diff

LOG: [mlir][docs] Refactor the layout of the docs folder

Summary:
This revision performs a few refactorings on the main docs folder. Namely it:
* Adds a new Rationale/ folder to contain various rationale documents
* Moves several "getting started" documents to the Tutorials/ folder
* Cleans up the titles of various documents

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

Added: 
    mlir/docs/PassManagement.md
    mlir/docs/Rationale/MLIRForGraphAlgorithms.md
    mlir/docs/Rationale/Rationale.md
    mlir/docs/Rationale/RationaleLinalgDialect.md
    mlir/docs/Rationale/RationaleSimplifiedPolyhedralForm.md
    mlir/docs/Rationale/UsageOfConst.md
    mlir/docs/Tutorials/CreatingADialect.md
    mlir/docs/Tutorials/DefiningAttributesAndTypes.md
    mlir/docs/Tutorials/QuickstartRewrites.md

Modified: 
    mlir/docs/Diagnostics.md
    mlir/docs/Interfaces.md
    mlir/docs/LangRef.md
    mlir/docs/ShapeInference.md
    mlir/docs/Traits.md

Removed: 
    mlir/docs/CreatingADialect.md
    mlir/docs/DefiningAttributesAndTypes.md
    mlir/docs/MLIRForGraphAlgorithms.md
    mlir/docs/QuickstartRewrites.md
    mlir/docs/Rationale.md
    mlir/docs/RationaleLinalgDialect.md
    mlir/docs/RationaleSimplifiedPolyhedralForm.md
    mlir/docs/UsageOfConst.md
    mlir/docs/WritingAPass.md


################################################################################
diff  --git a/mlir/docs/Diagnostics.md b/mlir/docs/Diagnostics.md
index d33c35dd3e4b..f504e97c74c8 100644
--- a/mlir/docs/Diagnostics.md
+++ b/mlir/docs/Diagnostics.md
@@ -1,4 +1,4 @@
-# Introduction and Usage Guide to MLIR's Diagnostics Infrastructure
+# Diagnostic Infrastructure
 
 [TOC]
 

diff  --git a/mlir/docs/Interfaces.md b/mlir/docs/Interfaces.md
index 16422a104582..bc594c23d978 100644
--- a/mlir/docs/Interfaces.md
+++ b/mlir/docs/Interfaces.md
@@ -1,4 +1,4 @@
-# Introduction to MLIR Interfaces
+# MLIR Interfaces
 
 MLIR is generic and very extensible; it allows for opaquely representing many
 
diff erent dialects that have their own operations, attributes, types, and so on.

diff  --git a/mlir/docs/LangRef.md b/mlir/docs/LangRef.md
index ad507dc15971..f7e133a2820e 100644
--- a/mlir/docs/LangRef.md
+++ b/mlir/docs/LangRef.md
@@ -1,4 +1,4 @@
-# MLIR Specification
+# MLIR Language Reference
 
 MLIR (Multi-Level IR) is a compiler intermediate representation with
 similarities to traditional three-address SSA representations (like

diff  --git a/mlir/docs/WritingAPass.md b/mlir/docs/PassManagement.md
similarity index 99%
rename from mlir/docs/WritingAPass.md
rename to mlir/docs/PassManagement.md
index 0da9fd4911d8..e807c800f8d3 100644
--- a/mlir/docs/WritingAPass.md
+++ b/mlir/docs/PassManagement.md
@@ -1,4 +1,4 @@
-# Writing a Pass
+# Pass Infrastructure
 
 [TOC]
 

diff  --git a/mlir/docs/MLIRForGraphAlgorithms.md b/mlir/docs/Rationale/MLIRForGraphAlgorithms.md
similarity index 100%
rename from mlir/docs/MLIRForGraphAlgorithms.md
rename to mlir/docs/Rationale/MLIRForGraphAlgorithms.md

diff  --git a/mlir/docs/Rationale.md b/mlir/docs/Rationale/Rationale.md
similarity index 100%
rename from mlir/docs/Rationale.md
rename to mlir/docs/Rationale/Rationale.md

diff  --git a/mlir/docs/RationaleLinalgDialect.md b/mlir/docs/Rationale/RationaleLinalgDialect.md
similarity index 100%
rename from mlir/docs/RationaleLinalgDialect.md
rename to mlir/docs/Rationale/RationaleLinalgDialect.md

diff  --git a/mlir/docs/RationaleSimplifiedPolyhedralForm.md b/mlir/docs/Rationale/RationaleSimplifiedPolyhedralForm.md
similarity index 100%
rename from mlir/docs/RationaleSimplifiedPolyhedralForm.md
rename to mlir/docs/Rationale/RationaleSimplifiedPolyhedralForm.md

diff  --git a/mlir/docs/UsageOfConst.md b/mlir/docs/Rationale/UsageOfConst.md
similarity index 100%
rename from mlir/docs/UsageOfConst.md
rename to mlir/docs/Rationale/UsageOfConst.md

diff  --git a/mlir/docs/ShapeInference.md b/mlir/docs/ShapeInference.md
index cbe544ceef89..0a6448355fec 100644
--- a/mlir/docs/ShapeInference.md
+++ b/mlir/docs/ShapeInference.md
@@ -1,4 +1,4 @@
-# Shape inference
+# Shape Inference
 
 Shape inference as discussed here is considered a specific instance of type
 inference for [ShapedType][ShapedType]. Type constraints are along (at least)

diff  --git a/mlir/docs/Traits.md b/mlir/docs/Traits.md
index 1035b6cd6e78..55dabfb7f755 100644
--- a/mlir/docs/Traits.md
+++ b/mlir/docs/Traits.md
@@ -1,4 +1,4 @@
-# Introduction to MLIR Operation Traits
+# MLIR Operation Traits
 
 [TOC]
 

diff  --git a/mlir/docs/CreatingADialect.md b/mlir/docs/Tutorials/CreatingADialect.md
similarity index 100%
rename from mlir/docs/CreatingADialect.md
rename to mlir/docs/Tutorials/CreatingADialect.md

diff  --git a/mlir/docs/DefiningAttributesAndTypes.md b/mlir/docs/Tutorials/DefiningAttributesAndTypes.md
similarity index 99%
rename from mlir/docs/DefiningAttributesAndTypes.md
rename to mlir/docs/Tutorials/DefiningAttributesAndTypes.md
index 21953c050489..1c01caf71cb0 100644
--- a/mlir/docs/DefiningAttributesAndTypes.md
+++ b/mlir/docs/Tutorials/DefiningAttributesAndTypes.md
@@ -1,4 +1,4 @@
-# Quickstart tutorial to defining custom dialect attributes and types
+# Defining Dialect Attributes and Types
 
 This document is a quickstart to defining dialect specific extensions to the
 [attribute](LangRef.md#attributes) and [type system](LangRef.md#type-system).

diff  --git a/mlir/docs/QuickstartRewrites.md b/mlir/docs/Tutorials/QuickstartRewrites.md
similarity index 100%
rename from mlir/docs/QuickstartRewrites.md
rename to mlir/docs/Tutorials/QuickstartRewrites.md