Go to file
Vegard Nossum 983e20cfdc docs: kernel_feat.py: fix build error for missing files
If the directory passed to the '.. kernel-feat::' directive does not
exist or the get_feat.pl script does not find any files to extract
features from, Sphinx will report the following error:

    Sphinx parallel build error:
    UnboundLocalError: local variable 'fname' referenced before assignment
    make[2]: *** [Documentation/Makefile:102: htmldocs] Error 2

This is due to how I changed the script in c48a7c44a1 ("docs:
kernel_feat.py: fix potential command injection"). Before that, the
filename passed along to self.nestedParse() in this case was weirdly
just the whole get_feat.pl invocation.

We can fix it by doing what kernel_abi.py does -- just pass
self.arguments[0] as 'fname'.

Fixes: c48a7c44a1 ("docs: kernel_feat.py: fix potential command injection")
Cc: Justin Forbes <jforbes@fedoraproject.org>
Cc: Salvatore Bonaccorso <carnil@debian.org>
Cc: Jani Nikula <jani.nikula@intel.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: stable@vger.kernel.org
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Link: https://lore.kernel.org/r/20240205175133.774271-2-vegard.nossum@oracle.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2024-02-21 13:44:21 -07:00
Documentation docs: kernel_feat.py: fix build error for missing files 2024-02-21 13:44:21 -07:00
LICENSES
arch powerpc fixes for 6.8 #2 2024-01-21 11:04:29 -08:00
block
certs
crypto
drivers drm/vram-helper: Fix 'multi-line' kernel-doc comments 2024-01-30 13:03:01 -07:00
fs More bcachefs updates for 6.7-rc1 2024-01-21 14:01:12 -08:00
include drm/vram-helper: Fix 'multi-line' kernel-doc comments 2024-01-30 13:03:01 -07:00
init
io_uring
ipc
kernel Updates for time and clocksources: 2024-01-21 11:14:40 -08:00
lib
mm
net
rust
samples
scripts kernel-doc: handle #if in enums as well 2024-02-21 13:44:21 -07:00
security
sound
tools
usr
virt
.clang-format
.cocciconfig
.editorconfig
.get_maintainer.ignore
.gitattributes
.gitignore
.mailmap
.rustfmt.toml
COPYING
CREDITS
Kbuild
Kconfig
MAINTAINERS MAINTAINERS: Set the field name for subsystem profile section 2024-02-21 13:44:21 -07:00
Makefile Linux 6.8-rc1 2024-01-21 14:11:32 -08:00
README README: Fix spelling/capitalization 2024-02-12 16:42:13 -07:00

README

Linux kernel
============

There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.

In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``.  The formatted documentation can also be read online at:

    https://www.kernel.org/doc/html/latest/

There are various text files in the Documentation/ subdirectory,
several of them using the ReStructured Text markup notation.

Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.