Skip to content

Commit 2d370a7

Browse files
Update documentation for FASTLINK
The documentation for FASTLINK had a few issues that this PR attempts to address: * The sentence about "executable is deployed on another computer" was confusing because deploying the executable isn't a problem if you are doing so to remote debug. The real problem is attempting to deploy the PDB. * The performance notes on FASTLINK were not correct for Visual Studio 2019 and later
1 parent f60cbd3 commit 2d370a7

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/build/reference/debug-generate-debug-info.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ The linker puts the debugging information into a program database (PDB) file. It
2020

2121
An executable (.exe file or DLL) created for debugging contains the name and path of the corresponding PDB. The debugger reads the embedded name and uses the PDB when you debug the program. The linker uses the base name of the program and the extension .pdb to name the program database, and embeds the path where it was created. To override this default, set [/PDB](pdb-use-program-database.md) and specify a different file name.
2222

23-
The **/DEBUG:FASTLINK** option is available in Visual Studio 2017 and later. This option leaves private symbol information in the individual compilation products used to build the executable. It generates a limited PDB that indexes into the debug information in the object files and libraries used to build the executable instead of making a full copy. This option can link from two to four times as fast as full PDB generation, and is recommended when you are debugging locally and have the build products available. This limited PDB can't be used for debugging when the required build products are not available, such as when the executable is deployed on another computer. In a developer command prompt, you can use the mspdbcmf.exe tool to generate a full PDB from this limited PDB. In Visual Studio, use the Project or Build menu items for generating a full PDB file to create a full PDB for the project or solution.
23+
The **/DEBUG:FASTLINK** option is available in Visual Studio 2017 and later. This option generates a limited PDB that indexes into the debug information in the object files and libraries used to build the executable instead of making a full copy. This limited PDB can't be used to debug on computers other than the computer where the binary and its libs were built as the PDB is not intended to be used on any other computer. In Visual Studio 2017, this option can sometimes greatly improve link times compared with /DEBUG:FULL. In Visual Studio 2019 and later, /DEBUG:FULL is faster than earlier versions. Now, /DEBUG:FASTLINK isn't always faster than /DEBUG:FULL, and it is rarely more than twice as fast.
24+
25+
A /DEBUG:FASTLINK PDB can be converted to a full PDB. In Visual Studio, use the Project or Build menu items for generating a full PDB file to create a full PDB for the project or solution. In a developer command prompt, you can use the mspdbcmf.exe tool.
2426

2527
The **/DEBUG:FULL** option moves all private symbol information from individual compilation products (object files and libraries) into a single PDB, and can be the most time-consuming part of the link. However, the full PDB can be used to debug the executable when no other build products are available, such as when the executable is deployed.
2628

0 commit comments

Comments
 (0)