Skip to content

Commit 2f5a296

Browse files
Update function argument and CLI descriptions.
1 parent 738cc71 commit 2f5a296

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

mlir/include/mlir/Dialect/Transform/Transforms/TransformInterpreterPassBase.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,11 @@ LogicalResult interpreterBaseRunOnOperationImpl(
6262
/// transform script. If empty, `debugTransformRootTag` is considered or the
6363
/// pass root operation must contain a single top-level transform op that
6464
/// will be interpreted.
65-
/// - transformLibraryFileName: if non-empty, the name of the file containing
66-
/// definitions of external symbols referenced in the transform script.
67-
/// These definitions will be used to replace declarations.
65+
/// - transformLibraryFileName: if non-empty, the module in this file will be
66+
/// merged into the main transform script run by the interpreter before
67+
/// execution. This allows to provide definitions for external functions
68+
/// used in the main script. Other public symbols in the library module may
69+
/// lead to collisions with public symbols in the main script.
6870
/// - debugPayloadRootTag: if non-empty, the value of the attribute named
6971
/// `kTransformDialectTagAttrName` indicating the single op that is
7072
/// considered the payload root of the transform interpreter; otherwise, the
@@ -85,7 +87,7 @@ LogicalResult interpreterBaseRunOnOperationImpl(
8587
/// as template arguments. They are *not* expected to to implement `initialize`
8688
/// or `runOnOperation`. They *are* expected to call the copy constructor of
8789
/// this class in their copy constructors, short of which the file-based
88-
/// transform dialect script injection facility will become nonoperational.
90+
/// transform dialect script injection facility will become non-operational.
8991
///
9092
/// Concrete passes may implement the `runBeforeInterpreter` and
9193
/// `runAfterInterpreter` to customize the behavior of the pass.

mlir/test/lib/Dialect/Transform/TestTransformDialectInterpreter.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -218,9 +218,9 @@ class TestTransformDialectInterpreterPass
218218
"select the container of the top-level transform op.")};
219219
Option<std::string> transformLibraryFileName{
220220
*this, "transform-library-file-name", llvm::cl::init(""),
221-
llvm::cl::desc(
222-
"Optional name of the file containing transform dialect symbol "
223-
"definitions to be injected into the transform module.")};
221+
llvm::cl::desc("Optional name of a file with a module that should be "
222+
"merged into the transform module to provide the "
223+
"definitions of external named sequences.")};
224224

225225
Option<bool> testModuleGeneration{
226226
*this, "test-module-generation", llvm::cl::init(false),

0 commit comments

Comments
 (0)