maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Reword the documentation for the `mlirTranslateMain` API (NFC) 

Address post-commit review in https://reviews.llvm.org/D86408
This commit is contained in:
Mehdi Amini 2020-08-23 04:35:58 +00:00
parent 52381938bc
commit 50927f3191
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
mlir/include/mlir/Translation.h
View File

@ -95,8 +95,11 @@ struct TranslationParser : public llvm::cl::parser<const TranslateFunction *> {
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);