Fix markdownlint and shellcheck errors
This commit addresses issues with markdownlint complaining
about unspecified languages for the fenced code blocks in
the README.md files of the main repo and the dreport tool.
Resolved this by specifying 'bash' as the language for
these code blocks in both README.md files.
Additionally added tools/dreport.d/ibm.d/plugins.d/badpel
to .shellcheck-ignore to suppress SC1091 and SC2086
errors
Change-Id: I3432dc87999f518949a9459d2ab07e21a73595b1
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
diff --git a/.shellcheck-ignore b/.shellcheck-ignore
index 004cf65..f546731 100644
--- a/.shellcheck-ignore
+++ b/.shellcheck-ignore
@@ -32,3 +32,4 @@
tools/dreport.d/plugins.d/timedate
tools/dreport.d/plugins.d/top
tools/dreport.d/plugins.d/uptime
+tools/dreport.d/ibm.d/plugins.d/badpel
diff --git a/README.md b/README.md
index 88bc284..c221e7a 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@
To build this package with meson, do the following steps:
-```
+```bash
1. meson builddir
2. ninja -C builddir
```
@@ -24,7 +24,7 @@
or with an OpenBMC x86 sdk(see below for x86 steps).
-```
+```bash
meson -Dtests=enabled build
ninja -C build test
```
diff --git a/tools/dreport.d/README.md b/tools/dreport.d/README.md
index 21c573a..861eae6 100644
--- a/tools/dreport.d/README.md
+++ b/tools/dreport.d/README.md
@@ -24,7 +24,7 @@
archive. Each plugin needs a comment line like the following to specify which
dump types should trigger it:
-```
+```bash
# config A B
```
@@ -34,7 +34,7 @@
For example, the `bmcstate` plugin has:
-```
+```bash
# config: 12345 5
```
@@ -44,7 +44,7 @@
During the bitbake build, the script will be linked into a directory based on
the dump type, with the priority built into the name:
-```
+```bash
/usr/share/dreport.d# find /usr/share/dreport.d/ -name *bmcstate
/usr/share/dreport.d/plugins.d/bmcstate
/usr/share/dreport.d/pl_user.d/E5bmcstate
diff --git a/tools/dreport.d/ibm.d/plugins.d/badpel b/tools/dreport.d/ibm.d/plugins.d/badpel
index 08beb65..a1de332 100644
--- a/tools/dreport.d/ibm.d/plugins.d/badpel
+++ b/tools/dreport.d/ibm.d/plugins.d/badpel
@@ -10,5 +10,5 @@
file_name="/var/lib/phosphor-logging/extensions/pels/badPEL"
if [ -e "$file_name" ]; then
- add_copy_file "$file_name" "$desc"
+ add_copy_file "$file_name" "$desc"
fi