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: I3106563ab231739d23314fc11de30082e959b87e
diff --git a/README.md b/README.md
index 6983a8a..d4524f2 100644
--- a/README.md
+++ b/README.md
@@ -136,12 +136,12 @@
### Two Margin Sensors Into Three Fans (Non-Step PID)
-```
A single zone system where multiple margin thermal sensors are fed into one PID
that generates the output RPM for a set of fans controlled by one PID.
margin sensors as input to thermal pid
+```text
fleeting0+---->+-------+ +-------+ Thermal PID sampled
| min()+--->+ PID | slower rate.
fleeting1+---->+-------+ +---+---+
diff --git a/configure.md b/configure.md
index 02752ca..311630a 100644
--- a/configure.md
+++ b/configure.md
@@ -40,7 +40,7 @@
### Sensors
-```
+```json
"sensors" : [
{
"name": "fan1",
@@ -109,7 +109,7 @@
writes over dbus to the `xyz.openbmc_project.Control.FanPwm` interface. The
`writePath` should be the full object path.
-```
+```text
busctl introspect xyz.openbmc_project.Hwmon-1644477290.Hwmon1 /xyz/openbmc_project/sensors/fan_tach/fan1 --no-pager
NAME TYPE SIGNATURE RESULT/VALUE FLAGS
org.freedesktop.DBus.Introspectable interface - - -
@@ -157,7 +157,7 @@
### Zones
-```
+```json
"zones" : [
{
"id": 1,
@@ -253,13 +253,15 @@
#### type == "fan"
-```
-"name": "fan1-5",
-"type": "fan",
-"inputs": ["fan1", "fan5"],
-"setpoint": 90.0,
-"pid": {
-...
+```json
+{
+ "name": "fan1-5",
+ "type": "fan",
+ "inputs": ["fan1", "fan5"],
+ "setpoint": 90.0,
+ "pid": {
+ ...
+ }
}
```
@@ -275,13 +277,15 @@
#### type == "margin"
-```
-"name": "fleetingpid0",
-"type": "margin",
-"inputs": ["fleeting0"],
-"setpoint": 10,
-"pid": {
-...
+```json
+{
+ "name": "fleetingpid0",
+ "type": "margin",
+ "inputs": ["fleeting0"],
+ "setpoint": 10,
+ "pid": {
+ ...
+ }
}
```
@@ -314,25 +318,27 @@
#### type == "stepwise"
-```
-"name": "temp1",
-"type": "stepwise",
-"inputs": ["temp1"],
-"setpoint": 30.0,
-"pid": {
- "samplePeriod": 0.1,
- "positiveHysteresis": 1.0,
- "negativeHysteresis": 1.0,
- "isCeiling": false,
- "reading": {
- "0": 45,
- "1": 46,
- "2": 47,
- },
- "output": {
- "0": 5000,
- "1": 2400,
- "2": 2600,
+```json
+{
+ "name": "temp1",
+ "type": "stepwise",
+ "inputs": ["temp1"],
+ "setpoint": 30.0,
+ "pid": {
+ "samplePeriod": 0.1,
+ "positiveHysteresis": 1.0,
+ "negativeHysteresis": 1.0,
+ "isCeiling": false,
+ "reading": {
+ "0": 45,
+ "1": 46,
+ "2": 47
+ },
+ "output": {
+ "0": 5000,
+ "1": 2400,
+ "2": 2600
+ }
}
}
```
diff --git a/tuning.md b/tuning.md
index 1fa8f08..718b784 100644
--- a/tuning.md
+++ b/tuning.md
@@ -21,7 +21,7 @@
`/usr/share/swampd/config.json`, one can modify the PID parameters in the config
file and restart the daemon to make the new values effective.
-```
+```sh
systemctl restart phosphor-pid-control.service
```
@@ -30,7 +30,7 @@
Flag `"-l \<path\>"` can be specified to enable the daemon to log fan control
data into `path`. The log output is in CSV format with the following header:
-```
+```sh
epoch_ms,setpt,fan1,fan2,...fanN,fleeting,failsafe
```