Skip to content

Commit 11352ec

Browse files
authored
Merge pull request #4708 from corob-msft/learn/corob/cpp-docs-4322-fastlink
Learn/corob/cpp docs 4322 fastlink
2 parents 0c9cb84 + c36d127 commit 11352ec

File tree

1 file changed

+24
-26
lines changed

1 file changed

+24
-26
lines changed

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

100755100644
Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,58 @@
11
---
2-
description: "Learn more about: /DEBUG (Generate Debug Info)"
2+
description: "Learn more about: /DEBUG (Generate debug info)"
33
title: "/DEBUG (Generate Debug Info)"
4-
ms.date: "05/16/2019"
4+
ms.date: 12/05/2022
55
f1_keywords: ["VC.Project.VCLinkerTool.GenerateDebugInformation", "/debug"]
66
helpviewer_keywords: ["DEBUG linker option", "/DEBUG linker option", "-DEBUG linker option", "PDB files", "debugging [C++], debug information files", "generate debug info linker option", "pdb files, generating debug info", ".pdb files, generating debug info", "debugging [C++], linker option", "program databases [C++]"]
77
ms.assetid: 1af389ae-3f8b-4d76-a087-1cdf861e9103
88
---
9-
# /DEBUG (Generate Debug Info)
9+
# `/DEBUG` (Generate debug info)
1010

11-
```
12-
/DEBUG[:{FASTLINK|FULL|NONE}]
13-
```
11+
The **`/DEBUG`** linker option creates a debugging information file for the executable.
1412

15-
## Remarks
13+
## Syntax
14+
15+
> **`/DEBUG`**\[**`:`**{**`FASTLINK`**|**`FULL`**|**`NONE`**}]
1616
17-
The **/DEBUG** option creates debugging information for the executable.
17+
## Remarks
1818

19-
The linker puts the debugging information into a program database (PDB) file. It updates the PDB during subsequent builds of the program.
19+
The **`/DEBUG`** option puts the debugging information from linked object and library files into a program database (PDB) file. It updates the PDB during subsequent builds of the program.
2020

21-
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.
21+
An executable (an EXE or DLL file) 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 the [`/PDB`](pdb-use-program-database.md) option and specify a different file name.
2222

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. You can only use this limited PDB to debug from the computer where the binary and its libraries were built. If you deploy the binary elsewhere, you may debug it remotely from the build computer, but not directly on the test 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's rarely more than twice as fast.
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. You can only use this limited PDB to debug from the computer where the binary and its libraries were built. If you deploy the binary elsewhere, you may debug it remotely from the build computer, but not directly on the test 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 in earlier versions. Now, **`/DEBUG:FASTLINK`** isn't always faster than **`/DEBUG:FULL`**, and it's rarely more than twice as fast.
2424

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.
25+
A **`/DEBUG:FASTLINK`** PDB can be converted to a full PDB that you can deploy to a test machine for local debugging. In Visual Studio, use the **Property Pages** dialog as described below to create a full PDB for the project or solution. In a developer command prompt, you can use the `mspdbcmf.exe` tool to create a full PDB.
2626

27-
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.
27+
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.
2828

29-
The **/DEBUG:NONE** option does not generate a PDB.
29+
The **`/DEBUG:NONE`** option doesn't generate a PDB.
3030

31-
When you specify **/DEBUG** with no additional options, the linker defaults to **/DEBUG:FULL** for command line and makefile builds, for release builds in the Visual Studio IDE, and for both debug and release builds in Visual Studio 2015 and earlier versions. Beginning in Visual Studio 2017, the build system in the IDE defaults to **/DEBUG:FASTLINK** when you specify the **/DEBUG** option for debug builds. Other defaults are unchanged to maintain backward compatibility.
31+
In Visual Studio 2015 and earlier versions, when you specify **`/DEBUG`** with no extra arguments, the linker defaults to **`/DEBUG:FULL`** for command line and makefile builds, for release builds in the Visual Studio IDE, and for both debug and release builds. Beginning in Visual Studio 2017, the build system in the IDE defaults to **`/DEBUG:FASTLINK`** when you specify the **`/DEBUG`** option for debug builds. Other defaults are unchanged to maintain backward compatibility.
3232

33-
The compiler's [C7 Compatible](z7-zi-zi-debug-information-format.md) (/Z7) option causes the compiler to leave the debugging information in the .obj files. You can also use the [Program Database](z7-zi-zi-debug-information-format.md) (/Zi) compiler option to store the debugging information in a PDB for the .obj file. The linker looks for the object's PDB first in the absolute path written in the .obj file, and then in the directory that contains the .obj file. You cannot specify an object's PDB file name or location to the linker.
33+
The compiler's [`/Z7`](z7-zi-zi-debug-information-format.md) (C7 Compatible) option causes the compiler to leave the debugging information in the object (OBJ) files. You can also use the [`/Zi`](z7-zi-zi-debug-information-format.md) (Program Database) compiler option to store the debugging information in a PDB for the OBJ file. The linker looks for the object's PDB first in the absolute path written in the OBJ file, and then in the directory that contains the OBJ file. You can't specify an object's PDB file name or location to the linker.
3434

35-
[/INCREMENTAL](incremental-link-incrementally.md) is implied when /DEBUG is specified.
35+
[`/INCREMENTAL`](incremental-link-incrementally.md) is implied when **`/DEBUG`** is specified.
3636

37-
/DEBUG changes the defaults for the [/OPT](opt-optimizations.md) option from REF to NOREF and from ICF to NOICF, so if you want the original defaults, you must explicitly specify /OPT:REF or /OPT:ICF.
37+
**`/DEBUG`** changes the defaults for the [`/OPT`](opt-optimizations.md) option from **`REF`** to **`NOREF`** and from **`ICF`** to **`NOICF`**, so if you want the original defaults, you must explicitly specify **`/OPT:REF`** or **`/OPT:ICF`** after the **`/DEBUG`** option.
3838

39-
It is not possible to create an .exe or .dll that contains debug information. Debug information is always placed in a .obj or .pdb file.
39+
It isn't possible to create an EXE or DLL that contains debug information. Debug information is always placed in an OBJ or PDB file.
4040

4141
### To set this linker option in the Visual Studio development environment
4242

4343
1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md).
4444

45-
1. Click the **Linker** folder.
46-
47-
1. Click the **Debugging** property page.
45+
1. Select the **Linker** > **Debugging** property page.
4846

49-
1. Modify the **Generate Debug Info** property to enable PDB generation. This enables /DEBUG:FASTLINK by default in Visual Studio 2017 and later.
47+
1. Modify the **Generate Debug Info** property to enable or disable PDB generation. This property enables **`/DEBUG:FASTLINK`** by default in Visual Studio 2017 and later.
5048

51-
1. Modify the **Generate Full Program Database File** property to enable /DEBUG:FULL for full PDB generation for every incremental build.
49+
1. Modify the **Generate Full Program Database File** property to enable **`/DEBUG:FULL`** for full PDB generation for every incremental build.
5250

5351
### To set this linker option programmatically
5452

5553
1. See <xref:Microsoft.VisualStudio.VCProjectEngine.VCLinkerTool.GenerateDebugInformation%2A>.
5654

5755
## See also
5856

59-
[MSVC linker reference](linking.md)<br/>
60-
[MSVC Linker Options](linker-options.md)
57+
[MSVC linker reference](linking.md)\
58+
[MSVC linker options](linker-options.md)

0 commit comments

Comments
 (0)