summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorManuel Bentele2020-10-12 16:44:52 +0200
committerManuel Bentele2020-10-12 16:44:52 +0200
commitccb981c4b403d7bbd962b281082b656b741e905f (patch)
treec57e6301bb9d520aeb47aab57c4e6b378f8a4970 /README.md
parentAdded debug support for xlosetup and documented debugging in README (diff)
downloadxloop-ccb981c4b403d7bbd962b281082b656b741e905f.tar.gz
xloop-ccb981c4b403d7bbd962b281082b656b741e905f.tar.xz
xloop-ccb981c4b403d7bbd962b281082b656b741e905f.zip
Added separate Linux kernel install directory and added version to kernel modules
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index 981f667..47f40f1 100644
--- a/README.md
+++ b/README.md
@@ -73,13 +73,14 @@ cd build
### Configuration
A build of the xloop Linux kernel modules and the xlosetup utility can be configured and customized by the following configuration variables (CMake cache entries):
-| Variable | Type | Values | Default value | Description |
-|:--------------------------|:-------|:----------------------------------------|:------------------------|-----------------------------------------------------|
-| `CMAKE_BUILD_TYPE` | STRING | {`Debug`, `Release`} | `Debug` | Build configuration of the xloop project. |
-| `KERNEL_DIR` | PATH | {`a` .. `z`, `A` .. `Z`, `/`, `_`, `-`} | /lib/modules/`uname -r` | Path to Linux kernel modules to compile against. |
-| `XLOOP_MAJOR` | NUMBER | {`0` .. `255`} | `120` | Major number for xloop devices. |
-| `XLOOP_CTRL_MINOR` | NUMBER | {`0` .. `255`} | `15` | Minor number for the xloop-control device. |
-| `BLK_DEV_XLOOP_MIN_COUNT` | NUMBER | {`0` .. `255`} | `8` | Number of xloop devices to pre-create at init time. |
+| Variable | Type | Values | Default value | Description |
+|:--------------------------|:-------|:----------------------------------------|:--------------------------------------------------|-----------------------------------------------------|
+| `CMAKE_BUILD_TYPE` | STRING | {`Debug`, `Release`} | `Debug` | Build configuration of the xloop project. |
+| `KERNEL_BUILD_DIR` | PATH | {`a` .. `z`, `A` .. `Z`, `/`, `_`, `-`} | /${CMAKE_INSTALL_LIBDIR}/modules/`uname -r`/build | Path to Linux kernel modules to compile against. |
+| `KERNEL_INSTALL_DIR` | PATH | {`a` .. `z`, `A` .. `Z`, `/`, `_`, `-`} | /${CMAKE_INSTALL_LIBDIR}/modules/`uname -r`/extra | Path to install Linux kernel modules. |
+| `XLOOP_MAJOR` | NUMBER | {`0` .. `255`} | `120` | Major number for xloop devices. |
+| `XLOOP_CTRL_MINOR` | NUMBER | {`0` .. `255`} | `15` | Minor number for the xloop-control device. |
+| `BLK_DEV_XLOOP_MIN_COUNT` | NUMBER | {`0` .. `255`} | `8` | Number of xloop devices to pre-create at init time. |
A value from the range of appropriate values can be assigend to each configuration variable by executing CMake once with the following command pattern: