]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
docs: Makefile: wrap SPHINXDIRS help text
authorMustafa Elrasheid <mustafaelrasheid@gmail.com>
Sat, 27 Dec 2025 12:52:44 +0000 (15:52 +0300)
committerJonathan Corbet <corbet@lwn.net>
Tue, 6 Jan 2026 21:37:08 +0000 (14:37 -0700)
When using `make help`, SPHINXDIR doesn't wrap around 80 characters,
causing text to overflow or wrap in incorrect ways,
which then makes the text difficult to read

Signed-off-by: Mustafa Elrasheid <mustafaelrasheid@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251227125244.6407-1-mustafaelrasheid@gmail.com>

Documentation/Makefile

index e96ac6dcac4f1f5b43fc23777e490bbae2c1ea3c..377a449656c8174347ed1f8c779964c66ddf1746 100644 (file)
@@ -98,7 +98,8 @@ dochelp:
        @echo  '  cleandocs       - clean all generated files'
        @echo
        @echo  '  make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
-       @echo  '  top level values for SPHINXDIRS are: $(_SPHINXDIRS)'
+       @echo  '  top level values for SPHINXDIRS are:'
+       @echo  '$(_SPHINXDIRS)' | fmt -s -w 75 -g 75 | sed 's/^/    /'
        @echo  '  you may also use a subdirectory like SPHINXDIRS=userspace-api/media,'
        @echo  '  provided that there is an index.rst file at the subdirectory.'
        @echo