Re: PATCH] scripts: docs: kdoc_files.py: don't consider symlinks as directories

[Randy Dunlap]

[all of my copies of this email had header (at least Subject:) problems]


On 11/12/25 9:14 AM, mchehab+huawei@xxxxxxxxxx wrote:
> From: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> To: Linux Doc Mailing List <linux-doc@xxxxxxxxxxxxxxx>,
> 	Jonathan Corbet <corbet@xxxxxxx>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>,
> 	linux-kernel@xxxxxxxxxxxxxxx,
> 	Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Subject: [PATCH] scripts: docs: kdoc_files.py: don't consider symlinks as directories
> Date: Wed, 12 Nov 2025 18:14:49 +0100
> Message-ID: <73c3450f34e2a4b42ef2ef279d7487c47d22e3bd.1762967688.git.mchehab+huawei@xxxxxxxxxx>
> X-Mailer: git-send-email 2.51.1
> MIME-Version: 1.0
> Content-Transfer-Encoding: 8bit
> 
> 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@xxxxxxxxxxxxx>
> Closes: https://lore.kernel.org/linux-doc/80701524-09fd-4d68-8715-331f47c969f2@xxxxxxxxxxxxx/
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

> ---
>  scripts/lib/kdoc/kdoc_files.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/scripts/lib/kdoc/kdoc_files.py b/scripts/lib/kdoc/kdoc_files.py
> index 061c033f32da..1fd8d17edb32 100644
> --- a/scripts/lib/kdoc/kdoc_files.py
> +++ b/scripts/lib/kdoc/kdoc_files.py
> @@ -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():

-- 
~Randy