Merge pull request MicrosoftDocs#3337 from mdowst/WindowsUpdateLog_3320

Quality: quality improvements on Get-WindowsUpdateLog.md

Author: michaeltlombardi

docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md

@@ -11,28 +11,37 @@ title: Get-WindowsUpdateLog
 # Get-WindowsUpdateLog
 
 ## SYNOPSIS
-Merges Windows Update .etl files into a single log file.
+
+Merges Windows Update `.etl` files into a single log file.
 
 ## SYNTAX
 
 ```
-Get-WindowsUpdateLog [[-ETLPath] <String[]>] [[-LogPath] <String>] [-ProcessingType <String>] [-ForceFlush]
- [-WhatIf] [-Confirm] [<CommonParameters>]
+Get-WindowsUpdateLog [[-ETLPath] <String[]>] [[-LogPath] <String>] 
+[-ProcessingType <String>] [-ForceFlush] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-The **Get-WindowsUpdateLog** cmdlet merges and converts Windows Update .etl files into a single readable WindowsUpdate.log file.
-Windows Update Agent uses Event Tracing for Windows (ETW) to generate diagnostic logs.
-Windows Update no longer directly produces a WindowsUpdate.log file.
-Instead, it produces .etl files that are not immediately readable as written.
 
-For Windows 10 versions prior to 1709 (OS Build 16299), this cmdlet requires access to a Microsoft symbol server, and log decoding must be run from a Windows 10 version earlier than 1709. Logs from Windows 10, version 1709 onward do not require a Microsoft symbol server, and need to be decoded from Windows 10, versions 1709 or higher.
+The `Get-WindowsUpdateLog` cmdlet merges and converts Windows Update `.etl` files into a single
+readable `WindowsUpdate.log` file. Windows Update Agent uses Event Tracing for Windows (ETW) to
+generate diagnostic logs. Windows Update no longer directly produces a `WindowsUpdate.log` file.
+Instead, it produces `.etl` files that are not immediately readable as written.
+
+For Windows 10 versions prior to 1709 (OS Build 16299), this cmdlet requires access to a Microsoft
+symbol server, and log decoding must be run from a Windows 10 version earlier than 1709. Logs from
+Windows 10, version 1709 onward do not require a Microsoft symbol server, and need to be decoded
+from Windows 10, versions 1709 or higher.
 
 ## EXAMPLES
 
 ### Example 1: Merge and convert Windows Update trace files
+
+```powershell
+Get-WindowsUpdateLog
 ```
-PS C:\> Get-WindowsUpdateLog
+
+```Output
 Converting C:\Windows\logs\WindowsUpdate into C:\Users\Admin\Desktop\WindowsUpdate.log 
 
 
@@ -70,11 +79,13 @@ The command completed successfully.
 WindowsUpdate.log written to C:\Users\admin\Desktop\WindowsUpdate.log
 ```
 
-This command merges and converts Windows Update trace files (.etl files) into a single readable WindowsUpdate.log file.
+This command merges and converts Windows Update trace files (`.etl` files) into a single readable
+`WindowsUpdate.log` file.
 
 ## PARAMETERS
 
 ### -Confirm
+
 Prompts you for confirmation before running the cmdlet.
 
 ```yaml
@@ -90,13 +101,14 @@ Accept wildcard characters: False
 ```
 
 ### -ETLPath
-Specifies an array of paths of Windows Update .etl files to convert into WindowsUpdate.log.
-The default value for this parameter is the Windows Update trace file directory for the current device.
+
+Specifies an array of paths of Windows Update `.etl` files to convert into `WindowsUpdate.log`. The
+default value for this parameter is the Windows Update trace file directory for the current device.
 The acceptable values for this parameter are:
 
-- The full path of a directory that contains one or more .etl files.
-- The full path of a single .etl file.
-- A comma-separated list of full paths of .etl files.
+- The full path of a directory that contains one or more `.etl` files.
+- The full path of a single `.etl` file.
+- A comma-separated list of full paths of `.etl` files.
 
 ```yaml
 Type: String[]
@@ -111,10 +123,11 @@ Accept wildcard characters: False
 ```
 
 ### -ForceFlush
-Indicates that this cmdlet forces the Windows Update Agent on the current device to flush all of its traces to .etl files.
-This process stops the Update Orchestrator and Windows Update services.
-Running this cmdlet with this parameter requires administrative credentials.
-You can start Windows PowerShell with administrative credentials by using the Run as administrator command.
+
+Indicates that this cmdlet forces the Windows Update Agent on the current device to flush all of its
+traces to `.etl` files. This process stops the Update Orchestrator and Windows Update services.
+Running this cmdlet with this parameter requires administrative credentials. You can start Windows
+PowerShell with administrative credentials by using the Run as administrator command.
 
 ```yaml
 Type: SwitchParameter
@@ -129,8 +142,9 @@ Accept wildcard characters: False
 ```
 
 ### -LogPath
-Specifies the full path to which **Get-WindowsUpdateLog** writes WindowsUpdate.log.
-The default value is WindowsUpdate.log in the Desktop folder of the current user.
+
+Specifies the full path to which `Get-WindowsUpdateLog` writes `WindowsUpdate.log`.
+The default value is `WindowsUpdate.log` in the Desktop folder of the current user.
 
 ```yaml
 Type: String
@@ -145,14 +159,15 @@ Accept wildcard characters: False
 ```
 
 ### -ProcessingType
-Specifies the file type that **Get-WindowsUpdateLog** uses for temporary files that are created during intermediate processing.
-The acceptable values for this parameter are:
 
-- CSV (comma-separated values)
-- XML
+Specifies the file type that `Get-WindowsUpdateLog` uses for temporary files that are created
+during intermediate processing. The acceptable values for this parameter are:
 
-By default, the value is XML.
-The temporary files are in $env:TEMP\WindowsUpdateLog.
+- `CSV` (comma-separated values)
+- `XML`
+
+By default, the value is `XML`.
+The temporary files are in `$env:TEMP\WindowsUpdateLog`.
 
 ```yaml
 Type: String
@@ -168,6 +183,7 @@ Accept wildcard characters: False
 ```
 
 ### -WhatIf
+
 Shows what would happen if the cmdlet runs.
 The cmdlet is not run.
 
@@ -184,7 +200,11 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS