Skip to content

Commit 0484520

Browse files
committed
README: Update dependency documentation
Re-organize the documentation for dependencies, and add a mention of the kernel keyring options that need to be enabled. Signed-off-by: Chuck Lever <[email protected]>
1 parent da58601 commit 0484520

File tree

2 files changed

+36
-6
lines changed

2 files changed

+36
-6
lines changed

README

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,24 @@ this package is released.
1515

1616
## Dependencies
1717

18-
* The local kernel must have net/handshake support and be built with
19-
CONFIG_TLS enabled
20-
* The local build environment requires GnuTLS and keyutils
18+
### Run-time dependencies
19+
20+
The kernel must have net/handshake support (v6.5 or later) and be
21+
built with the following CONFIG options enabled:
22+
23+
* CONFIG_TLS
24+
* CONFIG_KEYS
25+
* CONFIG_KEYS_REQUEST_CACHE
26+
27+
### Build dependencies
28+
29+
The build environment requires the development packages for the
30+
following libraries to be installed:
31+
32+
* GnuTLS
33+
* keyutils
34+
* GLib-2.0
35+
* libnl3
2136

2237
## Installation
2338

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,24 @@ this package is released.
1515

1616
## Dependencies
1717

18-
* The local kernel must have net/handshake support and be built with
19-
CONFIG_TLS enabled
20-
* The local build environment requires GnuTLS and keyutils
18+
### Run-time dependencies
19+
20+
The kernel must have net/handshake support (v6.5 or later) and be
21+
built with the following CONFIG options enabled:
22+
23+
* CONFIG_TLS
24+
* CONFIG_KEYS
25+
* CONFIG_KEYS_REQUEST_CACHE
26+
27+
### Build dependencies
28+
29+
The build environment requires the development packages for the
30+
following libraries to be installed:
31+
32+
* GnuTLS
33+
* keyutils
34+
* GLib-2.0
35+
* libnl3
2136

2237
## Installation
2338

0 commit comments

Comments
 (0)