Re: [PATCH kmod 00/20] man: convert to scdoc and minor improvements

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, Jun 11, 2024 at 04:05:00PM GMT, Emil Velikov via B4 Relay wrote:
Hello all,

As mentioned previously, here is a series converting the existing xml
based documentation to scdoc.

Despite the size of this series, one should be able to review nearly all
of it during their first morning coffee ;-)

a serious review with git history fossology takes much more than that ;)


I've went ahead with scdoc instead of other solutions since it's a
simple 1K LoC, C99 program with trivial markdown-like syntax. Which is
practically available for any distro [1].

A quick search in Arch shows that over 50 packages/projects use scdoc.

This series:
- patch 1 - simple comparison script of man page _output_ (the roff
  files themselves vary significantly) - DO NOT MERGE
- patch 2 - the scdoc files themselves, including typos to make diff vs
  original smaller
- patch 3 - wires scdoc to the build and removes the old xml files

- patch 4-9 - trivial fixes as white space, punctuation, etc
- patch 10-18 - expand documentation around {depmod,modprobe}.d handling

- patch 19 - remove "maintained by" references
- patch 20 - list short and long options on separate lines

The last two might be little controversial, so feel free to drop them.

NOTE: Some patches have respective question or two within.

As always - comments and suggestions are greatly appreciated.

I went through the entire series and unless I left comments, I agree
with the changes. Thanks a lot for cleaning this up.  Can you submit a
v2 with those comments handled?

Lucas De Marchi


[1] https://repology.org/project/scdoc/versions
[2] https://archlinux.org/packages/extra/x86_64/scdoc/

---
Emil Velikov (20):
     man: add script to generate/compare the xslt vs upcoming scdoc
     man: add scdoc based man pages
     man: build the scdoc based man pages
     man: remove no longer used XML files
     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: modprobe.d: mention about MODPROBE_OPTIONS
     man: modprobe: remove hard-coded /etc/modprobe.d references
     man: remove the "Maintained by" references
     man: list options one per line

configure.ac          |   2 +-
man/Makefile.am       |  30 +--
man/compare.sh        |  63 ++++++
man/depmod.8.scd      | 139 +++++++++++++
man/depmod.8.xml      | 343 -------------------------------
man/depmod.d.5.scd    | 115 +++++++++++
man/depmod.d.5.xml    | 164 ---------------
man/insmod.8.scd      |  35 ++++
man/insmod.8.xml      |  87 --------
man/kmod.8.scd        |  49 +++++
man/kmod.8.xml        | 120 -----------
man/lsmod.8.scd       |  29 +++
man/lsmod.8.xml       |  73 -------
man/modinfo.8.scd     |  84 ++++++++
man/modinfo.8.xml     | 201 -------------------
man/modprobe.8.scd    | 232 +++++++++++++++++++++
man/modprobe.8.xml    | 544 --------------------------------------------------
man/modprobe.d.5.scd  | 187 +++++++++++++++++
man/modprobe.d.5.xml  | 265 ------------------------
man/modules.dep.5.scd |  43 ++++
man/modules.dep.5.xml |  80 --------
man/modules.dep.bin.5 |   1 +
man/rmmod.8.scd       |  53 +++++
man/rmmod.8.xml       | 148 --------------
24 files changed, 1041 insertions(+), 2046 deletions(-)
---
base-commit: 8837461494761d58be579641f20cc043274adddf
change-id: 20240523-man-743d6e51eb6f

Best regards,
--
Emil Velikov <emil.l.velikov@xxxxxxxxx>






[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Big List of Linux Books]

  Powered by Linux