Skip to content

Commit 4d97e15

Browse files
committed
s390-tools: Update README.md and rust/README.md
Add missing build requirements and dependency information to README.md and rust/README.md. Signed-off-by: Jan Höppner <[email protected]>
1 parent a32fe86 commit 4d97e15

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Package contents
1919
all s390-tools that are written in rust and require external crates.
2020
Disable the compilation of all tools in `rust/` using HAVE_CARGO=0
2121
See the `rust/README.md` for Details
22+
- cpacfinfo:
23+
Command line interface to get information about CP Assist for
24+
Cryptographic Functions (CPACF)
2225
- pvattest:
2326
Create, perform, and verify IBM Secure Execution attestation measurements.
2427
- pvapconfig:
@@ -317,7 +320,7 @@ build options:
317320
| glibc-static | `HAVE_LIBC_STATIC` | zfcpdump |
318321
| openssl | `HAVE_OPENSSL` | zkey, libekmfweb, libkmipclient, |
319322
| | | zgetdump, rust/pvattest, rust/pvimg, |
320-
| | | zgetdump/pvsecret |
323+
| | | zgetdump/pvsecret, opticsmon |
321324
| cryptsetup | `HAVE_CRYPTSETUP2` | zkey-cryptsetup |
322325
| json-c | `HAVE_JSONC` | zkey-cryptsetup, libekmfweb, |
323326
| | | libkmipclient |
@@ -327,6 +330,7 @@ build options:
327330
| libxml2 | `HAVE_LIBXML2` | libkmipclient |
328331
| systemd | `HAVE_SYSTEMD` | hsavmcore |
329332
| libudev | `HAVE_LIBUDEV` | cpacfstatsd |
333+
| libnl3 | `HAVE_LIBNL3` | opticsmon |
330334

331335
This table lists additional build or install options:
332336

@@ -374,6 +378,12 @@ the different tools are provided:
374378

375379
The runtime requirements are: openssl-libs (>= 1.1.1) and libcurl.
376380

381+
* opticsmon:
382+
For building opticsmon OpenSSL and the Netlink Library Suite (libnl3) are
383+
required.
384+
Tip: you may skip the opticsmon build by adding
385+
`HAVE_OPENSSL=0` or `HAVE_LIBNL3=0`
386+
377387
* osasnmpd:
378388
You need at least the NET-SNMP 5.1.x package (net-snmp-devel.rpm)
379389
installed, before building the osasnmpd subagent.

rust/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,6 @@ Tip: You can use `make version` to get the version string.
3737
* reexports ann symbols from __pv_core__
3838
* if no encryption utilities required, use __pv_core__
3939

40-
## Tools
41-
* __pvsecret__ _Manage secrets for IBM Secure Execution guests_
42-
* __pvapconfig__ _automatic configure APQNs within an SE KVM guest_
43-
4440
## Writing new tools
4541
We encourage to use Rust for new tools. However, for some use cases it makes
4642
sense to use C and C is still allowed to be used for a new tool/library.
@@ -58,6 +54,8 @@ is a start, but can change over time.
5854

5955
* [anyhow](https://crates.io/crates/anyhow)
6056
* Flexible concrete Error type built on std::error::Error
57+
* [base64](https://crates.io/crates/base64)
58+
* Encodes and decodes base64 as bytes or utf8
6159
* [byteorder](https://crates.io/crates/byteorder)
6260
* Library for reading/writing numbers in big-endian and little-endian.
6361
* [cfg-if](https://crates.io/crates/cfg-if)
@@ -68,6 +66,8 @@ is a start, but can change over time.
6866
* A simple to use, efficient, and full-featured Command Line Argument Parser
6967
* [curl](https://crates.io/crates/curl)
7068
* Rust bindings to libcurl for making HTTP requests
69+
* [deku](https://crates.io/crates/deku)
70+
* Bit level serialization/deserialization proc-macro for structs
7171
* [libc](https://crates.io/crates/libc)
7272
* Raw FFI bindings to platform libraries like libc.
7373
* [log](https://crates.io/crates/log)
@@ -76,6 +76,8 @@ is a start, but can change over time.
7676
* OpenSSL bindings
7777
* [serde](https://crates.io/crates/serde)
7878
* A generic serialization/deserialization framework
79+
* [serde_jsonl](https://crates.io/crates/serde_json)
80+
* A JSON serialization file format
7981
* [serde_yaml](https://crates.io/crates/serde_yaml)
8082
* YAML data format for Serde
8183
* [thiserror](https://crates.io/crates/thiserror)

0 commit comments

Comments
 (0)