From: Benno Schulenberg <bensberg@telfort.nl>
Date: Sun, 6 Apr 2025 15:21:47 +0000 (+0200)
Subject: zramctl: (man) mention the required arguments for -p and -r
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=53244dd4e14082a849ac177174635efa57c2256a;p=thirdparty%2Futil-linux.git

zramctl: (man) mention the required arguments for -p and -r

Also, sort the options strictly alphabetically ("r" before "raw").

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---

diff --git a/sys-utils/zramctl.8.adoc b/sys-utils/zramctl.8.adoc
index 4cc402e5c..c08f1e005 100644
--- a/sys-utils/zramctl.8.adoc
+++ b/sys-utils/zramctl.8.adoc
@@ -54,18 +54,21 @@ Define the status output columns to be used. If no output arrangement is specifi
 +
 The default list of columns may be extended if _list_ is specified in the format _+list_ (e.g., *zramctl -o+COMP-RATIO*).
 
-*-p*, *--algorithm-params*::
-Set the algorithm parameters, for example, *level=9 dict=/etc/dictionary* to set compression level and pre-trained dictionary. Parameters are algorithm specific.
-
 *--output-all*::
 Output all available columns.
 
+*-p*, *--algorithm-params* _parameter_...::
+Specify the parameters for the selected compression algorithm.
+For example, *level=9 dict=/etc/dictionary* sets the compression level
+and pre-trained dictionary. Parameters are algorithm-specific.
+
+*-r*, *--reset* _zramdev_...::
+Reset the specified zram device(s).
+The settings of a zram device can be changed only after a reset.
+
 *--raw*::
 Use the raw format for status output.
 
-*-r*, *--reset*::
-Reset the options of the specified zram device(s). Zram device settings can be changed only after a reset.
-
 *-s*, *--size* _size_::
 Create a zram device of the specified _size_. Zram devices are aligned to memory pages; when the requested _size_ is not a multiple of the page size, it will be rounded up to the next multiple. When not otherwise specified, the unit of the _size_ parameter is bytes.
 +
diff --git a/sys-utils/zramctl.c b/sys-utils/zramctl.c
index b9ea5998e..fdb173ea5 100644
--- a/sys-utils/zramctl.c
+++ b/sys-utils/zramctl.c
@@ -751,9 +751,9 @@ static void __attribute__((__noreturn__)) usage(void)
 	fputs(_(" -n, --noheadings          don't print headings\n"), out);
 	fputs(_(" -o, --output <list>       columns to use for status output\n"), out);
 	fputs(_("     --output-all          output all columns\n"), out);
-	fputs(_(" -p, --algorithm-params <parameters>\n"
+	fputs(_(" -p, --algorithm-params <parameter>...\n"
 		"                           parameters for the compression algorithm\n"), out);
-	fputs(_(" -r, --reset               reset all specified devices\n"), out);
+	fputs(_(" -r, --reset <device>...   reset the specified zram devices\n"), out);
 	fputs(_("     --raw                 use raw status output format\n"), out);
 	fputs(_(" -s, --size <size>         device size\n"), out);
 	fputs(_(" -t, --streams <number>    number of compression streams\n"), out);