Skip to content

Commit b46c708

Browse files
committed
README: move pldm behaviour overview to the introduction
Keep the build details in 'Building', but describe the overall function earlier. Also, add a note for multiple feature support. Signed-off-by: Jeremy Kerr <[email protected]>
1 parent 1a2be9d commit b46c708

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,18 @@ NVMe-MI protocol, emulating a simple MCTP-managed storage device. The NVMe-MI
1717
responder implementation is provided by the
1818
[`nvme-mi-dev`](https://github.com/CodeConstruct/nvme-mi-dev) crate.
1919

20+
We also support a test client for PLDM for File Transfer (type 7). When
21+
`mctp-dev` is assigned an MCTP EID, it will perform PLDM operations to
22+
read a file from the bus owner EID.
23+
24+
The PLDM client expects to find the File record as the first PDR entry, and
25+
will attempt to transfer the entire file. Upon completion, the file size and
26+
sha256 checksum will be printed:
27+
28+
```
29+
11:06:34 [INFO] Transfer complete. 16384 bytes, sha256 b4d3f1859dc8170c1e1f34b936aff05339a7723b6680894380c23dd84ff7e22b
30+
```
31+
2032
# Building
2133

2234
For most systems:
@@ -35,22 +47,16 @@ To incorporate NVMe-MI responder support, add the `nvme-mi` feature:
3547
cargo build --features nvme-mi
3648
```
3749

38-
We also support a test client for PLDM for File Transfer (type 7). When
39-
`mctp-dev` is assigned an MCTP EID, it will perform PLDM operations to
40-
read a file from the bus owner EID.
41-
42-
The PLDM client expects to find the File record as the first PDR entry, and
43-
will attempt to transfer the entire file. Upon completion, the file size and
44-
sha256 checksum will be printed:
50+
To enable the PLDM File functionality, add the `pldm` feature:
4551

46-
```
47-
11:06:34 [INFO] Transfer complete. 16384 bytes, sha256 b4d3f1859dc8170c1e1f34b936aff05339a7723b6680894380c23dd84ff7e22b
52+
```sh
53+
cargo build --features pldm
4854
```
4955

50-
To enable the PLDM File functionality, add the `pldm` feature:
56+
Both may be enabled in the same build too:
5157

5258
```sh
53-
cargo build --features pldm
59+
cargo build --features nvme-mi,pldm
5460
```
5561

5662
# Running

0 commit comments

Comments
 (0)