diff mbox series

[kmod,19/20] man: remove the "Maintained by" references

Message ID 20240611-man-v1-19-bd6864d49639@gmail.com (mailing list archive)
State Handled Elsewhere
Headers show
Series man: convert to scdoc and minor improvements | expand

Commit Message

Emil Velikov via B4 Relay June 11, 2024, 3:05 p.m. UTC 
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(-)

Comments

Lucas De Marchi June 29, 2024, 5:51 p.m. UTC | #1 
On Tue, Jun 11, 2024 at 04:05:19PM GMT, Emil Velikov via B4 Relay wrote:
>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.

Jon was the author and maintainer of module-init-tools, that got replaced
by kmod:

https://lwn.net/Articles/472354/
my blog: https://politreco.com/2011/12/announce-kmod-1/
Jon's blog: http://www.jonmasters.org/blog/2011/12/20/libkmod-replaces-module-init-tools/  

>
>Most importantly the Copyright section isn't the best place to reference
>the maintainer/contact person.

agreed

>
>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?

I like the format used by git:

AUTHORS
        Git was started by Linus Torvalds, and is currently maintained by
        Junio C Hamano. Numerous contributions have come from the Git
        mailing list <git@vger.kernel.org[6]>.
        https://openhub.net/p/git/contributors/summary gives you a more
        complete list of contributors.

        If you have a clone of git.git itself, the output of
        git-shortlog(1) and git-blame(1) can show you the authors for
        specific parts of the project.

Can we get inspiration from there, remove the COPYRIGHT section and add
a new AUTHORS section?  A brief history mentioning that kmod replaced
module-init-tools can be added in kmod(8). Something like this?

KMOD(8)
...
AUTHORS
        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.

The other man pages can omit the first paragraph.

thanks
Lucas De Marchi

>---
> 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 8354765..657d172 100644
>--- a/man/modprobe.8.scd
>+++ b/man/modprobe.8.scd
>@@ -197,7 +197,6 @@ The MODPROBE_OPTIONS environment variable can also be used to pass arguments to
> # 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 9d03c49..41d2e78 100644
>--- a/man/modprobe.d.5.scd
>+++ b/man/modprobe.d.5.scd
>@@ -170,7 +170,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.0
>
>
diff mbox series

Patch

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 8354765..657d172 100644
--- a/man/modprobe.8.scd
+++ b/man/modprobe.8.scd
@@ -197,7 +197,6 @@  The MODPROBE_OPTIONS environment variable can also be used to pass arguments to
 # 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 9d03c49..41d2e78 100644
--- a/man/modprobe.d.5.scd
+++ b/man/modprobe.d.5.scd
@@ -170,7 +170,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