[flang-commits] [flang] b216999 - [fir][NFC] Add disclaimer to affine promotion/demotion passes

[Valentin Clement via flang-commits]

Author: Valentin Clement
Date: 2021-10-13T17:47:14+02:00
New Revision: b2169992aabea4bd896c6c57e7332d22868e2200

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

LOG: [fir][NFC] Add disclaimer to affine promotion/demotion passes

AffinePromotion and AffineDemotion passes where upstreamed
in their current status from fir-dev. In order to make sure everybody
is on the same page, this patch add some comments to state that.

Reviewed By: schweitz

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

Added: 
    

Modified: 
    flang/lib/Optimizer/Transforms/AffineDemotion.cpp
    flang/lib/Optimizer/Transforms/AffinePromotion.cpp

Removed: 
    


################################################################################
diff  --git a/flang/lib/Optimizer/Transforms/AffineDemotion.cpp b/flang/lib/Optimizer/Transforms/AffineDemotion.cpp
index 375a10224c6c..d774d974f7ab 100644
--- a/flang/lib/Optimizer/Transforms/AffineDemotion.cpp
+++ b/flang/lib/Optimizer/Transforms/AffineDemotion.cpp
@@ -5,6 +5,16 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
+//
+// This transformation is a prototype that demote affine dialects operations
+// after optimizations to FIR loops operations.
+// It is used after the AffinePromotion pass.
+// It is not part of the production pipeline and would need more work in order
+// to be used in production.
+// More information can be found in this presentation:
+// https://slides.com/rajanwalia/deck
+//
+//===----------------------------------------------------------------------===//
 
 #include "PassDetail.h"
 #include "flang/Optimizer/Dialect/FIRDialect.h"

diff  --git a/flang/lib/Optimizer/Transforms/AffinePromotion.cpp b/flang/lib/Optimizer/Transforms/AffinePromotion.cpp
index 2d290b66e4e4..a2614eb4047a 100644
--- a/flang/lib/Optimizer/Transforms/AffinePromotion.cpp
+++ b/flang/lib/Optimizer/Transforms/AffinePromotion.cpp
@@ -5,6 +5,15 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
+//
+// This transformation is a prototype that promote FIR loops operations
+// to affine dialect operations.
+// It is not part of the production pipeline and would need more work in order
+// to be used in production.
+// More information can be found in this presentation:
+// https://slides.com/rajanwalia/deck
+//
+//===----------------------------------------------------------------------===//
 
 #include "PassDetail.h"
 #include "flang/Optimizer/Dialect/FIRDialect.h"
@@ -31,8 +40,8 @@ struct AffineLoopAnalysis;
 struct AffineIfAnalysis;
 
 /// Stores analysis objects for all loops and if operations inside a function
-///  these analysis are used twice, first for marking operations for rewrite and
-///  second when doing rewrite.
+/// these analysis are used twice, first for marking operations for rewrite and
+/// second when doing rewrite.
 struct AffineFunctionAnalysis {
   explicit AffineFunctionAnalysis(mlir::FuncOp funcOp) {
     for (fir::DoLoopOp op : funcOp.getOps<fir::DoLoopOp>())