[kmod,v2,00/17] man: minor improvements, post the scdoc conversion

Message

Emil Velikov via B4 Relay July 8, 2024, 1:43 p.m. UTC

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/[e-mail]

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

Comments

Lucas De Marchi July 9, 2024, 5:20 a.m. UTC | #1

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,