Skip to content

Commit 1865652

Browse files
author
Colin Robertson
committed
Add a few more details and formatting
1 parent 93842ed commit 1865652

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/how-to-report-a-problem-with-the-visual-cpp-toolset.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,11 @@ Copy and paste the entire command line into your report.
8585

8686
We need a detailed description of the problem you've encountered so that we can verify that we see the same effect on our machines; its also sometimes useful for us to know what you were trying to accomplish, and what you expected to happen.
8787

88-
Please provide the exact error messages given by the toolset, or the exact runtime behavior you see. We need this information to verify that we've properly reproduced the issue. Please include all of the compiler output, not just the last error message. We need to see everything that led up to the issue you report. If you can duplicate the issue by using the command line compiler, that compiler output is preferred; the IDE and other build systems may filter the error messages you see, or only capture the first line of an error message.
88+
Please provide the **exact error messages** given by the toolset, or the exact runtime behavior you see. We need this information to verify that we've properly reproduced the issue. Please include **all** of the compiler output, not just the last error message. We need to see everything that led up to the issue you report. If you can duplicate the issue by using the command line compiler, that compiler output is preferred; the IDE and other build systems may filter the error messages you see, or only capture the first line of an error message.
8989

9090
If the issue is that the compiler accepts invalid code and does not generate a diagnostic, please note this in your report.
9191

92-
To report a runtime behavior problem, include an exact copy of what the program prints out, and what you expect to see. Ideally, this is embedded in the output statement itself, for example, `printf("This should be 5: %d\n", actual_result);`. If your program crashes or hangs, mention that as well.
92+
To report a runtime behavior problem, include an **exact copy** of what the program prints out, and what you expect to see. Ideally, this is embedded in the output statement itself, for example, `printf("This should be 5: %d\n", actual_result);`. If your program crashes or hangs, mention that as well.
9393

9494
Add any other details that might help us diagnose the problem you experienced, such as any work-arounds you may have found. Avoid repeating information found elsewhere in your report.
9595

@@ -242,6 +242,8 @@ A *preprocessed repro* is a single source file that demonstrates a problem, gene
242242

243243
1. In the developer command prompt console window, enter the command **cl /P** *arguments* *filename.cpp*, where *arguments* is the list of arguments captured above, and *filename.cpp* is the name of your repro source file. This command replicates the command line used for the repro, but stops the compilation after the preprocessor pass, and outputs the preprocessed source code to *filename*.i.
244244

245+
If you are preprocessing a C++/CX source code file, or you are using the C++ Modules feature, some additional steps are required. For more information, see the sections below.
246+
245247
After you have generated the preprocessed file, its a good idea to make sure that the problem still repros using the preprocessed file.
246248

247249
#### To confirm that the error still repros with the preprocessed file
@@ -252,10 +254,12 @@ After you have generated the preprocessed file, its a good idea to make sure tha
252254

253255
Finally, attach the preprocessed repro *filename*.i to your report.
254256

255-
#### Extra steps for C++/CX and WinRT / UWP repros
257+
### Preprocessed C++/CX WinRT/UWP code repros
256258

257259
If you're using C++/CX to build your executable, there are some extra steps required to create and validate a preprocessed repro.
258260

261+
#### To preprocess C++/CX source code
262+
259263
1. Create a preprocessed source file as described in [To preprocess a source code file](#to-preprocess-a-source-code-file).
260264

261265
1. Search the generated _filename_.i file for **#using** directives.

0 commit comments

Comments
 (0)