Skip to content

Commit 2462ceb

Browse files
committed
Update comment
1 parent 6c84de6 commit 2462ceb

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

mlir/include/mlir/Target/SPIRV/Serialization.h

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,17 @@ struct SerializationOptions {
3434
/// tool. This saved file is later used for validation.
3535
bool saveModuleForValidation = false;
3636
/// A prefix prepended to the file used when `saveModuleForValidation`
37-
/// is set to `true`.
37+
/// is set to `true`. This can either be a file prefix, or a relative or
38+
/// or an absolute path followed by the prefix. For example:
39+
///
40+
/// * "foo" - Create files with a `foo` prefix in the current working
41+
/// directory. For example: `foo0`, `foo1` ... `fooN`.
42+
///
43+
/// * "my/dir/foo" - Create files in `my/dir` with a `foo` prefix. The
44+
/// `my/dir` need to exists. For example: `foo0`, `foo1` ... `fooN`
45+
/// will be created and stored in `/my/dir`.
46+
///
47+
/// * "/home/user/my/dir" - Same as above but using an absolute path.
3848
std::string validationFilePrefix = "";
3949
};
4050

mlir/lib/Target/SPIRV/TranslateRegistration.cpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,7 @@ void registerToSPIRVTranslation() {
133133
"is used to generate separate binaries for validation, where "
134134
"`--split-input-file` normally combines all outputs into one. The "
135135
"one combined output (`-o`) is still written. Created files need to "
136-
"be "
137-
"removed manually once processed."),
136+
"be removed manually once processed."),
138137
llvm::cl::init(""));
139138

140139
TranslateFromMLIRRegistration toBinary(

0 commit comments

Comments
 (0)