linux-modules.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Emil Velikov via B4 Relay <devnull+emil.l.velikov.gmail.com@kernel.org>
To: linux-modules@vger.kernel.org
Cc: Emil Velikov <emil.l.velikov@gmail.com>
Subject: [PATCH kmod v2 04/17] man: some options take an argument, mention that
Date: Mon, 08 Jul 2024 14:43:12 +0100	[thread overview]
Message-ID: <20240708-man-v2-4-a23df6ef871e@gmail.com> (raw)
In-Reply-To: <20240708-man-v2-0-a23df6ef871e@gmail.com>

From: Emil Velikov <emil.l.velikov@gmail.com>

For example modinfo -F requires the field name, although the
documentation was missing the "field".

Similarly modprobe has omissions, so let's fix those as well.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
There are two different styles across the man pages:
 -s, --short foo
 -s foo, --short foo

A proposal to resolve these comes with a later patch in this series.
---
 man/depmod.8.scd   | 2 +-
 man/modinfo.8.scd  | 4 ++--
 man/modprobe.8.scd | 6 +++---
 3 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/man/depmod.8.scd b/man/depmod.8.scd
index 80cc48d..7a2e84b 100644
--- a/man/depmod.8.scd
+++ b/man/depmod.8.scd
@@ -72,7 +72,7 @@ rather than the current kernel version (as returned by *uname -r*).
 	assumption can break especially when additionally updated third party
 	drivers are not correctly installed or were built incorrectly.
 
-*-E*, *--symvers*
+*-E*, *--symvers* _Module.symvers_
 	When combined with the *-e* option, this reports any symbol versions
 	supplied by modules that do not match with the symbol versions provided
 	by the kernel in its _Module.symvers_. This option is mutually
diff --git a/man/modinfo.8.scd b/man/modinfo.8.scd
index 75267bc..9545257 100644
--- a/man/modinfo.8.scd
+++ b/man/modinfo.8.scd
@@ -31,8 +31,8 @@ architecture.
 *-V*, *--version*
 	Print the *modinfo* version.
 
-*-F*, *--field*
-	Only print this field value, one per line. This is most useful for
+*-F* _field_, *--field* _field_
+	Only print this _field_ value, one per line. This is most useful for
 	scripts. Field names are case-insensitive. Common fields (which may not
 	be in every module) include author, description, license, parm, depends,
 	and alias. There are often multiple parm, alias and depends fields. The
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index f4ce0be..9594798 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -55,7 +55,7 @@ database.
 	configuration files (if any) to module names as well. It is usually used
 	by *udev*(7).
 
-*-C*, *--config*
+*-C* _directory_, *--config* _directory_
 	This option overrides the default configuration directory
 	(/etc/modprobe.d).
 
@@ -151,14 +151,14 @@ database.
 	require it. Your distribution kernel may not have been built to support
 	removal of modules at all.
 
-*-w*, *--wait=*TIMEOUT_MSEC
+*-w* _TIMEOUT_MSEC_, *--wait* _TIMEOUT_MSEC_
 	This option causes *modprobe -r *to continue trying to remove a module
 	if it fails due to the module being busy, i.e. its refcount is not 0 at
 	the time the call is made. Modprobe tries to remove the module with an
 	incremental sleep time between each tentative up until the maximum wait
 	time in milliseconds passed in this option.
 
-*-S*, *--set-version*
+*-S* _version_, *--set-version* _version_
 	Set the kernel version, rather than using *uname*(2) to decide on the
 	kernel version (which dictates where to find the modules).
 

-- 
2.45.2



  parent reply	other threads:[~2024-07-08 13:43 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 01/17] man: add some extra bold/italic annotations Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 02/17] man: white space fixes Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 03/17] man: misc punctuation fixes Emil Velikov via B4 Relay
2024-07-08 13:43 ` Emil Velikov via B4 Relay [this message]
2024-07-08 13:43 ` [PATCH kmod v2 05/17] man: couple of grammar/language fixes Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 06/17] man: stop removing DISTCONFDIR lines Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 07/17] man: depmod.d: document the config file order handling Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 08/17] man: depmod.d: factor out a CONFIGURATION FORMAT section Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 09/17] man: depmod.d: rework the opening description sentence Emil Velikov via B4 Relay
2024-07-09  5:01   ` Lucas De Marchi
2024-07-08 13:43 ` [PATCH kmod v2 10/17] man: depmod: remove hard-coded /etc/depmod.d references Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 11/17] man: modprobe.d: document the config file order handling Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 12/17] man: modprobe.d: factor out a CONFIGURATION FORMAT section Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 13/17] man: add few mentions about MODPROBE_OPTIONS Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 14/17] man: modprobe: remove hard-coded /etc/modprobe.d references Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 15/17] man: remove the "Maintained by" references Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 16/17] man: rework AUTHORS section Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 17/17] man: list options one per line Emil Velikov via B4 Relay
2024-07-09  5:20 ` [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Lucas De Marchi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240708-man-v2-4-a23df6ef871e@gmail.com \
    --to=devnull+emil.l.velikov.gmail.com@kernel.org \
    --cc=emil.l.velikov@gmail.com \
    --cc=linux-modules@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).