prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types.  Re-run the
formatter on the whole repository.

Change-Id: I35ec9c19ae581e4dd00b515c1bba3a9c1862eeb1
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

Author: williamspatrick

CONTRIBUTING.md

@@ -85,7 +85,7 @@ $ ipmitool -C 17 -H "$BMC_IP" -I lanplus -U "$BMC_USER" -P "$BMC_PASSWD" user di
 $ ipmitool -C 17 -H "$BMC_IP" -I lanplus -U "$BMC_USER" -P "$BMC_PASSWD" user enable <userid>
 ```
 
-##  Field-replaceable Unit (FRU)
+## Field-replaceable Unit (FRU)
 
 #### 1. View FRU information
 
@@ -181,6 +181,7 @@ $ ipmitool -C 17 -H "$BMC_IP" -I lanplus -U "$BMC_USER" -P "$BMC_PASSWD" channel
 ## Chassis
 
 #### 1. Display information about the high-level status of the system rack and
+
 #### power subsystem.
 
 ```
@@ -247,28 +248,33 @@ Currently supported devices:
 
 ##
 
-If you want to make your override persistent over reboots use the `persistent` option:
+If you want to make your override persistent over reboots use the `persistent`
+option:
+
 ```
 $ ipmitool -C 17 -H "$BMC_IP" -I lanplus -U "$BMC_USER" -P "$BMC_PASSWD" chassis bootdev <device> options=persistent
 ```
 
 ##
 
 If the main host machine is based on the x86 CPU you need also pay attention to
-the legacy/EFI mode selector. By default IPMI overrides boot source with the legacy
-mode enabled. To set EFI mode use `efiboot` option:
+the legacy/EFI mode selector. By default IPMI overrides boot source with the
+legacy mode enabled. To set EFI mode use `efiboot` option:
+
 ```
 $ ipmitool -C 17 -H "$BMC_IP" -I lanplus -U "$BMC_USER" -P "$BMC_PASSWD" chassis bootdev <device> options=efiboot
 ```
 
 You can combine options with a help of `,`:
+
 ```
 $ ipmitool -C 17 -H "$BMC_IP" -I lanplus -U "$BMC_USER" -P "$BMC_PASSWD" chassis bootdev <device> options=persistent,efiboot
 ```
 
 ##
 
 To read current boot source override setting:
+
 ```
 $ ipmitool -C 17 -H "$BMC_IP" -I lanplus -U "$BMC_USER" -P "$BMC_PASSWD" chassis bootparam get 5
 ```
@@ -341,6 +347,7 @@ $ ipmitool -C 17 -H "$BMC_IP" -I lanplus -U "$BMC_USER" -P "$BMC_PASSWD" session
 ## Serial Over Lan (SOL)
 
 #### 1. Retrieve Serial-Over-LAN configuration information for the specified
+
 #### channel.
 
 ```

IPMITOOL-cheatsheet.md

@@ -6,8 +6,8 @@ Baseboard Management Controllers (BMCs). This repository contains documentation
 for OpenBMC as a whole. There may be component-specific documentation in the
 repository for each component.
 
-The [features](features.md) document lists the project's major features
-with links to more information.
+The [features](features.md) document lists the project's major features with
+links to more information.
 
 ## Contact
 
@@ -19,34 +19,34 @@ with links to more information.
 
 These documents contain details on developing OpenBMC code itself
 
- - [cheatsheet.md](cheatsheet.md): Quick reference for some common
-   development tasks
+- [cheatsheet.md](cheatsheet.md): Quick reference for some common development
+  tasks
 
- - [CONTRIBUTING.md](CONTRIBUTING.md): Guidelines for contributing to
-   OpenBMC
+- [CONTRIBUTING.md](CONTRIBUTING.md): Guidelines for contributing to OpenBMC
 
--  [development tutorials](development/README.md): Tutorials for getting up to
-   speed on OpenBMC development
+- [development tutorials](development/README.md): Tutorials for getting up to
+  speed on OpenBMC development
 
- - [kernel-development.md](kernel-development.md): Reference for common
-   kernel development tasks
+- [kernel-development.md](kernel-development.md): Reference for common kernel
+  development tasks
 
 ## OpenBMC Usage
 
 These documents describe how to use OpenBMC, including using the programmatic
 interfaces to an OpenBMC system.
 
- - [code-update](architecture/code-update): Updating OpenBMC and host platform firmware
+- [code-update](architecture/code-update): Updating OpenBMC and host platform
+  firmware
 
- - [console.md](console.md): Using the host console
+- [console.md](console.md): Using the host console
 
- - [host-management.md](host-management.md): Performing host management tasks
-   with OpenBMC
+- [host-management.md](host-management.md): Performing host management tasks
+  with OpenBMC
 
- - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API
+- [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API
 
- - [REDFISH-cheatsheet.md](REDFISH-cheatsheet.md): Quick reference for some
-   common OpenBMC Redfish commands
+- [REDFISH-cheatsheet.md](REDFISH-cheatsheet.md): Quick reference for some
+  common OpenBMC Redfish commands
 
- - [REST-cheatsheet.md](REST-cheatsheet.md): Quick reference for some common
-   OpenBMC REST API commands
+- [REST-cheatsheet.md](REST-cheatsheet.md): Quick reference for some common
+  OpenBMC REST API commands

README.md

@@ -1,13 +1,14 @@
 # Redfish cheat sheet
+
 This document is intended to provide a set of example [Redfish][1] client
-commands for OpenBMC usage. This document uses cURL.
-This document assumes several ids, such as ManagerId, "bmc", and
-ComputerSystemId, "system". Assuming an id is not correct and any software
-written to use the Redfish API should not. From the  Redfish Specification,
-DSP0266, "Clients shall not make assumptions about the URIs for the members of a
-resource collection."
+commands for OpenBMC usage. This document uses cURL. This document assumes
+several ids, such as ManagerId, "bmc", and ComputerSystemId, "system". Assuming
+an id is not correct and any software written to use the Redfish API should not.
+From the Redfish Specification, DSP0266, "Clients shall not make assumptions
+about the URIs for the members of a resource collection."
 
 ## Query Redfish Service Root
+
 ```
 export bmc=xx.xx.xx.xx
 curl -k https://${bmc}/redfish/v1
@@ -16,29 +17,35 @@ curl -k https://${bmc}/redfish/v1
 ---
 
 ## Establish Redfish connection session
+
 ##### Method 1
+
 ```
 export bmc=xx.xx.xx.xx
 curl --insecure -H "Content-Type: application/json" -X POST -D headers.txt https://${bmc}/redfish/v1/SessionService/Sessions -d    '{"UserName":"root", "Password":"0penBmc"}'
 ```
-A file, headers.txt, will be created. Find the `"X-Auth-Token"`
-in that file. Save it away in an env variable like so:
+
+A file, headers.txt, will be created. Find the `"X-Auth-Token"` in that file.
+Save it away in an env variable like so:
 
 ```
 export bmc_token=<token>
 ```
 
-#####  Method 2
+##### Method 2
+
 ```
 export bmc=xx.xx.xx.xx
 export token=`curl -k -H "Content-Type: application/json" -X POST https://${bmc}/login -d '{"username" :  "root", "password" :  "0penBmc"}' | grep token | awk '{print $2;}' | tr -d '"'`
 curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/...
 ```
+
 Note: Method 2 is used in this document.
 
 ---
 
 ## View Redfish Objects
+
 ```
 curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Chassis
 curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Managers
@@ -48,64 +55,77 @@ curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Systems
 ---
 
 ## View sessions
+
 ```
 curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/SessionService/Sessions
 ```
 
 ---
 
 ## Host power
+
 Host soft power off:
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "GracefulShutdown"}'
 ```
 
 Host hard power off:
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "ForceOff"}'
 ```
 
 Host power on:
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "On"}'
 ```
 
 Reboot Host:
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "GracefulRestart"}'
 ```
 
 ---
 
 ## BMC reboot
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/Managers/bmc/Actions/Manager.Reset -d '{"ResetType": "GracefulRestart"}'
 ```
 
 ---
 
 ## BMC factory reset
+
 Proceed with caution:
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/Managers/bmc/Actions/Manager.ResetToDefaults -d '{"ResetToDefaultsType": "ResetAll"}'
 ```
 
 ---
 
 ## Log entry
+
 Display logging entries:
+
 ```
 curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries
 ```
 
 Delete logging entries:
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.Reset
 ```
 
 ---
 
 ## Firmware ApplyTime:
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PATCH -d '{"HttpPushUriOptions":{"HttpPushUriApplyTime":{"ApplyTime":"Immediate"}}}' https://${bmc}/redfish/v1/UpdateService
 ```
@@ -119,71 +139,83 @@ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PATCH -
 ---
 
 ## Firmware update
-Firmware update:
-Note the `<image file path>` must be a tarball.
+
+Firmware update: Note the `<image file path>` must be a tarball.
 
 ```
 uri=$(curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/UpdateService | jq -r ' .HttpPushUri')
 
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/octet-stream" -X POST -T <image file path> https://${bmc}${uri}
 ```
 
-TFTP Firmware update using TransferProtocol:
-Note: The `<image file path>` contains the address of the TFTP service: `xx.xx.xx.xx/obmc-phosphor-xxxxx-xxxxxxxxx.static.mtd.tar`
+TFTP Firmware update using TransferProtocol: Note: The `<image file path>`
+contains the address of the TFTP service:
+`xx.xx.xx.xx/obmc-phosphor-xxxxx-xxxxxxxxx.static.mtd.tar`
 
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate -d '{"TransferProtocol":"TFTP","ImageURI":"<image file path>"}'
 ```
+
 TFTP Firmware update with protocol in ImageURI:
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate -d '{"ImageURI":"tftp://<image file path>"}'
 ```
 
 ---
 
 ## Update "root" password
+
 Change password to "0penBmc1":
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PATCH -d '{"Password": "0penBmc1"}' https://${bmc}/redfish/v1/AccountService/Accounts/root
 ```
 
 ---
 
 ## BIOS firmware boot control
+
 Enter into BIOS setup on boot
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PATCH https://${bmc}/redfish/v1/Systems/system -d '{"Boot":{"BootSourceOverrideEnabled": "Continuous","BootSourceOverrideTarget": "BiosSetup"}}'
 ```
 
 Fully boot
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PATCH https://${bmc}/redfish/v1/Systems/system -d '{"Boot":{"BootSourceOverrideEnabled": "Disabled","BootSourceOverrideTarget": "None"}}'
 ```
 
 Change Legacy/EFI selector (valid only if host is based on the x86 CPU)
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PATCH https://${bmc}/redfish/v1/Systems/system -d '{"Boot":{"BootSourceOverrideEnabled": "Once","BootSourceOverrideTarget": "None","BootSourceOverrideMode": "UEFI"}}'
 ```
 
 ---
 
 ## Enable NTP
+
 Add a NTP Server
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PATCH https://${bmc}/redfish/v1/Managers/bmc/NetworkProtocol -d '{"NTP":{"NTPServers":["time.nist.gov"]}}'
 ```
 
 Now enable NTP
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PATCH https://${bmc}/redfish/v1/Managers/bmc/NetworkProtocol -d '{"NTP":{"ProtocolEnabled": true}}'
 ```
 
 ---
 
 ## Disable IPMI
+
 ```
 curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PATCH https://${bmc}/redfish/v1/Managers/bmc/NetworkProtocol -d '{"IPMI":{"ProtocolEnabled": false}}'
 ```
 
-
 [1]: https://www.dmtf.org/standards/redfish