Re: Issue in man page sysfs.5

[Alejandro Colomar <alx@kernel.org>]

[-- Attachment #1: Type: text/plain, Size: 2910 bytes --]

Hi Helge,

On Thu, Dec 25, 2025 at 07:11:46AM +0000, Helge Kreutzmann wrote:
> Without further ado, the following was found:
> 
> Issue:     The 2nd sentence is incomplete
> 
> "This directory contains one file for each module parameter, with each file "
> "containing the value of the corresponding parameter.  Some of these files "
> "are writable, allowing the"

Huh!

That happened in

	commit 6df684e0d3e9129d27d2f37a35226bacee92f62e
	Author: Michael Kerrisk <mtk.manpages@gmail.com>
	Date:   Mon Sep 11 12:14:44 2017 +0200

	    sysfs.5: Various additions and improvements
	    
	    Drawn from Documentation/filesystems/sysfs.txt, P. Mochel's OLS
	    paper, and some naive investigation.
	    
	    Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>

which contains

	[...]
	+.TP
	+.I notes
	+[To be documented]
	+.TP
	+.I parameters
	+This directory contains one file for each module parameter,
	+with each file containing the value of the corresponding parameter.
	+Some of these files are writable, allowing the 
	+.TP
	+.I sections
	+This subdirectories contains files with information about module sections.
	+This information is mainly used for debugging.
	[...]

Luckily, there's another similar sentence in the same file:

	$ grep -C2 allowing man/man5/sysfs.5 
	.B sysfs
	filesystem are read-only,
	but some files are writable, allowing kernel variables to be changed.
	To avoid redundancy,
	symbolic links are heavily used to connect entries across the filesystem tree.
	--
	This directory contains one file for each module parameter,
	with each file containing the value of the corresponding parameter.
	Some of these files are writable, allowing the
	.TP
	.I sections

It seems he wanted to write that.  I'll apply this fix:

	commit 318b197cd7cd76c05a753e467ac8468676f9f344 (HEAD -> contrib)
	Author: Alejandro Colomar <alx@kernel.org>
	Date:   Thu Dec 25 14:14:30 2025 +0100

	    man/man5/sysfs.5: /sys/module/parameters: Fix incomplete sentence
	    
	    Reported-by: Helge Kreutzmann <debian@helgefjell.de>
	    Fixes: 6df684e0d3e9 (2017-09-11; "sysfs.5: Various additions and improvements")
	    Signed-off-by: Alejandro Colomar <alx@kernel.org>

	diff --git a/man/man5/sysfs.5 b/man/man5/sysfs.5
	index c9dbab772..971b7aa32 100644
	--- a/man/man5/sysfs.5
	+++ b/man/man5/sysfs.5
	@@ -239,7 +239,7 @@ .SS Files and directories
	 .I parameters
	 This directory contains one file for each module parameter,
	 with each file containing the value of the corresponding parameter.
	-Some of these files are writable, allowing the
	+Some of these files are writable, allowing the parameters to be changed.
	 .TP
	 .I sections
	 This subdirectories contains files with information about module sections.

Thanks for the report!


Have a lovely day!
Alex

-- 
<https://www.alejandro-colomar.es>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]