[mlir][sparse] rephrase the documentation for sparse compiler create-…

…sparse-deallocs option. To address post-submit comments in https://reviews.llvm.org/D147010. Reviewed By: wrengr Differential Revision: https://reviews.llvm.org/D147014
llvm · Mar 27, 2023 · 36c8a9a · 36c8a9a
1 parent 4d683f7
commit 36c8a9a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/mlir/include/mlir/Dialect/SparseTensor/Pipelines/Passes.h b/mlir/include/mlir/Dialect/SparseTensor/Pipelines/Passes.h
@@ -75,12 +75,11 @@ struct SparseCompilerOptions
 
   PassOptions::Option<bool> createSparseDeallocs{
       *this, "create-sparse-deallocs",
-      desc("Specify if the temporary sparse buffer created by the sparse "
+      desc("Specify if the temporary buffers created by the sparse "
            "compiler should be deallocated. For compatibility with core "
            "bufferization passes. "
-           "It only takes effect when enable-runtime-library=false, otherwise "
-           "the memory storage for sparse tensors are managed by the runtime "
-           "library. See also create-deallocs for BufferizationOption."),
+           "This option is only used when enable-runtime-library=false. "
+           "See also create-deallocs for BufferizationOption."),
       init(true)};
 
   PassOptions::Option<int32_t> vectorLength{

diff --git a/mlir/include/mlir/Dialect/SparseTensor/Transforms/Passes.td b/mlir/include/mlir/Dialect/SparseTensor/Transforms/Passes.td
@@ -221,12 +221,11 @@ def SparseTensorCodegen : Pass<"sparse-tensor-codegen", "ModuleOp"> {
     Option<"enableBufferInitialization", "enable-buffer-initialization", "bool",
            "false", "Enable zero-initialization of the memory buffers">,
     Option<"createSparseDeallocs", "create-sparse-deallocs", "bool",
-           "true", "Specify if the temporary sparse buffer created by the sparse "
+           "true", "Specify if the temporary buffers created by the sparse "
                    "compiler should be deallocated. For compatibility with core "
                    "bufferization passes. "
-                   "It only takes effect when enable-runtime-library=false, otherwise "
-                   "the memory storage for sparse tensors are managed by the runtime "
-                   "library. See also create-deallocs for BufferizationOption.">,
+                   "This option is only used when enable-runtime-library=false. "
+                   "See also create-deallocs for BufferizationOption.">,
   ];
 }