Merge pull request #2976 from MicrosoftDocs/master

7/7/2020 AM Publish

Author: Taojunshen

docs/build/reference/gh-enable-penter-hook-function.md

@@ -1,60 +1,52 @@
 ---
-title: "/Gh (Enable _penter Hook Function)"
-ms.date: "11/04/2016"
+title: "/Gh (Enable _penter hook function)"
+description: "Describes the /Gh compiler option to call the supplied _penter function."
+ms.date: "07/06/2020"
 f1_keywords: ["_penter"]
 helpviewer_keywords: ["/Gh compiler option [C++]", "Gh compiler option [C++]", "_penter function", "-Gh compiler option [C++]"]
 ms.assetid: 1510a082-8a0e-486e-a309-6add814b494f
 ---
-# /Gh (Enable _penter Hook Function)
+# /Gh (Enable _penter hook function)
 
 Causes a call to the `_penter` function at the start of every method or function.
 
 ## Syntax
 
-```
-/Gh
-```
+> **`/Gh`**
 
 ## Remarks
 
-The `_penter` function is not part of any library and it is up to you to provide a definition for `_penter`.
+The `_penter` function isn't part of any library. It's up to you to provide a definition for `_penter`.
 
-Unless you plan to explicitly call `_penter`, you do not need to provide a prototype. The function must appear as if it had the following prototype, and it must push the content of all registers on entry and pop the unchanged content on exit:
+Unless you plan to explicitly call `_penter`, you don't need to provide a prototype. The function must push the content of all registers on entry and pop the unchanged content on exit. It must appear as if it had the following prototype:
 
 ```cpp
 void __declspec(naked) __cdecl _penter( void );
 ```
 
-This declaration is not available for 64-bit projects.
+This declaration isn't available for 64-bit projects.
 
 ### To set this compiler option in the Visual Studio development environment
 
 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).
 
-1. Click the **C/C++** folder.
-
-1. Click the **Command Line** property page.
+1. Open the **Configuration Properties** > **C/C++** > **Command Line** property page.
 
-1. Type the compiler option in the **Additional Options** box.
+1. Enter the compiler option in the **Additional Options** box.
 
 ### To set this compiler option programmatically
 
 - See <xref:Microsoft.VisualStudio.VCProjectEngine.VCCLCompilerTool.AdditionalOptions%2A>.
 
 ## Example
 
-The following code, when compiled with **/Gh**, shows how `_penter` is called twice; once when entering function `main` and once when entering function `x`.
+The following code, when compiled with **/Gh**, shows how `_penter` is called twice; once when entering function `main` and once when entering function `x`. The example consists of two source files, which you compile separately.
 
 ```cpp
-// Gh_compiler_option.cpp
-// compile with: /Gh
+// local_penter.cpp
+// compile with: cl /EHsc /c local_penter.cpp
 // processor: x86
 #include <stdio.h>
-void x() {}
-
-int main() {
-   x();
-}
 
 extern "C" void __declspec(naked) __cdecl _penter( void ) {
    _asm {
@@ -82,12 +74,29 @@ extern "C" void __declspec(naked) __cdecl _penter( void ) {
 }
 ```
 
+```cpp
+// Gh_compiler_option.cpp
+// compile with: cl /EHsc /Gh Gh_compiler_option.cpp local_penter.obj
+// processor: x86
+#include <stdio.h>
+
+void x() {}
+
+int main() {
+   x();
+}
+```
+
+When run, the local `_penter` function is called on entry to `main` and `x`:
+
 ```Output
+
 In a function!
 In a function!
 ```
 
 ## See also
 
-[MSVC Compiler Options](compiler-options.md)<br/>
-[MSVC Compiler Command-Line Syntax](compiler-command-line-syntax.md)
+[MSVC compiler options](compiler-options.md)<br/>
+[MSVC compiler command-line syntax](compiler-command-line-syntax.md)<br/>
+[`/GH` (Enable _pexit hook function)](gh-enable-pexit-hook-function.md)

docs/build/reference/gh-enable-pexit-hook-function.md

@@ -1,47 +1,47 @@
 ---
-title: "/GH (Enable _pexit Hook Function)"
-ms.date: "11/04/2016"
+title: "/GH (Enable _pexit hook function)"
+description: "Describes the /GH compiler option to set a local _pexit hook function."
+ms.date: "07/06/2020"
 f1_keywords: ["_pexit"]
 helpviewer_keywords: ["/Gh compiler option [C++]", "Gh compiler option [C++]", "_pexit function", "-Gh compiler option [C++]"]
 ms.assetid: 93181453-2676-42e5-bf63-3b19e07299b6
 ---
-# /GH (Enable _pexit Hook Function)
+# /GH (Enable _pexit hook function)
 
 Calls the `_pexit` function at the end of every method or function.
 
 ## Syntax
 
-```
-/GH
-```
+> **`/GH`**
 
 ## Remarks
 
-The `_pexit` function is not part of any library and it is up to you to provide a definition for `_pexit`.
+The `_pexit` function isn't part of any library. It's up to you to provide a definition for `_pexit`.
 
-Unless you plan to explicitly call `_pexit`, you do not need to provide a prototype. The function must appear as if it had the following prototype, and it must push the content of all registers on entry and pop the unchanged content on exit:
+Unless you plan to explicitly call `_pexit`, you don't need to provide a prototype. The function must push the content of all registers on entry and pop the unchanged content on exit. It must appear as if it had the following prototype:
 
 ```cpp
 void __declspec(naked) __cdecl _pexit( void );
 ```
 
-`_pexit` is similar to `_penter`; see [/Gh (Enable _penter Hook Function)](gh-enable-penter-hook-function.md) for an example of how to write a `_pexit` function.
+This declaration isn't available for 64-bit projects.
+
+`_pexit` is similar to `_penter`; see [`/Gh` (Enable _penter Hook Function)](gh-enable-penter-hook-function.md) for an example of how to write a `_penter` function.
 
 ### To set this compiler option in the Visual Studio development environment
 
 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).
 
-1. Click the **C/C++** folder.
-
-1. Click the **Command Line** property page.
+1. Open the **Configuration Properties** > **C/C++** > **Command Line** property page.
 
-1. Type the compiler option in the **Additional Options** box.
+1. Enter the compiler option in the **Additional Options** box.
 
 ### To set this compiler option programmatically
 
 - See <xref:Microsoft.VisualStudio.VCProjectEngine.VCCLCompilerTool.AdditionalOptions%2A>.
 
 ## See also
 
-[MSVC Compiler Options](compiler-options.md)<br/>
-[MSVC Compiler Command-Line Syntax](compiler-command-line-syntax.md)
+[MSVC compiler options](compiler-options.md)<br/>
+[MSVC compiler command-line syntax](compiler-command-line-syntax.md)<br/>
+[`/Gh` (Enable _penter hook function)](gh-enable-penter-hook-function.md)

docs/build/reference/z7-zi-zi-debug-information-format.md

@@ -1,55 +1,57 @@
 ---
 title: "/Z7, /Zi, /ZI (Debug Information Format)"
-ms.date: "04/08/2019"
+ms.date: "07/06/2020"
 f1_keywords: ["VC.Project.VCCLCompilerTool.DebugInformationFormat", "/ZI", "/Zi", "/Z7", "VC.Project.VCCLWCECompilerTool.DebugInformationFormat"]
 helpviewer_keywords: ["C7 compatible compiler option [C++]", "Debug Information Format compiler option", "ZI compiler option", "-Zi compiler option [C++]", "/ZI compiler option [C++]", "Z7 compiler option [C++]", "debugging [C++], debug information files", "Zi compiler option [C++]", "/Zi compiler option [C++]", "program database compiler option [C++]", "full symbolic debugging information", "/Z7 compiler option [C++]", "line numbers only compiler option [C++]", "cl.exe compiler, debugging options", "-Z7 compiler option [C++]"]
 ---
 # /Z7, /Zi, /ZI (Debug Information Format)
 
-Specifies the type of debugging information created for your program and whether this information is kept in object files or in a program database (PDB) file.
+The **`/Z7`**, **`/Zi`**, and **`/ZI`** compiler options specify the type of debugging information created for your program, and whether this information is kept in object files or in a program database (PDB) file.
 
 ## Syntax
 
-> **/Z**{**7**|**i**|**I**}
+> **`/Z7`**\
+> **`/Zi`**\
+> **`/ZI`**
 
 ## Remarks
 
-When code is compiled and built in debug mode, the compiler produces symbol names for functions and variables, type information, and line number locations for use by the debugger. This symbolic debugging information can be included either in the object files (.obj files) produced by the compiler, or in a separate PDB file (a .pdb file) for the executable.  The debug information format options are described in the following sections.
+When you specify a debug option, the compiler produces symbol names for functions and variables, type information, and line locations for use by the debugger. This symbolic debugging information can be included either in the object files (*`.obj`* files) produced by the compiler, or in a separate PDB file (a *`.pdb`* file) for the executable. The debug information format options are described in the following sections.
 
 ### None
 
 By default, if no debug information format option is specified, the compiler produces no debugging information, so compilation is faster.
 
 ### /Z7
 
-The **/Z7** option produces object files that also contain full symbolic debugging information for use with the debugger. These object files and the built executable can be substantially larger than files that have no debugging information. The symbolic debugging information includes the names and types of variables, as well as functions and line numbers. No PDB file is produced.
+The **`/Z7`** option produces object files that also contain full symbolic debugging information for use with the debugger. These object files and any libraries built from them can be substantially larger than files that have no debugging information. The symbolic debugging information includes the names and types of variables, functions, and line numbers. No PDB file is produced by the compiler. However, a PDB file can still be generated from these object files or libraries if the linker is passed the **`/DEBUG`** option.
 
-For distributors of debug versions of third-party libraries, there is an advantage to not having a PDB file. However, the object files for any precompiled headers are necessary during the library link phase, and for debugging. If there is only type information (and no code) in the .pch object file, you must also use the [/Yl (Inject PCH Reference for Debug Library)](yl-inject-pch-reference-for-debug-library.md) option, which is enabled by default, when you build the library.
+For distributors of debug versions of third-party libraries, there's an advantage to not having a PDB file. However, the object files for any precompiled headers are necessary during the library link phase, and for debugging. If there's only type information (and no code) in the *`.pch`* object file, you must also use the [`/Yl` (Inject PCH Reference for Debug Library)](yl-inject-pch-reference-for-debug-library.md) option, which is enabled by default, when you build the library.
 
-The deprecated [/Gm (Enable Minimal Rebuild)](gm-enable-minimal-rebuild.md) option is not available when **/Z7** is specified.
+The deprecated [`/Gm` (Enable Minimal Rebuild)](gm-enable-minimal-rebuild.md) option is unavailable when **`/Z7`** is specified.
 
 ### /Zi
 
-The **/Zi** option produces a separate PDB file that contains all the symbolic debugging information for use with the debugger. The debugging information is not included in the object files or executable, which makes them much smaller.
+The **`/Zi`** option produces a separate PDB file that contains all the symbolic debugging information for use with the debugger. The debugging information isn't included in the object files or executable, which makes them much smaller.
 
-Use of **/Zi** does not affect optimizations. However, **/Zi** does imply **/debug**; see [/DEBUG (Generate Debug Info)](debug-generate-debug-info.md) for more information.
+Use of **`/Zi`** doesn't affect optimizations. However, **`/Zi`** does imply **`/debug`**. For more information, see [`/DEBUG` (Generate Debug Info)](debug-generate-debug-info.md).
 
-When you specify both **/Zi** and **/clr**, the <xref:System.Diagnostics.DebuggableAttribute> attribute is not placed in the assembly metadata. If you want it, you must specify it in the source code. This attribute can affect the runtime performance of the application. For more information about how the **Debuggable** attribute affects performance and how you can modify the performance impact, see [Making an Image Easier to Debug](/dotnet/framework/debug-trace-profile/making-an-image-easier-to-debug).
+When you specify both **`/Zi`** and **`/clr`**, the <xref:System.Diagnostics.DebuggableAttribute> attribute isn't placed in the assembly metadata. If you want it, you must specify it in the source code. This attribute can affect the runtime performance of the application. For more information about how the `Debuggable` attribute affects performance and how you can modify the performance impact, see [Making an image easier to debug](/dotnet/framework/debug-trace-profile/making-an-image-easier-to-debug).
 
-The compiler names the PDB file *project*.pdb. If you compile a file outside of a project, the compiler creates a PDB file named VC*x*.pdb, where *x* is a concatenation of the major and minor version number of the compiler version in use. The compiler embeds the name of the PDB and an identifying timestamped signature in each object file created using this option, which points the debugger to the location of symbolic and line-number information. The name and signature in the PDB file must match the executable for symbols to be loaded in the debugger. The WinDBG debugger can load mismatched symbols by using the `.symopt+0x40` command. Visual Studio does not have a similar option to load mismatched symbols.
+The compiler names the PDB file *`<project>.pdb`*, where *`<project>`* is the name of your project. If you compile a file outside of a project, the compiler creates a PDB file named *`VC<x>.pdb`*, where *`<x>`* is a concatenation of the major and minor version number of the compiler version in use. The compiler embeds the name of the PDB and an identifying timestamped signature in each object file created using this option. This name and signature point the debugger to the location of symbolic and line-number information. The name and signature in the PDB file must match the executable for symbols to be loaded in the debugger. The WinDBG debugger can load mismatched symbols by using the **`.symopt+0x40`** command. Visual Studio doesn't have a similar option to load mismatched symbols.
 
-If you create a library from objects that were compiled using **/Zi**, the associated .pdb file must be available when the library is linked to a program. Thus, if you distribute the library, you must also distribute the PDB file. To create a library that contains debugging information without using PDB files, you must select the **/Z7** option. If you use the precompiled headers options, debugging information for both the precompiled header and the rest of the source code is placed in the PDB file.
+If you create a library from objects that were compiled using **`/Zi`**, the associated PDB file must be available when the library is linked to a program. That means, if you distribute the library, you must also distribute the PDB file. To create a library that contains debugging information without using PDB files, you must select the **`/Z7`** option. If you use the precompiled headers options, debugging information for both the precompiled header and the rest of the source code is placed in the PDB file.
 
 ### /ZI
 
-The **/ZI** option is similar to **/Zi**, but it produces a PDB file in a format that supports the [Edit and Continue](/visualstudio/debugger/edit-and-continue-visual-cpp) feature. To use Edit and Continue debugging features, you must use this option. The Edit and Continue feature is useful for developer productivity, but can cause issues in code size, performance, and compiler conformance. Because most optimizations are incompatible with Edit and Continue, using **/ZI** disables any `#pragma optimize` statements in your code. The **/ZI** option is also incompatible with use of the [&#95;&#95;LINE&#95;&#95; predefined macro](../../preprocessor/predefined-macros.md); code compiled with **/ZI** cannot use **&#95;&#95;LINE&#95;&#95;** as a non-type template argument, although **&#95;&#95;LINE&#95;&#95;** can be used in macro expansions.
+The **`/ZI`** option is similar to **`/Zi`**, but it produces a PDB file in a format that supports the [Edit and Continue](/visualstudio/debugger/edit-and-continue-visual-cpp) feature. To use Edit and Continue debugging features, you must use this option. The Edit and Continue feature is useful for developer productivity, but can cause issues in code size, performance, and compiler conformance. Because most optimizations are incompatible with Edit and Continue, using **`/ZI`** disables any `#pragma optimize` statements in your code. The **`/ZI`** option is also incompatible with use of the [`__LINE__` predefined macro](../../preprocessor/predefined-macros.md); code compiled with **`/ZI`** can't use `__LINE__` as a non-type template argument, although `__LINE__` can be used in macro expansions.
 
-The **/ZI** option forces both the [/Gy (Enable Function-Level Linking)](gy-enable-function-level-linking.md) and [/FC (Full Path of Source Code File in Diagnostics)](fc-full-path-of-source-code-file-in-diagnostics.md) options to be used in your compilation.
+The **`/ZI`** option forces both the [`/Gy` (Enable Function-Level Linking)](gy-enable-function-level-linking.md) and [`/FC` (Full Path of Source Code File in Diagnostics)](fc-full-path-of-source-code-file-in-diagnostics.md) options to be used in your compilation.
 
-**/ZI** is not compatible with [/clr (Common Language Runtime Compilation)](clr-common-language-runtime-compilation.md).
+**`/ZI`** is incompatible with [`/clr` (Common Language Runtime Compilation)](clr-common-language-runtime-compilation.md).
 
 > [!NOTE]
-> The **/ZI** option is only available in the compilers targeting x86 and x64 processors; this compiler option is not available in the compilers targeting ARM processors.
+> The **`/ZI`** option is only available in the compilers targeting x86 and x64 processors. This compiler option is not available in the compilers targeting ARM processors.
 
 ### To set this compiler option in the Visual Studio development environment
 
@@ -65,5 +67,5 @@ The **/ZI** option forces both the [/Gy (Enable Function-Level Linking)](gy-enab
 
 ## See also
 
-[MSVC Compiler Options](compiler-options.md)<br/>
-[MSVC Compiler Command-Line Syntax](compiler-command-line-syntax.md)
+[MSVC compiler options](compiler-options.md)<br/>
+[MSVC compiler command-line syntax](compiler-command-line-syntax.md)