From 50927f3191f908142201ccc50962537bf9d96bda Mon Sep 17 00:00:00 2001 From: Mehdi Amini Date: Sun, 23 Aug 2020 04:35:58 +0000 Subject: [PATCH] Reword the documentation for the `mlirTranslateMain` API (NFC) Address post-commit review in https://reviews.llvm.org/D86408 --- mlir/include/mlir/Translation.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/mlir/include/mlir/Translation.h b/mlir/include/mlir/Translation.h index ab9dad8..79220cc 100644 --- a/mlir/include/mlir/Translation.h +++ b/mlir/include/mlir/Translation.h @@ -95,8 +95,11 @@ struct TranslationParser : public llvm::cl::parser { size_t globalWidth) const override; }; -/// Implementation for tools like `mlir-translate`. ToolName is used for the -/// header displayed by `--help`. +/// Translate to/from an MLIR module from/to an external representation (e.g. +/// LLVM IR, SPIRV binary, ...). This is the entry point for the implementation +/// of tools like `mlir-translate`. The translation to perform is parsed from +/// the command line. The `toolName` argument is used for the header displayed +/// by `--help`. LogicalResult mlirTranslateMain(int argc, char **argv, llvm::StringRef toolName); -- 2.7.4