From 88e454523ee5ccd69d07b4664eab95400a9045c3 Mon Sep 17 00:00:00 2001 From: Emil Velikov Date: Sun, 9 Nov 2025 23:30:08 +0000 Subject: [PATCH] man: de-duplicate AUTHOR/BUGS sections Move the sections into a dedicated trailer.scd file, which gets added during manpage generation. Note, that this removes the following text from kmod.8, which is intentional: *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. Signed-off-by: Emil Velikov Reviewed-by: Lucas De Marchi Link: https://github.com/kmod-project/kmod/pull/pull/400 Signed-off-by: Lucas De Marchi --- man/depmod.8.scd | 16 ---------------- man/depmod.d.5.scd | 16 ---------------- man/insmod.8.scd | 16 ---------------- man/kmod.8.scd | 20 -------------------- man/lsmod.8.scd | 16 ---------------- man/meson.build | 4 ++-- man/modinfo.8.scd | 16 ---------------- man/modprobe.8.scd | 16 ---------------- man/modprobe.d.5.scd | 16 ---------------- man/modules.dep.5.scd | 16 ---------------- man/rmmod.8.scd | 16 ---------------- man/trailer.scd | 16 ++++++++++++++++ scripts/build-scdoc.sh | 6 ++++-- 13 files changed, 22 insertions(+), 168 deletions(-) create mode 100644 man/trailer.scd diff --git a/man/depmod.8.scd b/man/depmod.8.scd index 10bcfc8e..1d98da18 100644 --- a/man/depmod.8.scd +++ b/man/depmod.8.scd @@ -163,19 +163,3 @@ Portions Copyright Jon Masters, and others. # SEE ALSO *depmod.d*(5), *modprobe*(8), *modules.dep*(5) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHORS - -Numerous contributions have come from the linux-modules mailing list - 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* is the current maintainer of the -project. diff --git a/man/depmod.d.5.scd b/man/depmod.d.5.scd index 797a184f..10861162 100644 --- a/man/depmod.d.5.scd +++ b/man/depmod.d.5.scd @@ -100,19 +100,3 @@ This manual page Copyright 2006-2010, Jon Masters, Red Hat, Inc. # SEE ALSO *depmod*(8) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHORS - -Numerous contributions have come from the linux-modules mailing list - 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* is the current maintainer of the -project. diff --git a/man/insmod.8.scd b/man/insmod.8.scd index 103d9360..a9a32c83 100644 --- a/man/insmod.8.scd +++ b/man/insmod.8.scd @@ -62,19 +62,3 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation. # SEE ALSO *modprobe*(8), *rmmod*(8), *lsmod*(8), *modinfo*(8), *depmod*(8) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHORS - -Numerous contributions have come from the linux-modules mailing list - 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* is the current maintainer of the -project. diff --git a/man/kmod.8.scd b/man/kmod.8.scd index c3c12543..cf8a0e47 100644 --- a/man/kmod.8.scd +++ b/man/kmod.8.scd @@ -40,23 +40,3 @@ This manual page originally Copyright 2014, Marco d'Itri. # SEE ALSO *lsmod*(8), *rmmod*(8), *insmod*(8), *modinfo*(8), *modprobe*(8), *depmod*(8) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHOR - -*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 - 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* is the current maintainer of the -project. diff --git a/man/lsmod.8.scd b/man/lsmod.8.scd index 339526df..9147a4ad 100644 --- a/man/lsmod.8.scd +++ b/man/lsmod.8.scd @@ -35,19 +35,3 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation. # SEE ALSO *insmod*(8), *modprobe*(8), *modinfo*(8), *depmod*(8) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHORS - -Numerous contributions have come from the linux-modules mailing list - 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* is the current maintainer of the -project. diff --git a/man/meson.build b/man/meson.build index 6731417c..0409b280 100644 --- a/man/meson.build +++ b/man/meson.build @@ -21,12 +21,12 @@ foreach tuple : _man_pages command : [ build_scdoc, scdoc, - '@INPUT@', 's|@SYSCONFDIR@|@0@|g;'.format(sysconfdir) + 's|@DISTCONFDIR@|@0@|g;'.format(distconfdir) + 's|@MODULE_DIRECTORY@|@0@|g;'.format(moduledir), + '@INPUT@', ], - input : f'@man@.@section@.scd', + input : [f'@man@.@section@.scd', files('trailer.scd')], output : f'@man@.@section@', capture : true, install : true, diff --git a/man/modinfo.8.scd b/man/modinfo.8.scd index b32e7118..2469f38e 100644 --- a/man/modinfo.8.scd +++ b/man/modinfo.8.scd @@ -69,19 +69,3 @@ This manual page originally Copyright 2003, Rusty Russell, IBM Corporation. # SEE ALSO *modprobe*(8) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHORS - -Numerous contributions have come from the linux-modules mailing list - 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* is the current maintainer of the -project. diff --git a/man/modprobe.8.scd b/man/modprobe.8.scd index 8c4cceae..12c72fdd 100644 --- a/man/modprobe.8.scd +++ b/man/modprobe.8.scd @@ -229,19 +229,3 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation. # SEE ALSO *modprobe.d*(5), *insmod*(8), *rmmod*(8), *lsmod*(8), *modinfo*(8), *depmod*(8) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHORS - -Numerous contributions have come from the linux-modules mailing list - 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* is the current maintainer of the -project. diff --git a/man/modprobe.d.5.scd b/man/modprobe.d.5.scd index 40df89c7..334b382b 100644 --- a/man/modprobe.d.5.scd +++ b/man/modprobe.d.5.scd @@ -171,19 +171,3 @@ This manual page originally Copyright 2004, Rusty Russell, IBM Corporation. # SEE ALSO *modprobe*(8), *modules.dep*(5) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHORS - -Numerous contributions have come from the linux-modules mailing list - 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* is the current maintainer of the -project. diff --git a/man/modules.dep.5.scd b/man/modules.dep.5.scd index 37c38bf0..5fa6bf97 100644 --- a/man/modules.dep.5.scd +++ b/man/modules.dep.5.scd @@ -33,19 +33,3 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation. # SEE ALSO *depmod*(8), *modprobe*(8) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHORS - -Numerous contributions have come from the linux-modules mailing list - 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* is the current maintainer of the -project. diff --git a/man/rmmod.8.scd b/man/rmmod.8.scd index d4c22628..66bc8487 100644 --- a/man/rmmod.8.scd +++ b/man/rmmod.8.scd @@ -48,19 +48,3 @@ This manual page originally Copyright 2002, Rusty Russell, IBM Corporation. # SEE ALSO *modprobe*(8), *insmod*(8), *lsmod*(8), *modinfo*(8), *depmod*(8) - -# BUGS - -Please direct any bug reports to kmod's issue tracker at -https://github.com/kmod-project/kmod/issues/ alongside with version used, steps -to reproduce the problem and the expected outcome. - -# AUTHORS - -Numerous contributions have come from the linux-modules mailing list - 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* is the current maintainer of the -project. diff --git a/man/trailer.scd b/man/trailer.scd new file mode 100644 index 00000000..0f0364c6 --- /dev/null +++ b/man/trailer.scd @@ -0,0 +1,16 @@ + +# AUTHORS + +Numerous contributions have come from the linux-modules mailing list + 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* is the current maintainer of the +project. + +# BUGS + +Please direct any bug reports to kmod's issue tracker at +https://github.com/kmod-project/kmod/issues/ alongside with version used, steps +to reproduce the problem and the expected outcome. diff --git a/scripts/build-scdoc.sh b/scripts/build-scdoc.sh index 0a4ffc38..72fdee27 100755 --- a/scripts/build-scdoc.sh +++ b/scripts/build-scdoc.sh @@ -3,7 +3,9 @@ set -euo pipefail SCDOC=$1 -INPUT=$2 -SED_PATTERN=$3 +shift +SED_PATTERN=$1 +shift +INPUT=$* sed -e $SED_PATTERN $INPUT | $SCDOC -- 2.47.3