diff mbox series

[kmod,v2,09/17] man: depmod.d: rework the opening description sentence

Message ID 20240708-man-v2-9-a23df6ef871e@gmail.com (mailing list archive)
State New
Headers show
Series man: minor improvements, post the scdoc conversion | expand

Commit Message

Emil Velikov via B4 Relay July 8, 2024, 1:43 p.m. UTC
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(-)

Comments

Lucas De Marchi July 9, 2024, 5:01 a.m. UTC | #1
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
>
>
diff mbox series

Patch

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