linux-modules.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Emil Velikov via B4 Relay <devnull+emil.l.velikov.gmail.com@kernel.org>
To: linux-modules@vger.kernel.org
Cc: Emil Velikov <emil.l.velikov@gmail.com>
Subject: [PATCH kmod v2 00/17] man: minor improvements, post the scdoc conversion
Date: Mon, 08 Jul 2024 14:43:08 +0100	[thread overview]
Message-ID: <20240708-man-v2-0-a23df6ef871e@gmail.com> (raw)

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>



             reply	other threads:[~2024-07-08 13:43 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-08 13:43 Emil Velikov via B4 Relay [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240708-man-v2-0-a23df6ef871e@gmail.com \
    --to=devnull+emil.l.velikov.gmail.com@kernel.org \
    --cc=emil.l.velikov@gmail.com \
    --cc=linux-modules@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).