Merge pull request #2535 from v-thepet/batch20

MSBuild #20

Author: Ja-Dunn

docs/msbuild/writecodefragment-task.md

@@ -19,7 +19,7 @@ manager: douge
 ms.workload: 
   - "multiple"
 ---
-# WriteCodeFragment Task
+# WriteCodeFragment task
 Generates a temporary code file from the specified generated code fragment. Does not delete the file.  
 
 ## Parameters  
@@ -33,8 +33,8 @@ Generates a temporary code file from the specified generated code fragment. Does
 |`OutputFile`|Optional <xref:Microsoft.Build.Framework.ITaskItem> output parameter.<br /><br /> Specifies the path of the file that was generated. If this parameter is set by using a file name, the destination folder is prepended to the file name. If it is set by using a root, the destination folder is ignored.<br /><br /> If this parameter is not set, the output file name is the destination folder, an arbitrary file name, and the default file name extension for the specified language.|  
 
 ## Remarks  
- In addition to having the parameters that are listed in the table, this task inherits parameters from the <xref:Microsoft.Build.Tasks.TaskExtension> class, which itself inherits from the <xref:Microsoft.Build.Utilities.Task> class. For a list of these additional parameters and their descriptions, see [TaskExtension Base Class](../msbuild/taskextension-base-class.md).  
+ In addition to having the parameters that are listed in the table, this task inherits parameters from the <xref:Microsoft.Build.Tasks.TaskExtension> class, which itself inherits from the <xref:Microsoft.Build.Utilities.Task> class. For a list of these additional parameters and their descriptions, see [TaskExtension base class](../msbuild/taskextension-base-class.md).  
 
-## See Also  
+## See also  
  [Tasks](../msbuild/msbuild-tasks.md)   
- [Task Reference](../msbuild/msbuild-task-reference.md)
+ [Task reference](../msbuild/msbuild-task-reference.md)

docs/msbuild/writecontexttlogs.md

@@ -34,11 +34,11 @@ HRESULT WINAPI WriteContextTLogs(LPCTSTR intermediateDirectory, LPCTSTR tlogRoot
  [in] `tlogRootName`  
  The root name of the log file name.  
   
-## Return Value  
+## Return value  
  An **HRESULT** with the **SUCCEEDED** bit set if the tracking context was created.  
   
 ## Requirements  
- **Header:** FileTracker.h  
+ **Header:** *FileTracker.h*  
   
-## See Also  
+## See also  
  [WriteAllTLogs](../msbuild/writealltlogs.md)

docs/msbuild/writelinestofile-task.md

@@ -21,10 +21,10 @@ manager: douge
 ms.workload: 
   - "multiple"
 ---
-# WriteLinesToFile Task
+# WriteLinesToFile task
 Writes the paths of the specified items to the specified text file.  
 
-## Task Parameters  
+## Task parameters  
  The following table describes the parameters of the `WriteLinestoFile` task.  
 
 |Parameter|Description|  
@@ -37,7 +37,7 @@ Writes the paths of the specified items to the specified text file.
 ## Remarks  
  If `Overwrite` is `true`, creates a new file, write the contents to the file, and then closes the file. If the target file already exists, it is overwritten. If `Overwrite` is `false`, appends the contents to file, creating the target file if it does not already exist.  
 
- In addition to the parameters listed above, this task inherits parameters from the <xref:Microsoft.Build.Tasks.TaskExtension> class, which itself inherits from the <xref:Microsoft.Build.Utilities.Task> class. For a list of these additional parameters and their descriptions, see [TaskExtension Base Class](../msbuild/taskextension-base-class.md).  
+ In addition to the parameters listed above, this task inherits parameters from the <xref:Microsoft.Build.Tasks.TaskExtension> class, which itself inherits from the <xref:Microsoft.Build.Utilities.Task> class. For a list of these additional parameters and their descriptions, see [TaskExtension base class](../msbuild/taskextension-base-class.md).  
 
 ## Example  
  The following example uses the `WriteLinesToFile` task to write the paths of the items in the `MyItems` item collection to the file specified by the `MyTextFile` item collection.  
@@ -61,6 +61,6 @@ Writes the paths of the specified items to the specified text file.
 </Project>  
 ```  
 
-## See Also  
+## See also  
  [Tasks](../msbuild/msbuild-tasks.md)   
- [Task Reference](../msbuild/msbuild-task-reference.md)
+ [Task reference](../msbuild/msbuild-task-reference.md)

docs/msbuild/writing-multi-processor-aware-loggers.md

@@ -15,19 +15,19 @@ manager: douge
 ms.workload: 
   - "multiple"
 ---
-# Writing Multi-Processor-Aware Loggers
+# Write multi-processor-aware loggers
 The ability of [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] to take advantage of multiple processors can decrease project building time, but it also adds complexity to build event logging. In a single-processor environment, events, messages, warnings, and errors arrive at the logger in a predictable, sequential manner. However, in a multi-processor environment, events from different sources can arrive at the same time or out of sequence. To provide for this, [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] provides a multi-processor-aware logger and a new logging model, and lets you create custom "forwarding loggers."  
 
-## Multi-Processor Logging Challenges  
+## Multi-processor logging challenges  
  When you build one or more projects on a multi-processor or multi-core system, [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] build events for all the projects are generated at the same time. An avalanche of event messages may arrive at the logger at the same time or out of sequence. Because a [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] 2.0 logger is not designed to handle this situation, it can overwhelm the logger and cause increased build times, incorrect logger output, or even a broken build. To address these issues, the logger (starting in [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] 3.5) can process out-of-sequence events and correlate events and their sources.  
 
  You can improve logging efficiency even more by creating a custom forwarding logger. A custom forwarding logger acts as a filter by letting you choose, before you build, only the events you want to monitor. When you use a custom forwarding logger, unwanted events cannot overwhelm the logger, clutter your logs, or slow build times.  
 
-## Multi-Processor Logging Models  
+## Multi-processor logging models  
  To provide for multi-processor-related build issues, [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] supports two logging models, central and distributed.  
 
-### Central Logging Model  
- In the central logging model, a single instance of MSBuild.exe acts as the "central node," and child instances of the central node ("secondary nodes") attach to the central node to help it perform build tasks.  
+### Central logging model  
+ In the central logging model, a single instance of *MSBuild.exe* acts as the "central node," and child instances of the central node ("secondary nodes") attach to the central node to help it perform build tasks.  
 
  ![Central Logger Model](../msbuild/media/centralnode.png "CentralNode")  
 
@@ -46,28 +46,28 @@ public interface INodeLogger: ILogger
 
  Any pre-existing <xref:Microsoft.Build.Framework.ILogger>-based loggers can act as central loggers and can attach to the build. However, central loggers written without explicit support for multi-processor logging scenarios and out-of-order events may break a build or produce meaningless output.  
 
-### Distributed Logging Model  
+### Distributed logging model  
  In the central logging model, too much incoming message traffic can overwhelm the central node, for example, when many projects build at the same time. This can stress system resources and decrease build performance. To ease this problem, [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] supports a distributed logging model.  
 
  ![Distributed Logging Model](../msbuild/media/distnode.png "DistNode")  
 
  The distributed logging model extends the central logging model by letting you create a forwarding logger.  
 
-#### Forwarding Loggers  
+#### Forwarding loggers  
  A forwarding logger is a secondary, lightweight logger that has an event filter that attaches to a secondary node and receives incoming build events from that node. It filters the incoming events and forwards only the ones that you specify to the central node. This reduces the message traffic that is sent to the central node and improves overall build performance.  
 
  There are two ways to use distributed logging, as follows:  
 
 -   Customize the pre-fabricated forwarding logger named <xref:Microsoft.Build.BuildEngine.ConfigurableForwardingLogger>.  
 
 -   Write your own custom forwarding logger.  
+
+You can modify ConfigurableForwardingLogger to suit your requirements. To do this, call the logger on the command line by using *MSBuild.exe*, and list the build events that you want the logger to forward to the central node.  
+
+As an alternative, you can create a custom forwarding logger. By creating a custom forwarding logger, you can fine-tune the behavior of the logger. However, creating a custom forwarding logger is more complex than just customizing the ConfigurableForwardingLogger. For more information, see [Creating forwarding loggers](../msbuild/creating-forwarding-loggers.md).  
 
- You can modify ConfigurableForwardingLogger to suit your requirements. To do this, call the logger on the command line by using MSBuild.exe, and list the build events that you want the logger to forward to the central node.  
-  
- As an alternative, you can create a custom forwarding logger. By creating a custom forwarding logger, you can fine-tune the behavior of the logger. However, creating a custom forwarding logger is more complex than just customizing the ConfigurableForwardingLogger. For more information, see [Creating Forwarding Loggers](../msbuild/creating-forwarding-loggers.md).  
-  
-## Using the ConfigurableForwardingLogger for Simple Distributed Logging  
- To attach either a ConfigurableForwardingLogger or a custom forwarding logger, use the `/distributedlogger` switch (`/dl` for short) in an MSBuild.exe command-line build. The format for specifying the names of the logger types and classes is the same as that for the `/logger` switch, except that a distributed logger always has two logging classes instead of one, the forwarding logger and the central logger. The following is an example of how to attach a custom forwarding logger named XMLForwardingLogger.  
+## Using the ConfigurableForwardingLogger for simple distributed logging  
+ To attach either a ConfigurableForwardingLogger or a custom forwarding logger, use the `/distributedlogger` switch (`/dl` for short) in an *MSBuild.exe* command-line build. The format for specifying the names of the logger types and classes is the same as that for the `/logger` switch, except that a distributed logger always has two logging classes instead of one, the forwarding logger and the central logger. The following is an example of how to attach a custom forwarding logger named XMLForwardingLogger.  
 
 ```cmd  
 msbuild.exe myproj.proj/distributedlogger:XMLCentralLogger,MyLogger,Version=1.0.2,Culture=neutral*XMLForwardingLogger,MyLogger,Version=1.0.2,Culture=neutral  
@@ -76,7 +76,7 @@ msbuild.exe myproj.proj/distributedlogger:XMLCentralLogger,MyLogger,Version=1.0.
 > [!NOTE]
 >  An asterisk (*) must separate the two logger names in the `/dl` switch.  
   
- Using the ConfigurableForwardingLogger is like using any other logger (as outlined in [Obtaining Build Logs](../msbuild/obtaining-build-logs-with-msbuild.md)), except that you attach the ConfigurableForwardingLogger logger instead of the typical [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] logger and you specify as parameters the events that you want the ConfigurableForwardingLogger to pass on to the central node.  
+ Using the ConfigurableForwardingLogger is like using any other logger (as outlined in [Obtaining build logs](../msbuild/obtaining-build-logs-with-msbuild.md)), except that you attach the ConfigurableForwardingLogger logger instead of the typical [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)] logger and you specify as parameters the events that you want the ConfigurableForwardingLogger to pass on to the central node.  
 
  For example, if you want to be notified only when a build starts and ends, and when an error occurs, you would pass `BUILDSTARTEDEVENT`, `BUILDFINISHEDEVENT`, and `ERROREVENT` as parameters. Multiple parameters can be passed by separating them with semi-colons. The following is an example of how to use the ConfigurableForwardingLogger to forward only the `BUILDSTARTEDEVENT`, `BUILDFINISHEDEVENT`, and `ERROREVENT` events.  
 
@@ -107,5 +107,5 @@ msbuild.exe myproj.proj /distributedlogger:XMLCentralLogger,MyLogger,Version=1.0
 |NOSUMMARY|  
 |SHOWCOMMANDLINE|  
 
-## See Also  
- [Creating Forwarding Loggers](../msbuild/creating-forwarding-loggers.md)
+## See also  
+ [Creating forwarding loggers](../msbuild/creating-forwarding-loggers.md)

docs/msbuild/xdcmake-task.md

@@ -22,28 +22,28 @@ manager: douge
 ms.workload: 
   - "multiple"
 ---
-# XDCMake Task
-Wraps the XML Documentation tool (xdcmake.exe), which merges XML document comment (.xdc) files into an .xml file.  
+# XDCMake task
+Wraps the XML Documentation tool (*xdcmake.exe*), which merges XML document comment (*.xdc*) files into an *.xml* file.  
 
- An .xdc file is created when you provide documentation comments in your Visual C++ source code and compile by using the [/doc](/cpp/build/reference/doc-process-documentation-comments-c-cpp) compiler option. For more information, see [XDCMake Reference](/cpp/ide/xdcmake-reference), [XML Document Generator Tool Property Pages](/cpp/ide/xml-document-generator-tool-property-pages), and command-line help option (**/?**) for xdcmake.exe.  
+ An *.xdc* file is created when you provide documentation comments in your Visual C++ source code and compile by using the [/doc](/cpp/build/reference/doc-process-documentation-comments-c-cpp) compiler option. For more information, see [XDCMake reference](/cpp/ide/xdcmake-reference), [XML Document Generator Tool property pages](/cpp/ide/xml-document-generator-tool-property-pages), and command-line help option (**/?**) for *xdcmake.exe*.  
 
 ## Remarks  
- By default, the xdcmake.exe tool supports a few command-line options. Additional options are supported when you specify the **/old** command-line option.  
+ By default, the *xdcmake.exe* tool supports a few command-line options. Additional options are supported when you specify the **/old** command-line option.  
 
 ## Parameters  
  The following table describes the parameters of the **XDCMake** task.  
 
 |Parameter|Description|  
 |---------------|-----------------|  
-|**AdditionalDocumentFile**|Optional **String[]** parameter.<br /><br /> Specifies one or more additional .xdc files to merge.<br /><br /> For more information, see the **Additional Document Files** description in [XML Document Generator Tool Property Pages](/cpp/ide/xml-document-generator-tool-property-pages). Also see the **/old** and **/Fs** command-line options for xdcmake.exe.|  
-|**AdditionalOptions**|Optional **String** parameter.<br /><br /> A list of options as specified on the command line. For example, "*/option1 /option2 /option#*". Use this parameter to specify options that are not represented by any other **XDCMake** task parameter.<br /><br /> For more information, see [XDCMake Reference](/cpp/ide/xdcmake-reference), [XML Document Generator Tool Property Pages](/cpp/ide/xml-document-generator-tool-property-pages), and command-line help (**/?**) for xdcmake.exe.|  
-|**DocumentLibraryDependencies**|Optional **Boolean** parameter.<br /><br /> If `true` and the current project has a dependency on a static library (.lib) project in the solution, the .xdc files for that library project are included in the .xml file output for the current project.<br /><br /> For more information, see the **Document Library Dependencies** description in [XML Document Generator Tool Property Pages](/cpp/ide/xml-document-generator-tool-property-pages).|  
-|**OutputFile**|Optional **String** parameter.<br /><br /> Overrides the default output file name. The default name is derived from the name of the first .xdc file that is processed.<br /><br /> For more information, see the **/out:**`filename` option in [XDCMake Reference](/cpp/ide/xdcmake-reference). Also see the **/old** and **/Fo** command-line options for xdcmake.exe.|  
+|**AdditionalDocumentFile**|Optional **String[]** parameter.<br /><br /> Specifies one or more additional *.xdc* files to merge.<br /><br /> For more information, see the **Additional Document Files** description in [XML Document Generator Tool property pages](/cpp/ide/xml-document-generator-tool-property-pages). Also see the **/old** and **/Fs** command-line options for *xdcmake.exe*.|  
+|**AdditionalOptions**|Optional **String** parameter.<br /><br /> A list of options as specified on the command line. For example, /\<option1> /\<option2> /\<option#>. Use this parameter to specify options that are not represented by any other **XDCMake** task parameter.<br /><br /> For more information, see [XDCMake reference](/cpp/ide/xdcmake-reference), [XML Document Generator Tool property pages](/cpp/ide/xml-document-generator-tool-property-pages), and command-line help (**/?**) for *xdcmake.exe*.|  
+|**DocumentLibraryDependencies**|Optional **Boolean** parameter.<br /><br /> If `true` and the current project has a dependency on a static library (*.lib*) project in the solution, the *.xdc* files for that library project are included in the *.xml* file output for the current project.<br /><br /> For more information, see the **Document Library Dependencies** description in [XML Document Generator Tool property pages](/cpp/ide/xml-document-generator-tool-property-pages).|  
+|**OutputFile**|Optional **String** parameter.<br /><br /> Overrides the default output file name. The default name is derived from the name of the first *.xdc* file that is processed.<br /><br /> For more information, see the **/out:\<filename>** option in [XDCMake reference](/cpp/ide/xdcmake-reference). Also see the **/old** and **/Fo** command-line options for *xdcmake.exe*.|  
 |**ProjectName**|Optional **String** parameter.<br /><br /> The name of the current project.|  
-|**SlashOld**|Optional **Boolean** parameter.<br /><br /> If `true`, enables additional xdcmake.exe options.<br /><br /> For more information, see the **/old** command-line option for xdcmake.exe.|  
+|**SlashOld**|Optional **Boolean** parameter.<br /><br /> If `true`, enables additional *xdcmake.exe* options.<br /><br /> For more information, see the **/old** command-line option for *xdcmake.exe*.|  
 |**Sources**|Required `ITaskItem[]` parameter.<br /><br /> Defines an array of MSBuild source file items that can be consumed and emitted by tasks.|  
-|**SuppressStartupBanner**|Optional **Boolean** parameter.<br /><br /> If `true`, prevents the display of the copyright and version number message when the task starts.<br /><br /> For more information, see the **/nologo** option in [XDCMake Reference](/cpp/ide/xdcmake-reference).|  
+|**SuppressStartupBanner**|Optional **Boolean** parameter.<br /><br /> If `true`, prevents the display of the copyright and version number message when the task starts.<br /><br /> For more information, see the **/nologo** option in [XDCMake reference](/cpp/ide/xdcmake-reference).|  
 |**TrackerLogDirectory**|Optional **String** parameter.<br /><br /> Specifies the directory for the tracker log.|  
 
-## See Also  
- [Task Reference](../msbuild/msbuild-task-reference.md)
+## See also  
+ [Task reference](../msbuild/msbuild-task-reference.md)