kata-containers/s390-tools
1
0
Fork 0
mirror of https://github.com/ibm-s390-linux/s390-tools.git synced 2026-08-05 02:14:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

rust/pv: More documentation

Browse Source 
Improve the API documentation of the pv crate.

Acked-by: Marc Hartmayer <mhartmay@linux.ibm.com>
Signed-off-by: Steffen Eiden <seiden@linux.ibm.com>
This commit is contained in:
Steffen Eiden
2024-03-07 16:27:29 +01:00
parent 38600bb4e2
commit 7b94783cb7
8 changed files with 101 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
rust/pv_core/README.md
+24
View File
@@ -0,0 +1,24 @@
<!--
SPDX-License-Identifier: MIT
Copyright 2024 IBM Corp.
-->
# s390_pv_core - basic library for pv-tools
This library is intended to be used by tools and libraries that
are used for creating and managing [IBM Secure Execution](https://www.ibm.com/docs/en/linux-on-systems?topic=virtualization-secure-execution) guests.
`s390_pv_core` provides abstraction layers for secure memory management,
logging, and accessing the uvdevice.
If your project is not targeted to provide tooling for and/or managing of IBM Secure execution
guests, do **not** use this crate.
It does not provide any cryptographic operations through OpenSSL.
For this use [s390_pv](https://crates.io/crates/s390_pv_core) which reexports all symbols from this crate.
If your project uses `s390_pv` crate do **not** include `s390_pv_core` as well.
## Import crate
The recommended way of importing this crate is:
```bash
cargo add s390_pv_core --rename pv_core
```