* [PATCH v2 0/2] Don't create Python bytecode when building the kernel
@ 2025-04-16 6:57 Mauro Carvalho Chehab
2025-04-16 6:57 ` [PATCH v2 1/2] scripts/kernel-doc.py: don't create *.pyc files Mauro Carvalho Chehab
0 siblings, 1 reply; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2025-04-16 6:57 UTC (permalink / raw)
To: Linux Doc Mailing List, Jonathan Corbet
Cc: Mauro Carvalho Chehab, linux-kernel, Andy Shevchenko,
David Airlie, Jani Nikula, Joonas Lahtinen, Maarten Lankhorst,
Maxime Ripard, Rodrigo Vivi, Simona Vetter, Thomas Zimmermann,
Tvrtko Ursulin, dri-devel, intel-gfx
As reported by Andy, the Kernel build system runs kernel-doc script for DRM,
when W=1. Due to Python's normal behavior, its JIT compiler will create
a bytecode and store it under scripts/lib/*/__pycache__.
As one may be using O= and even having the sources on a read-only mount
point, disable its creation during build time.
This only solves half of the issue though, as one may be manually running
the script by hand, without asking Python to not store any bytecode.
This should be OK, but afterwards, git status will list the __pycache__ as
not committed. To prevent that, add *.pyc to .gitignore.
Mauro Carvalho Chehab (2):
scripts/kernel-doc.py: don't create *.pyc files
.gitignore: ignore Python compiled bytecode
.gitignore | 1 +
drivers/gpu/drm/Makefile | 2 +-
drivers/gpu/drm/i915/Makefile | 2 +-
include/drm/Makefile | 2 +-
scripts/find-unused-docs.sh | 2 +-
5 files changed, 5 insertions(+), 4 deletions(-)
--
2.49.0
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v2 1/2] scripts/kernel-doc.py: don't create *.pyc files
2025-04-16 6:57 [PATCH v2 0/2] Don't create Python bytecode when building the kernel Mauro Carvalho Chehab
@ 2025-04-16 6:57 ` Mauro Carvalho Chehab
2025-04-16 7:22 ` Andy Shevchenko
2025-04-16 7:33 ` Jani Nikula
0 siblings, 2 replies; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2025-04-16 6:57 UTC (permalink / raw)
To: Linux Doc Mailing List, Jonathan Corbet
Cc: Mauro Carvalho Chehab, Andy Shevchenko, David Airlie, Jani Nikula,
Joonas Lahtinen, Maarten Lankhorst, Maxime Ripard, Rodrigo Vivi,
Simona Vetter, Thomas Zimmermann, Tvrtko Ursulin, dri-devel,
intel-gfx, linux-kernel
As reported by Andy, kernel-doc.py is creating a __pycache__
directory at build time.
Disable creation of __pycache__ for the libraries used by
kernel-doc.py, when excecuted via the build system or via
scripts/find-unused-docs.sh.
Reported-by: Andy Shevchenko <andriy.shevchenko@intel.com>
Closes: https://lore.kernel.org/linux-doc/Z_zYXAJcTD-c3xTe@black.fi.intel.com/
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
drivers/gpu/drm/Makefile | 2 +-
drivers/gpu/drm/i915/Makefile | 2 +-
include/drm/Makefile | 2 +-
scripts/find-unused-docs.sh | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/drivers/gpu/drm/Makefile b/drivers/gpu/drm/Makefile
index ed54a546bbe2..1469d64f8783 100644
--- a/drivers/gpu/drm/Makefile
+++ b/drivers/gpu/drm/Makefile
@@ -236,7 +236,7 @@ always-$(CONFIG_DRM_HEADER_TEST) += \
quiet_cmd_hdrtest = HDRTEST $(patsubst %.hdrtest,%.h,$@)
cmd_hdrtest = \
$(CC) $(c_flags) -fsyntax-only -x c /dev/null -include $< -include $<; \
- $(srctree)/scripts/kernel-doc -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
+ $(KERNELDOC) PYTHONDONTWRITEBYTECODE=1 -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
touch $@
$(obj)/%.hdrtest: $(src)/%.h FORCE
diff --git a/drivers/gpu/drm/i915/Makefile b/drivers/gpu/drm/i915/Makefile
index ed05b131ed3a..bb873f9cc2aa 100644
--- a/drivers/gpu/drm/i915/Makefile
+++ b/drivers/gpu/drm/i915/Makefile
@@ -408,7 +408,7 @@ obj-$(CONFIG_DRM_I915_GVT_KVMGT) += kvmgt.o
#
# Enable locally for CONFIG_DRM_I915_WERROR=y. See also scripts/Makefile.build
ifdef CONFIG_DRM_I915_WERROR
- cmd_checkdoc = $(srctree)/scripts/kernel-doc -none -Werror $<
+ cmd_checkdoc = $(KERNELDOC) PYTHONDONTWRITEBYTECODE=1 -none -Werror $<
endif
# header test
diff --git a/include/drm/Makefile b/include/drm/Makefile
index a7bd15d2803e..6088ea458f44 100644
--- a/include/drm/Makefile
+++ b/include/drm/Makefile
@@ -11,7 +11,7 @@ always-$(CONFIG_DRM_HEADER_TEST) += \
quiet_cmd_hdrtest = HDRTEST $(patsubst %.hdrtest,%.h,$@)
cmd_hdrtest = \
$(CC) $(c_flags) -fsyntax-only -x c /dev/null -include $< -include $<; \
- $(srctree)/scripts/kernel-doc -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
+ $(KERNELDOC) PYTHONDONTWRITEBYTECODE=1 -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
touch $@
$(obj)/%.hdrtest: $(src)/%.h FORCE
diff --git a/scripts/find-unused-docs.sh b/scripts/find-unused-docs.sh
index ee6a50e33aba..d6d397fbf917 100755
--- a/scripts/find-unused-docs.sh
+++ b/scripts/find-unused-docs.sh
@@ -54,7 +54,7 @@ for file in `find $1 -name '*.c'`; do
if [[ ${FILES_INCLUDED[$file]+_} ]]; then
continue;
fi
- str=$(scripts/kernel-doc -export "$file" 2>/dev/null)
+ str=$(PYTHONDONTWRITEBYTECODE=1 scripts/kernel-doc -export "$file" 2>/dev/null)
if [[ -n "$str" ]]; then
echo "$file"
fi
--
2.49.0
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] scripts/kernel-doc.py: don't create *.pyc files
2025-04-16 6:57 ` [PATCH v2 1/2] scripts/kernel-doc.py: don't create *.pyc files Mauro Carvalho Chehab
@ 2025-04-16 7:22 ` Andy Shevchenko
2025-04-16 7:51 ` Mauro Carvalho Chehab
2025-04-16 7:33 ` Jani Nikula
1 sibling, 1 reply; 6+ messages in thread
From: Andy Shevchenko @ 2025-04-16 7:22 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Jonathan Corbet, David Airlie,
Jani Nikula, Joonas Lahtinen, Maarten Lankhorst, Maxime Ripard,
Rodrigo Vivi, Simona Vetter, Thomas Zimmermann, Tvrtko Ursulin,
dri-devel, intel-gfx, linux-kernel
On Wed, Apr 16, 2025 at 02:57:38PM +0800, Mauro Carvalho Chehab wrote:
> As reported by Andy, kernel-doc.py is creating a __pycache__
> directory at build time.
>
> Disable creation of __pycache__ for the libraries used by
> kernel-doc.py, when excecuted via the build system or via
> scripts/find-unused-docs.sh.
Nope, still have it.
I used today's Linux Next with some local code patches (unrelated
to any scripts or kernel doc or python).
To confirm, I even done again a clean build.
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] scripts/kernel-doc.py: don't create *.pyc files
2025-04-16 6:57 ` [PATCH v2 1/2] scripts/kernel-doc.py: don't create *.pyc files Mauro Carvalho Chehab
2025-04-16 7:22 ` Andy Shevchenko
@ 2025-04-16 7:33 ` Jani Nikula
2025-04-16 7:36 ` Jani Nikula
1 sibling, 1 reply; 6+ messages in thread
From: Jani Nikula @ 2025-04-16 7:33 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List, Jonathan Corbet
Cc: Mauro Carvalho Chehab, Andy Shevchenko, David Airlie,
Joonas Lahtinen, Maarten Lankhorst, Maxime Ripard, Rodrigo Vivi,
Simona Vetter, Thomas Zimmermann, Tvrtko Ursulin, dri-devel,
intel-gfx, linux-kernel
On Wed, 16 Apr 2025, Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> As reported by Andy, kernel-doc.py is creating a __pycache__
> directory at build time.
>
> Disable creation of __pycache__ for the libraries used by
> kernel-doc.py, when excecuted via the build system or via
> scripts/find-unused-docs.sh.
>
> Reported-by: Andy Shevchenko <andriy.shevchenko@intel.com>
> Closes: https://lore.kernel.org/linux-doc/Z_zYXAJcTD-c3xTe@black.fi.intel.com/
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> drivers/gpu/drm/Makefile | 2 +-
> drivers/gpu/drm/i915/Makefile | 2 +-
> include/drm/Makefile | 2 +-
> scripts/find-unused-docs.sh | 2 +-
> 4 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/gpu/drm/Makefile b/drivers/gpu/drm/Makefile
> index ed54a546bbe2..1469d64f8783 100644
> --- a/drivers/gpu/drm/Makefile
> +++ b/drivers/gpu/drm/Makefile
> @@ -236,7 +236,7 @@ always-$(CONFIG_DRM_HEADER_TEST) += \
> quiet_cmd_hdrtest = HDRTEST $(patsubst %.hdrtest,%.h,$@)
> cmd_hdrtest = \
> $(CC) $(c_flags) -fsyntax-only -x c /dev/null -include $< -include $<; \
> - $(srctree)/scripts/kernel-doc -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
> + $(KERNELDOC) PYTHONDONTWRITEBYTECODE=1 -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
It doesn't work to put PYTHONDONTWRITEBYTECODE=1 as a parameter to
kernel-doc...
BR,
Jani.
> touch $@
>
> $(obj)/%.hdrtest: $(src)/%.h FORCE
> diff --git a/drivers/gpu/drm/i915/Makefile b/drivers/gpu/drm/i915/Makefile
> index ed05b131ed3a..bb873f9cc2aa 100644
> --- a/drivers/gpu/drm/i915/Makefile
> +++ b/drivers/gpu/drm/i915/Makefile
> @@ -408,7 +408,7 @@ obj-$(CONFIG_DRM_I915_GVT_KVMGT) += kvmgt.o
> #
> # Enable locally for CONFIG_DRM_I915_WERROR=y. See also scripts/Makefile.build
> ifdef CONFIG_DRM_I915_WERROR
> - cmd_checkdoc = $(srctree)/scripts/kernel-doc -none -Werror $<
> + cmd_checkdoc = $(KERNELDOC) PYTHONDONTWRITEBYTECODE=1 -none -Werror $<
> endif
>
> # header test
> diff --git a/include/drm/Makefile b/include/drm/Makefile
> index a7bd15d2803e..6088ea458f44 100644
> --- a/include/drm/Makefile
> +++ b/include/drm/Makefile
> @@ -11,7 +11,7 @@ always-$(CONFIG_DRM_HEADER_TEST) += \
> quiet_cmd_hdrtest = HDRTEST $(patsubst %.hdrtest,%.h,$@)
> cmd_hdrtest = \
> $(CC) $(c_flags) -fsyntax-only -x c /dev/null -include $< -include $<; \
> - $(srctree)/scripts/kernel-doc -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
> + $(KERNELDOC) PYTHONDONTWRITEBYTECODE=1 -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
> touch $@
>
> $(obj)/%.hdrtest: $(src)/%.h FORCE
> diff --git a/scripts/find-unused-docs.sh b/scripts/find-unused-docs.sh
> index ee6a50e33aba..d6d397fbf917 100755
> --- a/scripts/find-unused-docs.sh
> +++ b/scripts/find-unused-docs.sh
> @@ -54,7 +54,7 @@ for file in `find $1 -name '*.c'`; do
> if [[ ${FILES_INCLUDED[$file]+_} ]]; then
> continue;
> fi
> - str=$(scripts/kernel-doc -export "$file" 2>/dev/null)
> + str=$(PYTHONDONTWRITEBYTECODE=1 scripts/kernel-doc -export "$file" 2>/dev/null)
> if [[ -n "$str" ]]; then
> echo "$file"
> fi
--
Jani Nikula, Intel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] scripts/kernel-doc.py: don't create *.pyc files
2025-04-16 7:33 ` Jani Nikula
@ 2025-04-16 7:36 ` Jani Nikula
0 siblings, 0 replies; 6+ messages in thread
From: Jani Nikula @ 2025-04-16 7:36 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List, Jonathan Corbet
Cc: Mauro Carvalho Chehab, Andy Shevchenko, David Airlie,
Joonas Lahtinen, Maarten Lankhorst, Maxime Ripard, Rodrigo Vivi,
Simona Vetter, Thomas Zimmermann, Tvrtko Ursulin, dri-devel,
intel-gfx, linux-kernel
On Wed, 16 Apr 2025, Jani Nikula <jani.nikula@linux.intel.com> wrote:
> On Wed, 16 Apr 2025, Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
>> As reported by Andy, kernel-doc.py is creating a __pycache__
>> directory at build time.
>>
>> Disable creation of __pycache__ for the libraries used by
>> kernel-doc.py, when excecuted via the build system or via
>> scripts/find-unused-docs.sh.
>>
>> Reported-by: Andy Shevchenko <andriy.shevchenko@intel.com>
>> Closes: https://lore.kernel.org/linux-doc/Z_zYXAJcTD-c3xTe@black.fi.intel.com/
>> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>> ---
>> drivers/gpu/drm/Makefile | 2 +-
>> drivers/gpu/drm/i915/Makefile | 2 +-
>> include/drm/Makefile | 2 +-
>> scripts/find-unused-docs.sh | 2 +-
>> 4 files changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/drivers/gpu/drm/Makefile b/drivers/gpu/drm/Makefile
>> index ed54a546bbe2..1469d64f8783 100644
>> --- a/drivers/gpu/drm/Makefile
>> +++ b/drivers/gpu/drm/Makefile
>> @@ -236,7 +236,7 @@ always-$(CONFIG_DRM_HEADER_TEST) += \
>> quiet_cmd_hdrtest = HDRTEST $(patsubst %.hdrtest,%.h,$@)
>> cmd_hdrtest = \
>> $(CC) $(c_flags) -fsyntax-only -x c /dev/null -include $< -include $<; \
>> - $(srctree)/scripts/kernel-doc -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
>> + $(KERNELDOC) PYTHONDONTWRITEBYTECODE=1 -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
>
> It doesn't work to put PYTHONDONTWRITEBYTECODE=1 as a parameter to
> kernel-doc...
Moreover, KERNELDOC is only defined in Documentation/Makefile. It's
empty here.
Also scripts/Makefile.build uses kernel-doc, which is probably the one
creating __pycache__ Andy sees.
>
> BR,
> Jani.
>
>
>> touch $@
>>
>> $(obj)/%.hdrtest: $(src)/%.h FORCE
>> diff --git a/drivers/gpu/drm/i915/Makefile b/drivers/gpu/drm/i915/Makefile
>> index ed05b131ed3a..bb873f9cc2aa 100644
>> --- a/drivers/gpu/drm/i915/Makefile
>> +++ b/drivers/gpu/drm/i915/Makefile
>> @@ -408,7 +408,7 @@ obj-$(CONFIG_DRM_I915_GVT_KVMGT) += kvmgt.o
>> #
>> # Enable locally for CONFIG_DRM_I915_WERROR=y. See also scripts/Makefile.build
>> ifdef CONFIG_DRM_I915_WERROR
>> - cmd_checkdoc = $(srctree)/scripts/kernel-doc -none -Werror $<
>> + cmd_checkdoc = $(KERNELDOC) PYTHONDONTWRITEBYTECODE=1 -none -Werror $<
>> endif
>>
>> # header test
>> diff --git a/include/drm/Makefile b/include/drm/Makefile
>> index a7bd15d2803e..6088ea458f44 100644
>> --- a/include/drm/Makefile
>> +++ b/include/drm/Makefile
>> @@ -11,7 +11,7 @@ always-$(CONFIG_DRM_HEADER_TEST) += \
>> quiet_cmd_hdrtest = HDRTEST $(patsubst %.hdrtest,%.h,$@)
>> cmd_hdrtest = \
>> $(CC) $(c_flags) -fsyntax-only -x c /dev/null -include $< -include $<; \
>> - $(srctree)/scripts/kernel-doc -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
>> + $(KERNELDOC) PYTHONDONTWRITEBYTECODE=1 -none $(if $(CONFIG_WERROR)$(CONFIG_DRM_WERROR),-Werror) $<; \
>> touch $@
>>
>> $(obj)/%.hdrtest: $(src)/%.h FORCE
>> diff --git a/scripts/find-unused-docs.sh b/scripts/find-unused-docs.sh
>> index ee6a50e33aba..d6d397fbf917 100755
>> --- a/scripts/find-unused-docs.sh
>> +++ b/scripts/find-unused-docs.sh
>> @@ -54,7 +54,7 @@ for file in `find $1 -name '*.c'`; do
>> if [[ ${FILES_INCLUDED[$file]+_} ]]; then
>> continue;
>> fi
>> - str=$(scripts/kernel-doc -export "$file" 2>/dev/null)
>> + str=$(PYTHONDONTWRITEBYTECODE=1 scripts/kernel-doc -export "$file" 2>/dev/null)
>> if [[ -n "$str" ]]; then
>> echo "$file"
>> fi
--
Jani Nikula, Intel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] scripts/kernel-doc.py: don't create *.pyc files
2025-04-16 7:22 ` Andy Shevchenko
@ 2025-04-16 7:51 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2025-04-16 7:51 UTC (permalink / raw)
To: Andy Shevchenko
Cc: Linux Doc Mailing List, Jonathan Corbet, David Airlie,
Jani Nikula, Joonas Lahtinen, Maarten Lankhorst, Maxime Ripard,
Rodrigo Vivi, Simona Vetter, Thomas Zimmermann, Tvrtko Ursulin,
dri-devel, intel-gfx, linux-kernel
Em Wed, 16 Apr 2025 10:22:24 +0300
Andy Shevchenko <andriy.shevchenko@intel.com> escreveu:
> On Wed, Apr 16, 2025 at 02:57:38PM +0800, Mauro Carvalho Chehab wrote:
> > As reported by Andy, kernel-doc.py is creating a __pycache__
> > directory at build time.
> >
> > Disable creation of __pycache__ for the libraries used by
> > kernel-doc.py, when excecuted via the build system or via
> > scripts/find-unused-docs.sh.
>
> Nope, still have it.
>
> I used today's Linux Next with some local code patches (unrelated
> to any scripts or kernel doc or python).
>
> To confirm, I even done again a clean build.
>
There were one missing place.
Sent a v3. Please test.
Regards,
Mauro
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2025-04-16 13:16 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-04-16 6:57 [PATCH v2 0/2] Don't create Python bytecode when building the kernel Mauro Carvalho Chehab
2025-04-16 6:57 ` [PATCH v2 1/2] scripts/kernel-doc.py: don't create *.pyc files Mauro Carvalho Chehab
2025-04-16 7:22 ` Andy Shevchenko
2025-04-16 7:51 ` Mauro Carvalho Chehab
2025-04-16 7:33 ` Jani Nikula
2025-04-16 7:36 ` Jani Nikula
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).