Added a new "Features" page both to the documentation and manpage.

xvitaly · Oct 5, 2024 · 733486b · 733486b
1 parent 57594f9
commit 733486b
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/assets/manpage/zswap-cli.md.in b/assets/manpage/zswap-cli.md.in
@@ -12,6 +12,24 @@
 
 @APP_NAME@ is a command-line tool to control the ZSwap kernel module.
 
+# FEATURES
+
+Supported options:
+
+| Name | Value | Status | Kernel version |
+| ------- | ------- | ------- | ------- |
+| enabled | **Y** (enable) or **N** (disable) | Active | Any |
+| same_filled_pages_enabled | **Y** (enable) or **N** (disable) | Deprecated | 4.16.0 to 6.10.0 |
+| max_pool_percent | integer from **1** to **100** | Active | Any |
+| compressor | from supported by kernel | Active | Any |
+| zpool | from supported by kernel | Active | Any |
+| accept_threshold_percent | integer from **1** to **100** | Active | 5.6.0 or higher |
+| non_same_filled_pages_enabled | **Y** (enable) or **N** (disable) | Deprecated | 5.18.0 to 6.10.0 |
+| exclusive_loads | **Y** (enable) or **N** (disable) | Deprecated | 6.5.0 to 6.9.0 |
+| shrinker_enabled | **Y** (enable) or **N** (disable) | Active | 6.8.0 or higher |
+
+Deprecated functionality will be removed in future project versions.
+
 # COMMAND-LINE OPTIONS
 
 #### \-\-help

diff --git a/docs/README.md b/docs/README.md
@@ -2,6 +2,7 @@
 
 ## Table of contents
 
+  * [Features](features.md).
   * [Installation](installation.md).
   * [Using application](using-application.md).
   * [Configuration files](configuration-files.md).

diff --git a/docs/features.md b/docs/features.md
@@ -0,0 +1,17 @@
+# Features
+
+Supported options:
+
+| Name | Value | Status | Kernel version |
+| ------- | ------- | ------- | ------- |
+| enabled | **Y** (enable) or **N** (disable) | Active | Any |
+| same_filled_pages_enabled | **Y** (enable) or **N** (disable) | Deprecated | 4.16.0 to 6.10.0 |
+| max_pool_percent | integer from **1** to **100** | Active | Any |
+| compressor | from supported by kernel | Active | Any |
+| zpool | from supported by kernel | Active | Any |
+| accept_threshold_percent | integer from **1** to **100** | Active | 5.6.0 or higher |
+| non_same_filled_pages_enabled | **Y** (enable) or **N** (disable) | Deprecated | 5.18.0 to 6.10.0 |
+| exclusive_loads | **Y** (enable) or **N** (disable) | Deprecated | 6.5.0 to 6.9.0 |
+| shrinker_enabled | **Y** (enable) or **N** (disable) | Active | 6.8.0 or higher |
+
+Deprecated functionality will be removed in future project versions.