Skip to content

Commit 620bca6

Browse files
committed
review feedback
1 parent d7e3479 commit 620bca6

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/build/reference/experimental-log.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ Output [SARIF](https://sarifweb.azurewebsites.net/) diagnostics to the specified
1212
## Syntax
1313

1414
> **`/experimental:log`** *filename*
15-
> **`/experimental:log`** *directoryname\*
15+
> **`/experimental:log`** *directoryname`\`*
1616
1717
## Arguments
1818

1919
*filename*
2020

2121
The output file for SARIF diagnostics. The compiler automatically adds the `.sarif` extension to *filename*. The space between `/experimental:log` and *filename* is optional. Use double quotes around paths containing spaces. Both relative and absolute paths are supported.
2222

23-
*directoryname\*
23+
*directoryname`\`*
2424

25-
The output directory for SARIF diagnostics (for example, `/experimental:log sarif_output\`). Remember to add the trailing backslash (`\`) to indicate it's a directory. Each source file name forms the base name for each SARIF file saved in the directory. The compiler automatically adds the `.sarif` extension to each file name. The space between `/experimental:log` and *directoryname* is optional. Use double quotes around paths containing spaces. Both relative and absolute paths are supported.
25+
The output directory for SARIF diagnostics (for example, `/experimental:log sarif_output\`). Remember to add the trailing backslash (`\`) to indicate it's a directory. Each source file name forms the base name for each SARIF file saved in the directory. The compiler automatically adds the `.sarif` extension to each file name. The space between `/experimental:log` and *directoryname`\`* is optional. Use double quotes around paths containing spaces. Both relative and absolute paths are supported.
2626

2727
## Remarks
2828

@@ -39,6 +39,12 @@ Diagnostics are also output as text to the console as usual.
3939

4040
## Example
4141

42+
The following command produces SARIF information for the compilation of `main.cpp` and saves it in the file `main.sarif`:
43+
44+
```cmd
45+
CL /experimental:log main.cpp
46+
```
47+
4248
The following command produces SARIF information for the entire compilation and saves it in the `sarif_output` directory in the files `main.sarif` and `other.sarif`:
4349

4450
```cmd

0 commit comments

Comments
 (0)