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: Ib442712e2562fac166148ce795f0a83511ad84cd
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
diff --git a/subprojects/libcr51sign/README.md b/subprojects/libcr51sign/README.md
index 89496e8..8a64987 100644
--- a/subprojects/libcr51sign/README.md
+++ b/subprojects/libcr51sign/README.md
@@ -2,7 +2,7 @@
### Package `libcr51sign`
-* Status: **Ready**
+- Status: **Ready**
Libcr51sign is a library to verify images signed in the Cr51 format which can be
shared between all systems requiring this functionality. Given an absolute start
@@ -41,4 +41,3 @@
Note: libcr51sign will also provide a companion library with default SW
implementations of common functions like hash_init/final,
read_and_hash_update().
-
diff --git a/subprojects/metrics-ipmi-blobs/README.md b/subprojects/metrics-ipmi-blobs/README.md
index c9302eb..52fd2e1 100644
--- a/subprojects/metrics-ipmi-blobs/README.md
+++ b/subprojects/metrics-ipmi-blobs/README.md
@@ -2,7 +2,8 @@
This BLOB handler registers one blob with the name "/metric/snapshot".
-The contents of the BLOB is a protocol buffer containing an instantaneous snapshot of the BMC's health metrics, which includes the following categories:
+The contents of the BLOB is a protocol buffer containing an instantaneous
+snapshot of the BMC's health metrics, which includes the following categories:
1. BMC memory metric: mem_available, slab, kernel_stack
2. Uptime: uptime in wall clock time, idle process across all cores
diff --git a/subprojects/ncsid/README.md b/subprojects/ncsid/README.md
index 84dc482..7a38f76 100644
--- a/subprojects/ncsid/README.md
+++ b/subprojects/ncsid/README.md
@@ -1,3 +1,3 @@
# NC-SI Daemon for gBMC
-* [Internals](doc/ncsid_internals.md)
+- [Internals](doc/ncsid_internals.md)
diff --git a/subprojects/ncsid/doc/ncsid_internals.md b/subprojects/ncsid/doc/ncsid_internals.md
index a85e6f6..858a2a7 100644
--- a/subprojects/ncsid/doc/ncsid_internals.md
+++ b/subprojects/ncsid/doc/ncsid_internals.md
@@ -1,6 +1,6 @@
# NC-SId Internals
-__NOTE__: This documents describes the internal architecture of NC-SId daemon.
+**NOTE**: This documents describes the internal architecture of NC-SId daemon.
However, it is meant to be used as a guide for understanding the code, not on
its own. Some details are intentionally omitted.
@@ -8,14 +8,14 @@
In the diagram above the components are split into four groups:
-* __NC-SId Core__. These are new components implemented in NC-SId.
+- **NC-SId Core**. These are new components implemented in NC-SId.
-* __Hardware__. External hardware components, in this case, the NIC.
+- **Hardware**. External hardware components, in this case, the NIC.
-* __EC__. This is the code borrowed from EC. The three state machines are
- pretty much copied from EC code.
+- **EC**. This is the code borrowed from EC. The three state machines are pretty
+ much copied from EC code.
-* __External Components__. These are external services/daemons NC-SIs interacts
+- **External Components**. These are external services/daemons NC-SIs interacts
with.
Let's look into their details.
@@ -23,8 +23,8 @@
## NIC
In the NIC — NC-SId interactions, NIC acts as a server, replying to NC-SId
-requests and NC-SId itself acts as a client, sending those requests. Thus,
-there is no state in NIC (server), but there is a state in NC-SId (client).
+requests and NC-SId itself acts as a client, sending those requests. Thus, there
+is no state in NIC (server), but there is a state in NC-SId (client).
## EC State Machines
@@ -54,12 +54,12 @@
In addition to the buffer there are parameters that provide information which is
not a part of EC state machines' state:
-* State Parameters. These structures are allocated outside of EC State Machines,
+- State Parameters. These structures are allocated outside of EC State Machines,
but their content is fully managed by EC State Machines.
-* MAC Address. For L2 FSM this parameter is _OUT_.
-* IP Address (only for L3/4 FSM and Test FSM) for setting up and verifying
+- MAC Address. For L2 FSM this parameter is _OUT_.
+- IP Address (only for L3/4 FSM and Test FSM) for setting up and verifying
filteres. If set to zero, the NIC filter won't check for IP address.
-* TCP Port (only for L3/4 FSM and Test FSM) for setting up and verifying
+- TCP Port (only for L3/4 FSM and Test FSM) for setting up and verifying
filters.
In the initial state the command buffer (reply from the NIC) is empty. When
diff --git a/subprojects/nemora-postd/README.md b/subprojects/nemora-postd/README.md
index f0e6792..5e95eed 100644
--- a/subprojects/nemora-postd/README.md
+++ b/subprojects/nemora-postd/README.md
@@ -4,30 +4,47 @@
## Tests
-The following instruction is for manual testing, but the Robot Framework test can follow the same logic.
+The following instruction is for manual testing, but the Robot Framework test
+can follow the same logic.
### Prerequisites
-Install the latest version of [Protocol Buffers](https://github.com/protocolbuffers/protobuf/releases/tag/v3.13.0), and the latest version of [Linux / UNIX TCP Port Forwarder](http://www.dest-unreach.org/socat/).
+
+Install the latest version of
+[Protocol Buffers](https://github.com/protocolbuffers/protobuf/releases/tag/v3.13.0),
+and the latest version of
+[Linux / UNIX TCP Port Forwarder](http://www.dest-unreach.org/socat/).
### Functional Tests
+
1. On BMC, stop the existing Nemora-postd;
+
```bash
systemctl stop nemora-postd@eth0
```
-2. On any machine, start a testing server at IP_SERVER listening to upcoming UDP datagrams;
+
+2. On any machine, start a testing server at IP_SERVER listening to upcoming UDP
+ datagrams;
+
```
DECODE_CMD="protoc --decode=platforms.nemora.proto.EventSeries event_message.proto"
exec socat udp-recvfrom:3960,fork exec:"$DECODE_CMD",fdout=stdout
```
-3. On BMC, start a new nemora session which sends POST codes to the testing server;
+
+3. On BMC, start a new nemora session which sends POST codes to the testing
+ server;
+
```
nemora-postd eth0 --udp4 $IP_SERVER
```
+
4. On BMC, manually change the DBus property via `busctl`;
+
```
busctl set-property xyz.openbmc_project.State.Boot.Raw /xyz/openbmc_project/state/boot/raw0 xyz.openbmc_project.State.Boot.Raw Value '('tay')' 10000004 3 1 2 3
```
+
5. The testing server should receive the following packet in about 20 seconds.
+
```bash
magic: 9876039085048616960
mac: ...
@@ -35,4 +52,6 @@
postcodes: 0x989684
postcodes_protocol: NATIVE_32_BIT
```
-Note that, `magic` and `postcodes_protocol` are fixed. `postcodes` should be what you set via `busctl`.
+
+Note that, `magic` and `postcodes_protocol` are fixed. `postcodes` should be
+what you set via `busctl`.