* [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion
@ 2024-07-08 13:43 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
` (17 more replies)
0 siblings, 18 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
Hello all,
Here is the remaining patches from my scdoc series, re-spinned with all
(:fingers-crossed:) the comments addressed.
The series includes:
- patch 1-5 - trivial fixes as white space, punctuation, etc
- patch 6-14 - expand documentation around {depmod,modprobe}.d
handling, remove open-coded .d and .conf references
- patch 15 - remove "maintained by" references
- patch 16 - NEW: replace all AUTHORS sections with suggested snippet
- patch 17 - list short and long options on separate lines
Note that make distcheck has regressed on the master branch, seemingly
due to the recent weakdep test.
---
Changes in v2:
- move extra bold annotation to correct patch - 2 -> 1
- reword the configuration directories section as suggested - 7, 11
- tweak MODPROBE_OPTIONS wording - 13
- add extra patch to rework the AUTHORS section as suggested - 16
- Link to v1: https://lore.kernel.org/r/20240611-man-v1-0-bd6864d49639@gmail.com
---
Emil Velikov (17):
man: add some extra bold/italic annotations
man: white space fixes
man: misc punctuation fixes
man: some options take an argument, mention that
man: couple of grammar/language fixes
man: stop removing DISTCONFDIR lines
man: depmod.d: document the config file order handling
man: depmod.d: factor out a CONFIGURATION FORMAT section
man: depmod.d: rework the opening description sentence
man: depmod: remove hard-coded /etc/depmod.d references
man: modprobe.d: document the config file order handling
man: modprobe.d: factor out a CONFIGURATION FORMAT section
man: add few mentions about MODPROBE_OPTIONS
man: modprobe: remove hard-coded /etc/modprobe.d references
man: remove the "Maintained by" references
man: rework AUTHORS section
man: list options one per line
man/Makefile.am | 8 ++--
man/depmod.8.scd | 78 ++++++++++++++++++++----------------
man/depmod.d.5.scd | 61 +++++++++++++++++-----------
man/insmod.8.scd | 11 +++---
man/kmod.8.scd | 24 +++++++----
man/lsmod.8.scd | 13 +++---
man/modinfo.8.scd | 38 +++++++++++-------
man/modprobe.8.scd | 107 +++++++++++++++++++++++++++++---------------------
man/modprobe.d.5.scd | 61 +++++++++++++++++-----------
man/modules.dep.5.scd | 22 ++++++-----
man/rmmod.8.scd | 25 +++++++-----
11 files changed, 268 insertions(+), 180 deletions(-)
---
base-commit: fa715f8c8b78a09f47701ce1cf46e9b67a49b8d0
change-id: 20240523-man-743d6e51eb6f
Best regards,
--
Emil Velikov <emil.l.velikov@gmail.com>
^ permalink raw reply [flat|nested] 20+ messages in thread
* [PATCH kmod v2 01/17] man: add some extra bold/italic annotations
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 ` Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 02/17] man: white space fixes Emil Velikov via B4 Relay
` (16 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
v2: add an extra depmod instance
---
man/depmod.8.scd | 20 ++++++++++----------
man/kmod.8.scd | 2 +-
man/modinfo.8.scd | 8 ++++----
man/modprobe.8.scd | 12 ++++++------
man/modules.dep.5.scd | 11 ++++++-----
man/rmmod.8.scd | 2 +-
6 files changed, 28 insertions(+), 27 deletions(-)
diff --git a/man/depmod.8.scd b/man/depmod.8.scd
index 0fe9128..34c1313 100644
--- a/man/depmod.8.scd
+++ b/man/depmod.8.scd
@@ -21,7 +21,7 @@ dependencies can get quite complex.
*depmod* creates a list of module dependencies by reading each module under
@MODULE_DIRECTORY@/_version_ and determining what symbols it exports and what
-symbols it needs. By default, this list is written to modules.dep, and a binary
+symbols it needs. By default, this list is written to *modules.dep*, and a binary
hashed version named modules.dep.bin, in the same directory. If filenames are
given on the command line, only those modules are examined (which is rarely
useful unless all modules are listed). * depmod* also creates a list of symbols
@@ -41,20 +41,20 @@ rather than the current kernel version (as returned by *uname -r*).
*-A*, *--quick*
This option scans to see if any modules are newer than the
- modules.dep file before any work is done: if not, it silently exits
+ *modules.dep* file before any work is done: if not, it silently exits
rather than regenerating the files.
*-b* _basedir_, *--basedir* _basedir_
If your modules are not currently in the (normal) directory
@MODULE_DIRECTORY@/_version_, but in a staging area, you can specify a
_basedir_ which is prepended to the directory name. This _basedir_ is
- stripped from the resulting modules.dep file, so it is ready to be moved
- into the normal location. Use this option if you are a distribution
- vendor who needs to pre-generate the meta-data files rather than running
- depmod again later.
+ stripped from the resulting *modules.dep* file, so it is ready to be
+ moved into the normal location. Use this option if you are a
+ distribution vendor who needs to pre-generate the meta-data files rather
+ than running *depmod* again later.
*-o* _outdir_, *--outdir* _outdir_
- Set the output directory where depmod will store any generated file.
+ Set the output directory where *depmod* will store any generated file.
_ outdir_ serves as a root to that location, similar to how _basedir_ is
used. Also this setting takes precedence and if used together with
_basedir_ it will result in the input being that directory, but the output
@@ -75,11 +75,11 @@ rather than the current kernel version (as returned by *uname -r*).
*-E*, *--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
+ by the kernel in its _Module.symvers_. This option is mutually
incompatible with *-F*.
*-F*, *--filesyms* _System.map_
- Supplied with the System.map produced when the kernel was built, this
+ Supplied with the _System.map_ produced when the kernel was built, this
allows the *-e* option to report unresolved symbols. This option is
mutually incompatible with *-E*.
@@ -87,7 +87,7 @@ rather than the current kernel version (as returned by *uname -r*).
Print the help message and exit.
*-n*, *--show*, *--dry-run*
- This sends the resulting modules.dep and the various map files to
+ This sends the resulting *modules.dep* and the various map files to
standard output rather than writing them into the module directory.
*-P*
diff --git a/man/kmod.8.scd b/man/kmod.8.scd
index d292a13..7bef863 100644
--- a/man/kmod.8.scd
+++ b/man/kmod.8.scd
@@ -6,7 +6,7 @@ kmod - Program to manage Linux Kernel modules
# SYNOPSIS
-*kmod* [*OPTIONS*...] [_COMMAND_] [*COMMAND_OPTIONS*...]
+*kmod* [*OPTIONS...*] [_COMMAND_] [*COMMAND_OPTIONS...*]
# DESCRIPTION
diff --git a/man/modinfo.8.scd b/man/modinfo.8.scd
index fd945ce..75267bc 100644
--- a/man/modinfo.8.scd
+++ b/man/modinfo.8.scd
@@ -29,14 +29,14 @@ architecture.
# OPTIONS
*-V*, *--version*
- Print the modinfo version.
+ Print the *modinfo* version.
*-F*, *--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
- special field filename lists the filename of the module.
+ special _field_ filename lists the filename of the module.
*-b* _basedir_, *--basedir* _basedir_
Root directory for modules, / by default.
@@ -50,9 +50,9 @@ architecture.
image prior to booting.
*-0*, *--null*
- Use the ASCII zero character to separate field values, instead of a new
+ Use the ASCII zero character to separate _field_ values, instead of a new
line. This is useful for scripts, since a new line can theoretically
- appear inside a field.
+ appear inside a _field_.
*-a* *--author*, *-d* *--description*, *-l* *--license*, *-p* *--parameters*,
*-n* *--filename*
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index f678654..653fbd9 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -9,11 +9,11 @@ modprobe - Add and remove modules from the Linux Kernel
*modprobe* [*-v*] [*-V*] [*-C *_config-file_] [*-n*] [*-i*] [*-q*] [*-b*] [_modulename_]
\ \ \ \ \ \ \ \ \ \[_module parameters_...]
-*modprobe* [-r] [*-v*] [*-n*] [*-i*] [_modulename_...]
+*modprobe* [*-r*] [*-v*] [*-n*] [*-i*] [_modulename_...]
-*modprobe* [-c]
+*modprobe* [*-c*]
-*modprobe* [--dump-modversions] [_filename_]
+*modprobe* [*--dump-modversions*] [_filename_]
# DESCRIPTION
@@ -42,7 +42,7 @@ If any arguments are given after the _modulename_, they are passed to the kernel
When loading modules, _modulename_ can also be a path to the module. If the path
is relative, it must explicitly start with "./". Note that this may fail when
-using a path to a module with dependencies not matching the installed depmod
+using a path to a module with dependencies not matching the installed *depmod*
database.
# OPTIONS
@@ -78,7 +78,7 @@ database.
module which is already present or to remove a module which isn't
present. This is ideal for simple scripts; however, more complicated
scripts often want to know whether *modprobe* really did something: this
- option makes modprobe fail in the case that it actually didn't do
+ option makes *modprobe* fail in the case that it actually didn't do
anything.
*--force-vermagic*
@@ -97,7 +97,7 @@ database.
detailing the versions of every interfaced used by (or supplied by) the
module is created. If a module fails to load and the kernel complains
that the module disagrees about a version of some interface, you can use
- "--force-modversion" to remove the version information altogether.
+ *--force-modversion* to remove the version information altogether.
Naturally, this check is there for your protection, so using this option
is dangerous unless you know what you're doing.
diff --git a/man/modules.dep.5.scd b/man/modules.dep.5.scd
index 34ffb83..c4e7653 100644
--- a/man/modules.dep.5.scd
+++ b/man/modules.dep.5.scd
@@ -12,13 +12,14 @@ modules.dep, modules.dep.bin - Module dependency information
# DESCRIPTION
-modules.dep.bin is a binary file generated by *depmod* listing the dependencies
-for every module in the directories under @MODULE_DIRECTORY@/_version_. It is
-used by kmod tools such as *modprobe* and libkmod.
+*modules.dep.bin* is a binary file generated by *depmod* listing the
+dependencies for every module in the directories under
+@MODULE_DIRECTORY@/_version_. It is used by *kmod* tools such as *modprobe* and
+libkmod.
Its text counterpart is located in the same directory with the name
-modules.dep. The text version is maintained only for easy of reading by humans
-and is in no way used by any kmod tool.
+*modules.dep*. The text version is maintained only for easy of reading by humans
+and is in no way used by any *kmod* tool.
These files are not intended for editing or use by any additional utilities as
their format is subject to change in the future. You should use the *modinfo*(8)
diff --git a/man/rmmod.8.scd b/man/rmmod.8.scd
index 72947a6..7813448 100644
--- a/man/rmmod.8.scd
+++ b/man/rmmod.8.scd
@@ -29,7 +29,7 @@ is provided) from the kernel. Most users will want to use *modprobe*(8) with the
*-s*, *--syslog*
Send errors to syslog instead of standard error.
-*-V --version*
+*-V*, *--version*
Show version of program and exit.
# COPYRIGHT
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 02/17] man: white space fixes
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 ` Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 03/17] man: misc punctuation fixes Emil Velikov via B4 Relay
` (15 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
These were present in the original xml files and I opted to keep them
separate fix to make the transition/comparison easier.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
v2: drop unrelated bold annotation - move to previous patch
---
man/depmod.8.scd | 2 +-
man/depmod.d.5.scd | 2 +-
man/modprobe.8.scd | 8 ++++----
man/modprobe.d.5.scd | 4 ++--
4 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/man/depmod.8.scd b/man/depmod.8.scd
index 34c1313..80cc48d 100644
--- a/man/depmod.8.scd
+++ b/man/depmod.8.scd
@@ -55,7 +55,7 @@ rather than the current kernel version (as returned by *uname -r*).
*-o* _outdir_, *--outdir* _outdir_
Set the output directory where *depmod* will store any generated file.
- _ outdir_ serves as a root to that location, similar to how _basedir_ is
+ _outdir_ serves as a root to that location, similar to how _basedir_ is
used. Also this setting takes precedence and if used together with
_basedir_ it will result in the input being that directory, but the output
being the one set by _outdir_.
diff --git a/man/depmod.d.5.scd b/man/depmod.d.5.scd
index 9c42478..4e05b93 100644
--- a/man/depmod.d.5.scd
+++ b/man/depmod.d.5.scd
@@ -50,7 +50,7 @@ override _modulename_ _kernelversion_ _modulesubdirectory_
This command allows you to override which version of a specific module
will be used when more than one module sharing the same name is
processed by the *depmod* command. It is possible to specify one kernel
- or all kernels using the \* wildcard. _ modulesubdirectory_ is the name
+ or all kernels using the \* wildcard. _modulesubdirectory_ is the name
of the subdirectory under @MODULE_DIRECTORY@ (or other module location)
where the target module is installed.
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index 653fbd9..aac3a74 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -6,7 +6,7 @@ modprobe - Add and remove modules from the Linux Kernel
# SYNOPSIS
-*modprobe* [*-v*] [*-V*] [*-C *_config-file_] [*-n*] [*-i*] [*-q*] [*-b*] [_modulename_]
+*modprobe* [*-v*] [*-V*] [*-C* _config-file_] [*-n*] [*-i*] [*-q*] [*-b*] [_modulename_]
\ \ \ \ \ \ \ \ \ \[_module parameters_...]
*modprobe* [*-r*] [*-v*] [*-n*] [*-i*] [_modulename_...]
@@ -19,10 +19,10 @@ modprobe - Add and remove modules from the Linux Kernel
*modprobe* intelligently adds or removes a module from the Linux kernel: note
that for convenience, there is no difference between \_ and - in module names
-(automatic underscore conversion is performed). * modprobe* looks in the module
+(automatic underscore conversion is performed). *modprobe* looks in the module
directory @DISTCONFDIR@/`uname -r` for all the modules and other files, except
for the optional configuration files in the /etc/modprobe.d directory (see
-*modprobe.d*(5)). * modprobe* will also use module options specified on the
+*modprobe.d*(5)). *modprobe* will also use module options specified on the
kernel command line in the form of <module>.<option> and blacklists in the form
of modprobe.blacklist=<module>.
@@ -167,7 +167,7 @@ database.
itself. This produces a (possibly empty) set of module filenames, one
per line, each starting with "insmod" and is typically used by
distributions to determine which modules to include when generating
- initrd/initramfs images. * Install* commands which apply are shown
+ initrd/initramfs images. *Install* commands which apply are shown
prefixed by "install". It does not run any of the install commands. Note
that *modinfo*(8) can be used to extract dependencies of a module from the
module itself, but knows nothing of aliases or install commands.
diff --git a/man/modprobe.d.5.scd b/man/modprobe.d.5.scd
index 93b9522..2907175 100644
--- a/man/modprobe.d.5.scd
+++ b/man/modprobe.d.5.scd
@@ -94,7 +94,7 @@ install _modulename_ _command..._
options _modulename_ _option..._
This command allows you to add options to the module _modulename_ (which
might be an alias) every time it is inserted into the kernel: whether
- directly (using *modprobe* _ modulename_) or because the module being
+ directly (using *modprobe* _modulename_) or because the module being
inserted depends on this module.
All options are added together: they can come from an *option* for the
@@ -106,7 +106,7 @@ remove _modulename_ _command..._
softdep _modulename_ pre: _modules..._ post: _modules..._
The *softdep* command allows you to specify soft, or optional, module
- dependencies. _ modulename_ can be used without these optional modules
+ dependencies. _modulename_ can be used without these optional modules
installed, but usually with some features missing. For example, a driver
for a storage HBA might require another module be loaded in order to use
management features.
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 03/17] man: misc punctuation fixes
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 ` Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 04/17] man: some options take an argument, mention that Emil Velikov via B4 Relay
` (14 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Some commas and a full stop was missing ;-)
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
man/depmod.d.5.scd | 2 +-
man/kmod.8.scd | 4 ++--
man/lsmod.8.scd | 2 +-
man/modprobe.8.scd | 2 +-
man/rmmod.8.scd | 2 +-
5 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/man/depmod.d.5.scd b/man/depmod.d.5.scd
index 4e05b93..9cf99d5 100644
--- a/man/depmod.d.5.scd
+++ b/man/depmod.d.5.scd
@@ -73,7 +73,7 @@ exclude _excludedir_
This specifies the trailing directories that will be excluded during the
search for kernel modules.
- The _excludedir_ is the trailing directory to exclude
+ The _excludedir_ is the trailing directory to exclude.
# COPYRIGHT
diff --git a/man/kmod.8.scd b/man/kmod.8.scd
index 7bef863..2007a2d 100644
--- a/man/kmod.8.scd
+++ b/man/kmod.8.scd
@@ -15,10 +15,10 @@ Linux Kernel modules. Most users will only run it using its other names.
# OPTIONS
-*-V --version*
+*-V*, *--version*
Show the program version and exit.
-*-h --help*
+*-h*, *--help*
Show the help message.
# COMMANDS
diff --git a/man/lsmod.8.scd b/man/lsmod.8.scd
index 7195cba..eb2f2e8 100644
--- a/man/lsmod.8.scd
+++ b/man/lsmod.8.scd
@@ -19,7 +19,7 @@ Maintained by Jon Masters and others.
# SEE ALSO
-*insmod*(8), *modprobe*(8), *modinfo*(8) *depmod*(8)
+*insmod*(8), *modprobe*(8), *modinfo*(8), *depmod*(8)
# AUTHORS
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index aac3a74..f4ce0be 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -202,7 +202,7 @@ Maintained by Jon Masters and others.
# SEE ALSO
-*modprobe.d*(5), *insmod*(8), *rmmod*(8), *lsmod*(8), *modinfo*(8) *depmod*(8)
+*modprobe.d*(5), *insmod*(8), *rmmod*(8), *lsmod*(8), *modinfo*(8), *depmod*(8)
# AUTHORS
diff --git a/man/rmmod.8.scd b/man/rmmod.8.scd
index 7813448..e1f656f 100644
--- a/man/rmmod.8.scd
+++ b/man/rmmod.8.scd
@@ -39,7 +39,7 @@ Maintained by Jon Masters and others.
# SEE ALSO
-*modprobe*(8), *insmod*(8), *lsmod*(8), *modinfo*(8) *depmod*(8)
+*modprobe*(8), *insmod*(8), *lsmod*(8), *modinfo*(8), *depmod*(8)
# AUTHORS
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 04/17] man: some options take an argument, mention that
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (2 preceding siblings ...)
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
2024-07-08 13:43 ` [PATCH kmod v2 05/17] man: couple of grammar/language fixes Emil Velikov via B4 Relay
` (13 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
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
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 05/17] man: couple of grammar/language fixes
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (3 preceding siblings ...)
2024-07-08 13:43 ` [PATCH kmod v2 04/17] man: some options take an argument, mention that Emil Velikov via B4 Relay
@ 2024-07-08 13:43 ` 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
` (12 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
man/modprobe.8.scd | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index 9594798..b47908b 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -101,7 +101,7 @@ database.
Naturally, this check is there for your protection, so using this option
is dangerous unless you know what you're doing.
- This applies any modules inserted: both the module (or alias) on the
+ This applies to any modules inserted: both the module (or alias) on the
command line and any modules on which it depends.
*-f*, *--force*
@@ -112,7 +112,7 @@ database.
know what you are doing.
This applies to any modules inserted: both the module (or alias) on the
- command line and any modules it on which it depends.
+ command line and any modules on which it depends.
*-i*, *--ignore-install*, *--ignore-remove*
This option causes *modprobe* to ignore *install* and *remove* commands
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 06/17] man: stop removing DISTCONFDIR lines
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (4 preceding siblings ...)
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 ` 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
` (11 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Presently when DISTCONFDIR is identical to /lib we remove the whole
line, since the man pages already have an /lib instance.
At the same time, there are in-text DISTCONFDIR entries, and removing
the whole line outright breaks the documentation.
Drop the removal line - worst case scenario we get a duplicate entry in
the synopsis.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
man/Makefile.am | 7 ++-----
1 file changed, 2 insertions(+), 5 deletions(-)
diff --git a/man/Makefile.am b/man/Makefile.am
index 77a0035..39a0015 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -14,11 +14,8 @@ EXTRA_DIST = $(MAN5:%.5=%.5.scd) $(MAN8:%.8=%.8.scd)
CLEANFILES = $(filter-out $(MAN_STUB), $(dist_man_MANS))
define generate_manpage
- $(AM_V_SCDOC)if [ '$(distconfdir)' != '/lib' ] ; then \
- sed -e 's|@DISTCONFDIR@|$(distconfdir)|g' $< ; \
- else \
- sed -e '/@DISTCONFDIR@/d' $< ; \
- fi | \
+ $(AM_V_SCDOC)cat $< | \
+ sed -e 's|@DISTCONFDIR@|$(distconfdir)|g' | \
sed -e 's|@MODULE_DIRECTORY@|$(module_directory)|g' | \
$(SCDOC) > $@
endef
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 07/17] man: depmod.d: document the config file order handling
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (5 preceding siblings ...)
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 ` 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
` (10 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
The depmod.d configuration order/handling aligns with existing tools
such as sysctl.d, even though there is no mention in the manual.
Reorder the list in SYNOPSIS and add a bit of verbiage describing things.
Section is inspired by sysctl.d(5) and sysctl(8).
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
v2: Reword as per Lucas' suggestion.
---
man/Makefile.am | 1 +
man/depmod.d.5.scd | 20 ++++++++++++++++----
2 files changed, 17 insertions(+), 4 deletions(-)
diff --git a/man/Makefile.am b/man/Makefile.am
index 39a0015..6356d87 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -15,6 +15,7 @@ CLEANFILES = $(filter-out $(MAN_STUB), $(dist_man_MANS))
define generate_manpage
$(AM_V_SCDOC)cat $< | \
+ sed -e 's|@SYSCONFDIR@|$(sysconfdir)|g' | \
sed -e 's|@DISTCONFDIR@|$(distconfdir)|g' | \
sed -e 's|@MODULE_DIRECTORY@|$(module_directory)|g' | \
$(SCDOC) > $@
diff --git a/man/depmod.d.5.scd b/man/depmod.d.5.scd
index 9cf99d5..bd1291b 100644
--- a/man/depmod.d.5.scd
+++ b/man/depmod.d.5.scd
@@ -6,15 +6,15 @@ depmod.d - Configuration directory for depmod
# SYNOPSIS
-/lib/depmod.d/\*.conf
+@SYSCONFDIR@/depmod.d/\*.conf
-@DISTCONFDIR@/depmod.d/\*.conf
+/run/depmod.d/\*.conf
/usr/local/lib/depmod.d/\*.conf
-/run/depmod.d/\*.conf
+@DISTCONFDIR@/depmod.d/\*.conf
-/etc/depmod.d/\*.conf
+/lib/depmod.d/\*.conf
# DESCRIPTION
@@ -29,6 +29,18 @@ lines and lines starting with '#' ignored (useful for adding comments). A '\\'
at the end of a line causes it to continue on the next line, which makes the
files a bit neater.
+# CONFIGURATION DIRECTORIES AND PRECEDENCE
+
+Configuration files are read from directories in listed in SYNOPSYS in that
+order of precedence. Once a file of a given filename is loaded, any file of the
+same name in subsequent directories is ignored.
+
+All configuration files are sorted in lexicographic order, regardless of the
+directory they reside in. Configuration files can either be completely replaced
+(by having a new configuration file with the same name in a directory of higher
+priority) or partially replaced (by having a configuration file that is ordered
+later).
+
# COMMANDS
search _subdirectory..._
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 08/17] man: depmod.d: factor out a CONFIGURATION FORMAT section
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (6 preceding siblings ...)
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 ` 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
` (9 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Keep the description neat and tidy.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
man/depmod.d.5.scd | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/man/depmod.d.5.scd b/man/depmod.d.5.scd
index bd1291b..ddb1340 100644
--- a/man/depmod.d.5.scd
+++ b/man/depmod.d.5.scd
@@ -24,10 +24,13 @@ built-in kernel modules are complemented by custom built versions of the same
and the user wishes to affect the priority of processing in order to override
the module version supplied by the kernel.
-The format of files under depmod.d is simple: one command per line, with blank
-lines and lines starting with '#' ignored (useful for adding comments). A '\\'
-at the end of a line causes it to continue on the next line, which makes the
-files a bit neater.
+# CONFIGURATION FORMAT
+
+The configuration files contain one command per line, with blank lines and lines
+starting with '#' ignored (useful for adding comments). A '\\' at the end of a
+line causes it to continue on the next line, which makes the files a bit neater.
+
+See the COMMANDS section below for more.
# CONFIGURATION DIRECTORIES AND PRECEDENCE
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 09/17] man: depmod.d: rework the opening description sentence
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (7 preceding siblings ...)
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 ` 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
` (8 subsequent siblings)
17 siblings, 1 reply; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Use a slightly longer, more gradual introduction.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
Lucas, I'm reading the first sentence and struggling a bit. What does
the "global or per-module" refer to?
Thanks in advance o/
---
man/depmod.d.5.scd | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/man/depmod.d.5.scd b/man/depmod.d.5.scd
index ddb1340..dc13ec7 100644
--- a/man/depmod.d.5.scd
+++ b/man/depmod.d.5.scd
@@ -18,11 +18,14 @@ depmod.d - Configuration directory for depmod
# DESCRIPTION
-The order in which modules are processed by the *depmod* command can be altered
-on a global or per-module basis. This is typically useful in cases where
-built-in kernel modules are complemented by custom built versions of the same
-and the user wishes to affect the priority of processing in order to override
-the module version supplied by the kernel.
+On execution *depmod* reads the configuration files from the above location and
+based on that it processes the available modules and their dependencies. For
+example: one can change the search order, exclude folders, override specific
+module's location and more.
+
+This is typically useful in cases where built-in kernel modules are complemented
+by custom built versions of the same and the user wishes to affect the priority
+of processing in order to override the module version supplied by the kernel.
# CONFIGURATION FORMAT
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 10/17] man: depmod: remove hard-coded /etc/depmod.d references
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (8 preceding siblings ...)
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-08 13:43 ` 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
` (7 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Point the users to depmod.d(5) instead.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
man/depmod.8.scd | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man/depmod.8.scd b/man/depmod.8.scd
index 7a2e84b..0252a72 100644
--- a/man/depmod.8.scd
+++ b/man/depmod.8.scd
@@ -61,8 +61,8 @@ rather than the current kernel version (as returned by *uname -r*).
being the one set by _outdir_.
*-C*, *--config* _file_ _or_ _directory_
- This option overrides the default configuration directory at
- /etc/depmod.d/.
+ This option overrides the default configuration files. See
+ *depmod.d*(5).
*-e*, *--errsyms*
When combined with the *-F* option, this reports any symbols which a
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 11/17] man: modprobe.d: document the config file order handling
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (9 preceding siblings ...)
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 ` 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
` (6 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
The modprobe.d configuration order/handling aligns with existing tools
such as sysctl.d, even though there is no mention in the manual.
Reorder the list in SYNOPSIS and add a bit of verbiage describing things.
Section is inspired by sysctl.d(5) and sysctl(8).
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
v2: Reword as per Lucas' suggestion.
---
man/modprobe.d.5.scd | 29 ++++++++++++++++++++---------
1 file changed, 20 insertions(+), 9 deletions(-)
diff --git a/man/modprobe.d.5.scd b/man/modprobe.d.5.scd
index 2907175..2a6a789 100644
--- a/man/modprobe.d.5.scd
+++ b/man/modprobe.d.5.scd
@@ -6,25 +6,24 @@ modprobe.d - Configuration directory for modprobe
# SYNOPSIS
-/lib/modprobe.d/\*.conf
+@SYSCONFDIR@/modprobe.d/\*.conf
-@DISTCONFDIR@/modprobe.d/\*.conf
+/run/modprobe.d/\*.conf
/usr/local/lib/modprobe.d/\*.conf
-/run/modprobe.d/\*.conf
+@DISTCONFDIR@/modprobe.d/\*.conf
-/etc/modprobe.d/\*.conf
+/lib/modprobe.d/\*.conf
# DESCRIPTION
Because the *modprobe* command can add or remove more than one module, due to
modules having dependencies, we need a method of specifying what options are to
-be used with those modules. All files underneath the /etc/modprobe.d directory
-which end with the .conf extension specify those options as required. They can
-also be used to create convenient aliases: alternate names for a module, or they
-can override the normal *modprobe* behavior altogether for those with special
-requirements (such as inserting more than one module).
+be used with those modules. One can also use them to create convenient aliases:
+alternate names for a module, or they can override the normal *modprobe*
+behavior altogether for those with special requirements (such as inserting more
+than one module).
Note that module and alias names (like other module names) can have - or \_ in
them: both are interchangeable throughout all the module commands as underscore
@@ -35,6 +34,18 @@ lines and lines starting with '#' ignored (useful for adding comments). A '\\'
at the end of a line causes it to continue on the next line, which makes the
file a bit neater.
+# CONFIGURATION DIRECTORIES AND PRECEDENCE
+
+Configuration files are read from directories in listed in SYNOPSYS in that
+order of precedence. Once a file of a given filename is loaded, any file of the
+same name in subsequent directories is ignored.
+
+All configuration files are sorted in lexicographic order, regardless of the
+directory they reside in. Configuration files can either be completely replaced
+(by having a new configuration file with the same name in a directory of higher
+priority) or partially replaced (by having a configuration file that is ordered
+later).
+
# COMMANDS
alias _wildcard_ _modulename_
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 12/17] man: modprobe.d: factor out a CONFIGURATION FORMAT section
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (10 preceding siblings ...)
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 ` 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
` (5 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Keep the description neat and tidy.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
man/modprobe.d.5.scd | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/man/modprobe.d.5.scd b/man/modprobe.d.5.scd
index 2a6a789..823ba62 100644
--- a/man/modprobe.d.5.scd
+++ b/man/modprobe.d.5.scd
@@ -29,10 +29,13 @@ Note that module and alias names (like other module names) can have - or \_ in
them: both are interchangeable throughout all the module commands as underscore
conversion happens automatically.
-The format of files under modprobe.d is simple: one command per line, with blank
-lines and lines starting with '#' ignored (useful for adding comments). A '\\'
-at the end of a line causes it to continue on the next line, which makes the
-file a bit neater.
+# CONFIGURATION FORMAT
+
+The configuration files contain one command per line, with blank lines and lines
+starting with '#' ignored (useful for adding comments). A '\\' at the end of a
+line causes it to continue on the next line, which makes the files a bit neater.
+
+See the COMMANDS section below for more.
# CONFIGURATION DIRECTORIES AND PRECEDENCE
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 13/17] man: add few mentions about MODPROBE_OPTIONS
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (11 preceding siblings ...)
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 ` 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
` (4 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
The environment variable may alter config file ordering, so mention it
in the man page.
In addition, highlight that the format is intentionally undocumented
since the use by third parties is discouraged.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
v2: tweak (5) wording, add details to (8)
---
man/modprobe.8.scd | 8 ++++++--
man/modprobe.d.5.scd | 3 +++
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index b47908b..321fa59 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -192,8 +192,12 @@ database.
# ENVIRONMENT
-The MODPROBE_OPTIONS environment variable can also be used to pass arguments to
-*modprobe*.
+The MODPROBE_OPTIONS environment variable can also be used to pass command line
+arguments to *modprobe*. The format is intentionally left undocumented, since
+the use by third-party tools and scripts is discouraged.
+
+The environment variable originates with the implementation of the install
+rules.
# COPYRIGHT
diff --git a/man/modprobe.d.5.scd b/man/modprobe.d.5.scd
index 823ba62..b7b1942 100644
--- a/man/modprobe.d.5.scd
+++ b/man/modprobe.d.5.scd
@@ -49,6 +49,9 @@ directory they reside in. Configuration files can either be completely replaced
priority) or partially replaced (by having a configuration file that is ordered
later).
+NOTE: The configuration directories may be altered via the MODPROBE_OPTIONS
+environment variable. See the ENVIRONMENT section in *modprobe*(8).
+
# COMMANDS
alias _wildcard_ _modulename_
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 14/17] man: modprobe: remove hard-coded /etc/modprobe.d references
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (12 preceding siblings ...)
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 ` 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
` (3 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Point the users to modprobe.d(5) instead.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
man/modprobe.8.scd | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index 321fa59..30ccc21 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -21,10 +21,9 @@ modprobe - Add and remove modules from the Linux Kernel
that for convenience, there is no difference between \_ and - in module names
(automatic underscore conversion is performed). *modprobe* looks in the module
directory @DISTCONFDIR@/`uname -r` for all the modules and other files, except
-for the optional configuration files in the /etc/modprobe.d directory (see
-*modprobe.d*(5)). *modprobe* will also use module options specified on the
-kernel command line in the form of <module>.<option> and blacklists in the form
-of modprobe.blacklist=<module>.
+for the optional configuration files (see *modprobe.d*(5)). *modprobe* will also
+use module options specified on the kernel command line in the form of
+<module>.<option> and blacklists in the form of modprobe.blacklist=<module>.
Note that unlike in 2.4 series Linux kernels (which are not supported by this
tool) this version of *modprobe* does not do anything to the module itself: the
@@ -56,8 +55,8 @@ database.
by *udev*(7).
*-C* _directory_, *--config* _directory_
- This option overrides the default configuration directory
- (/etc/modprobe.d).
+ This option overrides the default configuration directory. See
+ *modprobe.d*(5).
This option is passed through *install* or *remove* commands to other
*modprobe* commands in the MODPROBE_OPTIONS environment variable.
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 15/17] man: remove the "Maintained by" references
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (13 preceding siblings ...)
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 ` Emil Velikov via B4 Relay
2024-07-08 13:43 ` [PATCH kmod v2 16/17] man: rework AUTHORS section Emil Velikov via B4 Relay
` (2 subsequent siblings)
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
At a glance through my system, around 2% of the man pages include such
statement.
Looking through git log, Jon has been active in a while and presumably
have moved on.
Most importantly the Copyright section isn't the best place to reference
the maintainer/contact person.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
Instead we can add a note in the authors section, pointing people to the
ML/kernel.org/Github repo for when seeking contact.
Also should probably s/Developer/Maintainer/ for Lucas, who's been
keeping the project afloat the last few decades ;-)
Lucas, what do you think?
---
man/insmod.8.scd | 1 -
man/kmod.8.scd | 3 +--
man/lsmod.8.scd | 1 -
man/modinfo.8.scd | 1 -
man/modprobe.8.scd | 1 -
man/modprobe.d.5.scd | 1 -
man/modules.dep.5.scd | 1 -
man/rmmod.8.scd | 1 -
8 files changed, 1 insertion(+), 9 deletions(-)
diff --git a/man/insmod.8.scd b/man/insmod.8.scd
index b6f8654..27d4409 100644
--- a/man/insmod.8.scd
+++ b/man/insmod.8.scd
@@ -21,7 +21,6 @@ information about errors.
# COPYRIGHT
This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
-Maintained by Jon Masters and others.
# SEE ALSO
diff --git a/man/kmod.8.scd b/man/kmod.8.scd
index 2007a2d..6bd9432 100644
--- a/man/kmod.8.scd
+++ b/man/kmod.8.scd
@@ -35,8 +35,7 @@ Linux Kernel modules. Most users will only run it using its other names.
# COPYRIGHT
-This manual page originally Copyright 2014, Marco d'Itri. Maintained by Lucas De
-Marchi and others.
+This manual page originally Copyright 2014, Marco d'Itri.
# SEE ALSO
diff --git a/man/lsmod.8.scd b/man/lsmod.8.scd
index eb2f2e8..ded619e 100644
--- a/man/lsmod.8.scd
+++ b/man/lsmod.8.scd
@@ -15,7 +15,6 @@ lsmod - Show the status of modules in the Linux Kernel
# COPYRIGHT
This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
-Maintained by Jon Masters and others.
# SEE ALSO
diff --git a/man/modinfo.8.scd b/man/modinfo.8.scd
index 9545257..d088c7e 100644
--- a/man/modinfo.8.scd
+++ b/man/modinfo.8.scd
@@ -63,7 +63,6 @@ architecture.
# COPYRIGHT
This manual page originally Copyright 2003, Rusty Russell, IBM Corporation.
-Maintained by Jon Masters and others.
# SEE ALSO
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index 30ccc21..67cbb1a 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -201,7 +201,6 @@ rules.
# COPYRIGHT
This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
-Maintained by Jon Masters and others.
# SEE ALSO
diff --git a/man/modprobe.d.5.scd b/man/modprobe.d.5.scd
index b7b1942..246457b 100644
--- a/man/modprobe.d.5.scd
+++ b/man/modprobe.d.5.scd
@@ -167,7 +167,6 @@ directly within the modules.
# COPYRIGHT
This manual page originally Copyright 2004, Rusty Russell, IBM Corporation.
-Maintained by Jon Masters and others.
# SEE ALSO
diff --git a/man/modules.dep.5.scd b/man/modules.dep.5.scd
index c4e7653..7723a16 100644
--- a/man/modules.dep.5.scd
+++ b/man/modules.dep.5.scd
@@ -29,7 +29,6 @@ fashion rather than touching these files.
# COPYRIGHT
This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
-Maintained by Jon Masters and others.
# SEE ALSO
diff --git a/man/rmmod.8.scd b/man/rmmod.8.scd
index e1f656f..c4dcc3e 100644
--- a/man/rmmod.8.scd
+++ b/man/rmmod.8.scd
@@ -35,7 +35,6 @@ is provided) from the kernel. Most users will want to use *modprobe*(8) with the
# COPYRIGHT
This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
-Maintained by Jon Masters and others.
# SEE ALSO
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 16/17] man: rework AUTHORS section
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (14 preceding siblings ...)
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 ` 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
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Replace the partial listing with suggestion to check through git
shortlog and git blame.
Explicitly spell out the current maintainer, alongside giving Jon
attribution for the original project.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
man/depmod.8.scd | 13 ++++++-------
man/depmod.d.5.scd | 13 ++++++-------
man/insmod.8.scd | 10 ++++++----
man/kmod.8.scd | 13 +++++++++++--
man/lsmod.8.scd | 10 ++++++----
man/modinfo.8.scd | 10 ++++++----
man/modprobe.8.scd | 13 ++++++-------
man/modprobe.d.5.scd | 13 ++++++-------
man/modules.dep.5.scd | 10 ++++++----
man/rmmod.8.scd | 10 ++++++----
10 files changed, 65 insertions(+), 50 deletions(-)
diff --git a/man/depmod.8.scd b/man/depmod.8.scd
index 0252a72..76d4fa8 100644
--- a/man/depmod.8.scd
+++ b/man/depmod.8.scd
@@ -116,11 +116,10 @@ Portions Copyright Jon Masters, and others.
# AUTHORS
-*Jon Masters* <jcm@jonmasters.org>
- Developer
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
-*Robby Workman* <rworkman@slackware.com>
- Developer
-
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
diff --git a/man/depmod.d.5.scd b/man/depmod.d.5.scd
index dc13ec7..ec1b032 100644
--- a/man/depmod.d.5.scd
+++ b/man/depmod.d.5.scd
@@ -103,11 +103,10 @@ This manual page Copyright 2006-2010, Jon Masters, Red Hat, Inc.
# AUTHORS
-*Jon Masters* <jcm@jonmasters.org>
- Developer
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
-*Robby Workman* <rworkman@slackware.com>
- Developer
-
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
diff --git a/man/insmod.8.scd b/man/insmod.8.scd
index 27d4409..137830f 100644
--- a/man/insmod.8.scd
+++ b/man/insmod.8.scd
@@ -28,8 +28,10 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
# AUTHORS
-*Jon Masters* <jcm@jonmasters.org>
- Developer
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
diff --git a/man/kmod.8.scd b/man/kmod.8.scd
index 6bd9432..2294591 100644
--- a/man/kmod.8.scd
+++ b/man/kmod.8.scd
@@ -43,5 +43,14 @@ This manual page originally Copyright 2014, Marco d'Itri.
# AUTHOR
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*kmod* project was started by Lucas De Marchi as a drop-in replacement to
+module-init-tools that was maintained by Jon Masters, adding a library (libkmod)
+and additional features.
+
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
+
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
diff --git a/man/lsmod.8.scd b/man/lsmod.8.scd
index ded619e..d81cce2 100644
--- a/man/lsmod.8.scd
+++ b/man/lsmod.8.scd
@@ -22,8 +22,10 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
# AUTHORS
-*Jon Masters* <jcm@jonmasters.org>
- Developer
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
diff --git a/man/modinfo.8.scd b/man/modinfo.8.scd
index d088c7e..7511798 100644
--- a/man/modinfo.8.scd
+++ b/man/modinfo.8.scd
@@ -70,8 +70,10 @@ This manual page originally Copyright 2003, Rusty Russell, IBM Corporation.
# AUTHORS
-*Jon Masters* <jcm@jonmasters.org>
- Developer
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index 67cbb1a..85d47fa 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -208,11 +208,10 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
# AUTHORS
-*Jon Masters* <jcm@jonmasters.org>
- Developer
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
-*Robby Workman* <rworkman@slackware.com>
- Developer
-
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
diff --git a/man/modprobe.d.5.scd b/man/modprobe.d.5.scd
index 246457b..e6e9c51 100644
--- a/man/modprobe.d.5.scd
+++ b/man/modprobe.d.5.scd
@@ -174,11 +174,10 @@ This manual page originally Copyright 2004, Rusty Russell, IBM Corporation.
# AUTHORS
-*Jon Masters* <jcm@jonmasters.org>
- Developer
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
-*Robby Workman* <rworkman@slackware.com>
- Developer
-
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
diff --git a/man/modules.dep.5.scd b/man/modules.dep.5.scd
index 7723a16..7c68ab9 100644
--- a/man/modules.dep.5.scd
+++ b/man/modules.dep.5.scd
@@ -36,8 +36,10 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
# AUTHORS
-*Jon Masters* <jcm@jonmasters.org>
- Developer
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
diff --git a/man/rmmod.8.scd b/man/rmmod.8.scd
index c4dcc3e..cf55478 100644
--- a/man/rmmod.8.scd
+++ b/man/rmmod.8.scd
@@ -42,8 +42,10 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation.
# AUTHORS
-*Jon Masters* <jcm@jonmasters.org>
- Developer
+Numerous contributions have come from the linux-modules mailing list
+<linux-modules@vger.kernel.org> and Github. If you have a clone of kmod.git
+itself, the output of *git-shortlog*(1) and *git-blame*(1) can show you the
+authors for specific parts of the project.
-*Lucas De Marchi* <lucas.de.marchi@gmail.com>
- Developer
+*Lucas De Marchi* <lucas.de.marchi@gmail.com> is the current maintainer of the
+project.
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH kmod v2 17/17] man: list options one per line
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (15 preceding siblings ...)
2024-07-08 13:43 ` [PATCH kmod v2 16/17] man: rework AUTHORS section Emil Velikov via B4 Relay
@ 2024-07-08 13:43 ` 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
17 siblings, 0 replies; 20+ messages in thread
From: Emil Velikov via B4 Relay @ 2024-07-08 13:43 UTC (permalink / raw)
To: linux-modules; +Cc: Emil Velikov
From: Emil Velikov <emil.l.velikov@gmail.com>
Somewhat inspired by my selfish use of VIM as man pager. Namely, when
there are multiple options on the same line, only the first one gets
properly rendered.
A good bonus point is that very long instances, like modinfo's legacy
"--author, --description ..." look a bit neater now.
With this is also more consistently handle short/long options which take
an argument.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
---
man/depmod.8.scd | 37 +++++++++++++++++++++++++------------
man/kmod.8.scd | 6 ++++--
man/modinfo.8.scd | 17 ++++++++++++-----
man/modprobe.8.scd | 50 ++++++++++++++++++++++++++++++++++----------------
man/rmmod.8.scd | 12 ++++++++----
5 files changed, 83 insertions(+), 39 deletions(-)
diff --git a/man/depmod.8.scd b/man/depmod.8.scd
index 76d4fa8..c061085 100644
--- a/man/depmod.8.scd
+++ b/man/depmod.8.scd
@@ -35,16 +35,19 @@ rather than the current kernel version (as returned by *uname -r*).
# OPTIONS
-*-a*, *--all*
+*-a*
+*--all*
Probe all modules. This option is enabled by default if no file names
are given in the command-line.
-*-A*, *--quick*
+*-A*
+*--quick*
This option scans to see if any modules are newer than the
*modules.dep* file before any work is done: if not, it silently exits
rather than regenerating the files.
-*-b* _basedir_, *--basedir* _basedir_
+*-b* _basedir_
+*--basedir* _basedir_
If your modules are not currently in the (normal) directory
@MODULE_DIRECTORY@/_version_, but in a staging area, you can specify a
_basedir_ which is prepended to the directory name. This _basedir_ is
@@ -53,18 +56,21 @@ rather than the current kernel version (as returned by *uname -r*).
distribution vendor who needs to pre-generate the meta-data files rather
than running *depmod* again later.
-*-o* _outdir_, *--outdir* _outdir_
+*-o* _outdir_
+*--outdir* _outdir_
Set the output directory where *depmod* will store any generated file.
_outdir_ serves as a root to that location, similar to how _basedir_ is
used. Also this setting takes precedence and if used together with
_basedir_ it will result in the input being that directory, but the output
being the one set by _outdir_.
-*-C*, *--config* _file_ _or_ _directory_
+*-C* _file_ _or_ _directory_
+*--config* _file_ _or_ _directory_
This option overrides the default configuration files. See
*depmod.d*(5).
-*-e*, *--errsyms*
+*-e*
+*--errsyms*
When combined with the *-F* option, this reports any symbols which a
module needs which are not supplied by other modules or the kernel.
Normally, any symbols not provided by modules are assumed to be provided
@@ -72,21 +78,26 @@ 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* _Module.symvers_
+*-E* _Module.symvers_
+*--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
incompatible with *-F*.
-*-F*, *--filesyms* _System.map_
+*-F* _System.map_
+*--filesyms* _System.map_
Supplied with the _System.map_ produced when the kernel was built, this
allows the *-e* option to report unresolved symbols. This option is
mutually incompatible with *-E*.
-*-h*, *--help*
+*-h*
+*--help*
Print the help message and exit.
-*-n*, *--show*, *--dry-run*
+*-n*
+*--show*
+*--dry-run*
This sends the resulting *modules.dep* and the various map files to
standard output rather than writing them into the module directory.
@@ -94,11 +105,13 @@ rather than the current kernel version (as returned by *uname -r*).
Some architectures prefix symbols with an extraneous character. This
specifies a prefix character (for example '\_') to ignore.
-*-v*, *--verbose*
+*-v*
+*--verbose*
In verbose mode, *depmod* will print (to stdout) all the symbols each
module depends on and the module's file name which provides that symbol.
-*-V*, *--version*
+*-V*
+*--version*
Show version of program and exit. See below for caveats when run on
older kernels.
diff --git a/man/kmod.8.scd b/man/kmod.8.scd
index 2294591..d2039c6 100644
--- a/man/kmod.8.scd
+++ b/man/kmod.8.scd
@@ -15,10 +15,12 @@ Linux Kernel modules. Most users will only run it using its other names.
# OPTIONS
-*-V*, *--version*
+*-V*
+*--version*
Show the program version and exit.
-*-h*, *--help*
+*-h*
+*--help*
Show the help message.
# COMMANDS
diff --git a/man/modinfo.8.scd b/man/modinfo.8.scd
index 7511798..dace58f 100644
--- a/man/modinfo.8.scd
+++ b/man/modinfo.8.scd
@@ -28,17 +28,20 @@ architecture.
# OPTIONS
-*-V*, *--version*
+*-V*
+*--version*
Print the *modinfo* version.
-*-F* _field_, *--field* _field_
+*-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
special _field_ filename lists the filename of the module.
-*-b* _basedir_, *--basedir* _basedir_
+*-b* _basedir_
+*--basedir* _basedir_
Root directory for modules, / by default.
*-k* _kernel_
@@ -49,12 +52,16 @@ architecture.
modules in a new kernel for which you must make an initrd/initramfs
image prior to booting.
-*-0*, *--null*
+*-0*
+*--null*
Use the ASCII zero character to separate _field_ values, instead of a new
line. This is useful for scripts, since a new line can theoretically
appear inside a _field_.
-*-a* *--author*, *-d* *--description*, *-l* *--license*, *-p* *--parameters*,
+*-a* *--author*
+*-d* *--description*
+*-l* *--license*
+*-p* *--parameters*
*-n* *--filename*
These are shortcuts for the *--field* flag's author, description,
license, parm and filename arguments, to ease the transition from the
diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd
index 85d47fa..a6b57dc 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -46,22 +46,26 @@ database.
# OPTIONS
-*-a*, *--all*
+*-a*
+*--all*
Insert all module names on the command line.
-*-b*, *--use-blacklist*
+*-b*
+*--use-blacklist*
This option causes *modprobe* to apply the *blacklist* commands in the
configuration files (if any) to module names as well. It is usually used
by *udev*(7).
-*-C* _directory_, *--config* _directory_
+*-C* _directory_
+*--config* _directory_
This option overrides the default configuration directory. See
*modprobe.d*(5).
This option is passed through *install* or *remove* commands to other
*modprobe* commands in the MODPROBE_OPTIONS environment variable.
-*-c*, *--showconfig*
+*-c*
+*--showconfig*
Dump out the effective configuration from the config directory and exit.
*--dump-modversions*
@@ -69,7 +73,8 @@ database.
This option is commonly used by distributions in order to package up a
Linux kernel module using module versioning deps.
-*-d*, *--dirname*
+*-d*
+*--dirname*
Root directory for modules, / by default.
*--first-time*
@@ -103,7 +108,8 @@ database.
This applies to any modules inserted: both the module (or alias) on the
command line and any modules on which it depends.
-*-f*, *--force*
+*-f*
+*--force*
Try to strip any versioning information from the module which might
otherwise stop it from loading: this is the same as using both
*--force-vermagic* and *--force-modversion*. Naturally, these checks are
@@ -113,7 +119,9 @@ database.
This applies to any modules inserted: both the module (or alias) on the
command line and any modules on which it depends.
-*-i*, *--ignore-install*, *--ignore-remove*
+*-i*
+*--ignore-install*
+*--ignore-remove*
This option causes *modprobe* to ignore *install* and *remove* commands
in the configuration file (if any) for the module specified on the
command line (any dependent modules are still subject to commands set
@@ -122,24 +130,29 @@ database.
the request was more specifically made with only one or other (and not
both) of *--ignore-install* or *--ignore-remove*. See *modprobe.d*(5).
-*-n*, *--dry-run*, *--show*
+*-n*
+*--dry-run*
+*--show*
This option does everything but actually insert or delete the modules
(or run the install or remove commands). Combined with *-v*, it is
useful for debugging problems. For historical reasons both *--dry-run*
and *--show* actually mean the same thing and are interchangeable.
-*-q*, *--quiet*
+*-q*
+*--quiet*
With this flag, *modprobe* won't print an error message if you try to
remove or insert a module it can't find (and isn't an alias or
*install*/*remove* command). However, it will still return with a non-zero
exit status. The kernel uses this to opportunistically probe for modules
which might exist using request_module.
-*-R*, *--resolve-alias*
+*-R*
+*--resolve-alias*
Print all module names matching an alias. This can be useful for
debugging module alias problems.
-*-r*, *--remove*
+***-r*
+*--remove*
This option causes *modprobe* to remove rather than insert a module. If
the modules it depends on are also unused, *modprobe* will try to remove
them too. Unlike insertion, more than one module can be specified on the
@@ -150,14 +163,16 @@ database.
require it. Your distribution kernel may not have been built to support
removal of modules at all.
-*-w* _TIMEOUT_MSEC_, *--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* _version_, *--set-version* _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).
@@ -171,7 +186,8 @@ database.
that *modinfo*(8) can be used to extract dependencies of a module from the
module itself, but knows nothing of aliases or install commands.
-*-s*, *--syslog*
+*-s*
+*--syslog*
This option causes any error messages to go through the syslog mechanism
(as LOG_DAEMON with level LOG_NOTICE) rather than to standard error.
This is also automatically enabled when stderr is unavailable.
@@ -179,10 +195,12 @@ database.
This option is passed through *install* or *remove* commands to other
*modprobe* commands in the MODPROBE_OPTIONS environment variable.
-*-V*, *--version*
+*-V*
+*--version*
Show version of program and exit.
-*-v*, *--verbose*
+*-v*
+*--verbose*
Print messages about what the program is doing. Usually *modprobe* only
prints messages if something goes wrong.
diff --git a/man/rmmod.8.scd b/man/rmmod.8.scd
index cf55478..c53fe3d 100644
--- a/man/rmmod.8.scd
+++ b/man/rmmod.8.scd
@@ -16,20 +16,24 @@ is provided) from the kernel. Most users will want to use *modprobe*(8) with the
# OPTIONS
-*-v*, *--verbose*
+*-v*
+*--verbose*
Print messages about what the program is doing. Usually *rmmod* prints
messages only if something goes wrong.
-*-f*, *--force*
+*-f*
+*--force*
This option can be extremely dangerous: it has no effect unless
CONFIG_MODULE_FORCE_UNLOAD was set when the kernel was compiled. With
this option, you can remove modules which are being used, or which are
not designed to be removed, or have been marked as unsafe (see *lsmod*(8)).
-*-s*, *--syslog*
+*-s*
+*--syslog*
Send errors to syslog instead of standard error.
-*-V*, *--version*
+*-V*
+*--version*
Show version of program and exit.
# COPYRIGHT
--
2.45.2
^ permalink raw reply related [flat|nested] 20+ messages in thread
* Re: [PATCH kmod v2 09/17] man: depmod.d: rework the opening description sentence
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
0 siblings, 0 replies; 20+ messages in thread
From: Lucas De Marchi @ 2024-07-09 5:01 UTC (permalink / raw)
To: emil.l.velikov; +Cc: linux-modules
On Mon, Jul 08, 2024 at 02:43:17PM GMT, Emil Velikov via B4 Relay wrote:
>From: Emil Velikov <emil.l.velikov@gmail.com>
>
>Use a slightly longer, more gradual introduction.
>
>Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
>---
>Lucas, I'm reading the first sentence and struggling a bit. What does
>the "global or per-module" refer to?
I have no idea :). Digging the history, this comes from
module-init-tools and it was already there in its first ever commit:
commit 9ba2d09c2261c04fa72dcf614497b9f622fada6c
Author: Jonathan Masters <jcm@jcm.boston.redhat.com>
Date: Fri Dec 8 05:01:05 2006 -0500
Begin tracking post-3.3-pre3 development with git.
Thanks to Luiz Fernando N. Capitulino for his mail, suggesting that it might be
really good to begin tracking development with a proper SCM. This is especially
important now that we're trying to actively encourage greater involvement in
development once more. I'm looking for more patches and git trees to merge!
...
doc/depmod.conf.sgml:
...
<para>The order in which modules are processed by the
<command>depmod</command> command can be altered on a global or
per-module basis. This is typically useful in cases where built-in
kernel modules are complemented by custom built versions of the
same and the user wishes to affect the priority of processing in
order to override the module version supplied by the kernel.
>
>Thanks in advance o/
>---
> man/depmod.d.5.scd | 13 ++++++++-----
> 1 file changed, 8 insertions(+), 5 deletions(-)
>
>diff --git a/man/depmod.d.5.scd b/man/depmod.d.5.scd
>index ddb1340..dc13ec7 100644
>--- a/man/depmod.d.5.scd
>+++ b/man/depmod.d.5.scd
>@@ -18,11 +18,14 @@ depmod.d - Configuration directory for depmod
>
> # DESCRIPTION
>
>-The order in which modules are processed by the *depmod* command can be altered
>-on a global or per-module basis. This is typically useful in cases where
>-built-in kernel modules are complemented by custom built versions of the same
>-and the user wishes to affect the priority of processing in order to override
>-the module version supplied by the kernel.
>+On execution *depmod* reads the configuration files from the above location and
>+based on that it processes the available modules and their dependencies. For
>+example: one can change the search order, exclude folders, override specific
>+module's location and more.
>+
>+This is typically useful in cases where built-in kernel modules are complemented
>+by custom built versions of the same and the user wishes to affect the priority
>+of processing in order to override the module version supplied by the kernel.
LGTM, thanks.
Lucas De Marchi
>
> # CONFIGURATION FORMAT
>
>
>--
>2.45.2
>
>
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion
2024-07-08 13:43 [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion Emil Velikov via B4 Relay
` (16 preceding siblings ...)
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 ` Lucas De Marchi
17 siblings, 0 replies; 20+ messages in thread
From: Lucas De Marchi @ 2024-07-09 5:20 UTC (permalink / raw)
To: linux-modules, Emil Velikov; +Cc: Lucas De Marchi
On Mon, 08 Jul 2024 14:43:08 +0100, Emil Velikov wrote:
> Here is the remaining patches from my scdoc series, re-spinned with all
> (:fingers-crossed:) the comments addressed.
>
> The series includes:
> - patch 1-5 - trivial fixes as white space, punctuation, etc
> - patch 6-14 - expand documentation around {depmod,modprobe}.d
> handling, remove open-coded .d and .conf references
> - patch 15 - remove "maintained by" references
> - patch 16 - NEW: replace all AUTHORS sections with suggested snippet
> - patch 17 - list short and long options on separate lines
>
> [...]
Applied, thanks!
[01/17] man: add some extra bold/italic annotations
commit: 134bf30e7493ae50ad31ef5d3767174505eba4cb
[02/17] man: white space fixes
commit: f1e233c31edb7d45704d2c7e7563ca9e8891fb43
[03/17] man: misc punctuation fixes
commit: e971579bba7616cee3e13efa5ced7682fd395739
[04/17] man: some options take an argument, mention that
commit: 2b5c56c43026fba590aa866074964ae79d6f49ab
[05/17] man: couple of grammar/language fixes
commit: 6f80a0874bdbcee17c26750ae92a5bae52f0ae45
[06/17] man: stop removing DISTCONFDIR lines
commit: 52a9d424649cab905fbddd6013eca5fe9c89b40f
[07/17] man: depmod.d: document the config file order handling
commit: 12ca199bd771a5bff17d6ae73fc23be277ccbaf0
[08/17] man: depmod.d: factor out a CONFIGURATION FORMAT section
commit: 0682f1ed56a8f7c681798c720436b2ec3d028d4e
[09/17] man: depmod.d: rework the opening description sentence
commit: 7b19a71289198beac8fae9bcb8d5bc176edb21f2
[10/17] man: depmod: remove hard-coded /etc/depmod.d references
commit: e83e142ce7eb2130cbee16771129482fefc36478
[11/17] man: modprobe.d: document the config file order handling
commit: 11d09ac414bd706ea4a7bf923240655909195da4
[12/17] man: modprobe.d: factor out a CONFIGURATION FORMAT section
commit: e46b473a92c776c84f74e984dc05ffe0ac921a7a
[13/17] man: add few mentions about MODPROBE_OPTIONS
commit: 42d60a3267162a36ec6b6b39a7b91e5078b90979
[14/17] man: modprobe: remove hard-coded /etc/modprobe.d references
commit: 4ec655d249c804b5394d63f0f04bfe5c94ab7031
[15/17] man: remove the "Maintained by" references
commit: ff38d82edeb113b22381cf4d0439a041f64d12c7
[16/17] man: rework AUTHORS section
commit: 082617913f68b0363e5701e470f2b78786dd9aaa
[17/17] man: list options one per line
commit: e7626810fd0f34db2c205b86ff6ad6cf42794fa7
Best regards,
--
Lucas De Marchi <lucas.de.marchi@gmail.com>
^ permalink raw reply [flat|nested] 20+ messages in thread
end of thread, other threads:[~2024-07-09 5:20 UTC | newest]
Thread overview: 20+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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 ` [PATCH kmod v2 04/17] man: some options take an argument, mention that Emil Velikov via B4 Relay
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
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).