Fix MD040 warnings
The following warnings are generated by using markdownlint analysis:
```
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
```
Refer to markdown-lint [1] to fix MD040
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/040-fenced-code-language.md
Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: Ie984f706001b77f1f791b53a9801b595f775ec09
diff --git a/README.md b/README.md
index 1085270..bdc799b 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@
Then run these commands in the source directory.
-```
+```sh
./autogen.sh --prefix=/usr
make install
```
@@ -32,7 +32,7 @@
Then run these commands in the source directory.
-```
+```sh
./autogen.sh
make
make install
@@ -45,7 +45,7 @@
Then run these commands in the source directory.
-```
+```sh
./bootstrap.sh
./configure
make
@@ -58,7 +58,7 @@
Then run these commands in the source directory.
-```
+```sh
meson setup -Dexamples=false -Dtests=disabled builddir
ninja -C builddir
ninja -C builddir install
@@ -71,7 +71,7 @@
Then run these commands in the source directory.
-```
+```sh
./bootstrap.sh
./configure --disable-build-bmc-blob-handler
make
@@ -80,7 +80,7 @@
_NOTE:_ When building from the OpenBMC SDK your configuration call will be:
-```
+```sh
./configure --enable-oe-sdk --host "$(uname -m)" --disable-build-bmc-blob-handler AR=x86_64-openbmc-linux-gcc-ar RANLIB=x86_64-openbmc-linux-gcc-ranlib
```
diff --git a/bmc/README.md b/bmc/README.md
index 48e02aa..207a1e1 100644
--- a/bmc/README.md
+++ b/bmc/README.md
@@ -13,26 +13,26 @@
An example config file -
-```
+```json
{
- "blob": "/flash/adm1266_sink0",
- "handler": {
- "type": "file",
- "path": "/var/run/adm1266/adm1266_sink0.hex"
+ "blob": "/flash/adm1266_sink0",
+ "handler": {
+ "type": "file",
+ "path": "/var/run/adm1266/adm1266_sink0.hex"
+ },
+ "actions": {
+ "preparation": {
+ "type": "skip"
},
- "actions": {
- "preparation": {
- "type": "skip"
- },
- "verification": {
- "type": "systemd",
- "unit": "adm1266-verify@sink0.service"
- },
- "update": {
- "type": "systemd",
- "unit": "adm1266-update@sink0.service"
- }
+ "verification": {
+ "type": "systemd",
+ "unit": "adm1266-verify@sink0.service"
+ },
+ "update": {
+ "type": "systemd",
+ "unit": "adm1266-update@sink0.service"
}
+ }
}
```
@@ -55,23 +55,23 @@
### Workflow of log handler
-```
+```json
{
- "blob": "/log/blackbox_adm1266_sink0",
- "handler": {
- "type": "file",
- "path": "/var/run/adm1266/adm1266_sink0.log"
+ "blob": "/log/blackbox_adm1266_sink0",
+ "handler": {
+ "type": "file",
+ "path": "/var/run/adm1266/adm1266_sink0.log"
+ },
+ "actions": {
+ "open": {
+ "type": "systemd",
+ "unit": "adm1266-read-blackbox-log@sink0.service"
},
- "actions":{
- "open": {
- "type": "systemd",
- "unit": "adm1266-read-blackbox-log@sink0.service"
- },
- "delete": {
- "type": "systemd",
- "unit": "adm1266-clear-blackbox-data@sink0.service"
- }
+ "delete": {
+ "type": "systemd",
+ "unit": "adm1266-clear-blackbox-data@sink0.service"
}
+ }
}
```
diff --git a/bmc_json_config.md b/bmc_json_config.md
index 2c85638..0de4cde 100644
--- a/bmc_json_config.md
+++ b/bmc_json_config.md
@@ -18,28 +18,30 @@
This file is generated from configuration and therefore some values can be
replaced, here we're using the defaults.
-```
-[{
+```json
+[
+ {
"blob": "/flash/bios",
"handler": {
- "type": "file",
- "path": "/tmp/bios-image"
+ "type": "file",
+ "path": "/tmp/bios-image"
},
"actions": {
- "preparation": {
- "type": "systemd",
- "unit": "phosphor-ipmi-flash-bios-prepare.target"
- },
- "verification": {
- "type": "systemd",
- "unit": "phosphor-ipmi-flash-bios-verify.target"
- },
- "update": {
- "type": "systemd",
- "unit": "phosphor-ipmi-flash-bios-update.target"
- }
+ "preparation": {
+ "type": "systemd",
+ "unit": "phosphor-ipmi-flash-bios-prepare.target"
+ },
+ "verification": {
+ "type": "systemd",
+ "unit": "phosphor-ipmi-flash-bios-verify.target"
+ },
+ "update": {
+ "type": "systemd",
+ "unit": "phosphor-ipmi-flash-bios-update.target"
+ }
}
-}]
+ }
+]
```
Each json file is expected to be an array of flash handler configurations. You
@@ -115,27 +117,29 @@
This file is generated from configuration and therefore some values can be
replaced, here we're using the defaults.
-```
-[{
+```json
+[
+ {
"blob": "/flash/image",
"handler": {
- "type": "file",
- "path": "/run/initramfs/bmc-image"
+ "type": "file",
+ "path": "/run/initramfs/bmc-image"
},
"actions": {
- "preparation": {
- "type": "systemd",
- "unit": "phosphor-ipmi-flash-bmc-prepare.target"
- },
- "verification": {
- "type": "systemd",
- "unit": "phosphor-ipmi-flash-bmc-verify.target"
- },
- "update": {
- "type": "reboot"
- }
+ "preparation": {
+ "type": "systemd",
+ "unit": "phosphor-ipmi-flash-bmc-prepare.target"
+ },
+ "verification": {
+ "type": "systemd",
+ "unit": "phosphor-ipmi-flash-bmc-verify.target"
+ },
+ "update": {
+ "type": "reboot"
+ }
}
-}]
+ }
+]
```
Given the bios configuration, we can skip the parts of this configuration that
@@ -147,28 +151,30 @@
This file is generated from configuration and therefore some values can be
replaced, here we're using the defaults.
-```
-[{
+```json
+[
+ {
"blob": "/flash/image",
"handler": {
- "type": "file",
- "path": "/run/initramfs/bmc-image"
+ "type": "file",
+ "path": "/run/initramfs/bmc-image"
},
"actions": {
- "preparation": {
- "type": "systemd",
- "unit": "phosphor-ipmi-flash-bmc-prepare.target"
- },
- "verification": {
- "type": "systemd",
- "unit": "phosphor-ipmi-flash-bmc-verify.target"
- },
- "update": {
- "type": "systemd",
- "unit": "phosphor-ipmi-flash-bmc-update.target"
- }
+ "preparation": {
+ "type": "systemd",
+ "unit": "phosphor-ipmi-flash-bmc-prepare.target"
+ },
+ "verification": {
+ "type": "systemd",
+ "unit": "phosphor-ipmi-flash-bmc-verify.target"
+ },
+ "update": {
+ "type": "systemd",
+ "unit": "phosphor-ipmi-flash-bmc-update.target"
+ }
}
-}]
+ }
+]
```
This configuration is of no significance in its difference.