]> Gentwo Git Trees - linux/.git/commitdiff
scripts: docs: kdoc_files.py: don't consider symlinks as directories
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 13 Nov 2025 09:53:43 +0000 (10:53 +0100)
committerJonathan Corbet <corbet@lwn.net>
Thu, 13 Nov 2025 16:16:15 +0000 (09:16 -0700)
As reported by Randy, currently kdoc_files can go into endless
looks when symlinks are used:

$ ln -s . Documentation/peci/foo
$ ./scripts/kernel-doc Documentation/peci/
...
  File "/new_devel/docs/scripts/lib/kdoc/kdoc_files.py", line 52, in _parse_dir
    if entry.is_dir():
       ~~~~~~~~~~~~^^
OSError: [Errno 40] Too many levels of symbolic links: 'Documentation/peci/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo/foo'

Prevent that by not considering symlinks as directories.

Reported-by: Randy Dunlap <rdunlap@infradead.org>
Closes: https://lore.kernel.org/linux-doc/80701524-09fd-4d68-8715-331f47c969f2@infradead.org/
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <73c3450f34e2a4b42ef2ef279d7487c47d22e3bd.1763027622.git.mchehab+huawei@kernel.org>

scripts/lib/kdoc/kdoc_files.py

index 061c033f32da37b6913511a1fa5557d6bab39d0d..1fd8d17edb321616ccf8bec4b0308cdb02a6b07c 100644 (file)
@@ -49,7 +49,7 @@ class GlobSourceFiles:
             for entry in obj:
                 name = os.path.join(dirname, entry.name)
 
-                if entry.is_dir():
+                if entry.is_dir(follow_symlinks=False):
                     yield from self._parse_dir(name)
 
                 if not entry.is_file():