From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 0F0EA35979; Tue, 15 Apr 2025 08:40:49 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744706450; cv=none; b=J+kYudK1Rby7iQh78BdP9xFLZdeTQX/FTpTaJWuK/pTOkDXgPVNFFDiumIEacb4j4uq/gP+V/eFPGI02Dod1BRyd7CL/54q1UO5jmE0q3T2u5jd1LD+AFo7jy+zOhSPl7J1OXNultqBhTVsT6/6BT3v0eRCWZFv+HWzbxJUeWUY= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744706450; c=relaxed/simple; bh=CNnBGavtM1TabEYHR7zBvpBl6oLEoxMEmYHdJit8cRA=; h=Date:From:To:Cc:Subject:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=ZHvlTcmwPwagO4AX62kyhPjANFYp7lEqIWmRy8Pc4cMilBicSJA/5qXIdRKCuCeL/xXYeok7af2FS3AB2wyt4OPHxMstaP5xciGEvzW+URis9iFWkJlbkCRU0W4Wsd1o1YV/yQ+RBbxBZ1X1eeq5RmukYpYWZju3OrvQTfN8FPM= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=LShLMWXR; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="LShLMWXR" Received: by smtp.kernel.org (Postfix) with ESMTPSA id CE7B4C4CEDD; Tue, 15 Apr 2025 08:40:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1744706449; bh=CNnBGavtM1TabEYHR7zBvpBl6oLEoxMEmYHdJit8cRA=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=LShLMWXRa5NnUR3tsEns18Eyag2Cdp8/5umuqEO6PPlx0VCBhLDAesKWuuk4C85d5 M4CHQKmVkDdPs9V8OE2UX26zYQov5i9R3XOz/G8d0zG12d5qstXWJiIkH2oifKKvyA t/LTxoMI1vf/KiqVTFYIVU+qVIKuIIKwEVpi6VVie0iVKJ6XDA4/LPQCOOBKYP9g9M 03BD/5iS+OziB9ObC+KyasD+S6cXdLEuPPRCqXEJKLIc9NvTMprFcC/HortcmWU/Qf v7vgs84svuOZty4tBGPj4LmJiyUdC94kg4yvXtbl7bCS8ID0MB/dZbKxub4OQIGbnP 1qPTjVFid1qrw== Date: Tue, 15 Apr 2025 16:40:34 +0800 From: Mauro Carvalho Chehab To: Andy Shevchenko Cc: Jani Nikula , Jonathan Corbet , Linux Doc Mailing List , linux-kernel@vger.kernel.org, "Gustavo A. R. Silva" , Kees Cook , Russell King , linux-hardening@vger.kernel.org, netdev@vger.kernel.org Subject: Re: [PATCH v3 00/33] Implement kernel-doc in Python Message-ID: <20250415164014.575c0892@sal.lan> In-Reply-To: References: <871pu1193r.fsf@trenco.lwn.net> <87mscibwm8.fsf@trenco.lwn.net> <87v7r5sw3a.fsf@intel.com> X-Mailer: Claws Mail 4.3.1 (GTK 3.24.43; x86_64-redhat-linux-gnu) Precedence: bulk X-Mailing-List: linux-doc@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Em Tue, 15 Apr 2025 11:19:26 +0300 Andy Shevchenko escreveu: > On Tue, Apr 15, 2025 at 11:17:12AM +0300, Andy Shevchenko wrote: > > On Tue, Apr 15, 2025 at 10:49:29AM +0300, Jani Nikula wrote: > > > On Tue, 15 Apr 2025, Andy Shevchenko wrote: > > > > On Tue, Apr 15, 2025 at 10:01:04AM +0300, Andy Shevchenko wrote: > > > >> On Mon, Apr 14, 2025 at 09:17:51AM -0600, Jonathan Corbet wrote: > > > >> > Andy Shevchenko writes: > > > >> > > On Wed, Apr 09, 2025 at 12:30:00PM -0600, Jonathan Corbet wrote: > > > >> > >> Mauro Carvalho Chehab writes: > > > >> > >> > > > >> > >> > This changeset contains the kernel-doc.py script to replace the verable > > > >> > >> > kernel-doc originally written in Perl. It replaces the first version and the > > > >> > >> > second series I sent on the top of it. > > > >> > >> > > > >> > >> OK, I've applied it, looked at the (minimal) changes in output, and > > > >> > >> concluded that it's good - all this stuff is now in docs-next. Many > > > >> > >> thanks for doing this! > > > >> > >> > > > >> > >> I'm going to hold off on other documentation patches for a day or two > > > >> > >> just in case anything turns up. But it looks awfully good. > > > >> > > > > > >> > > This started well, until it becomes a scripts/lib/kdoc. > > > >> > > So, it makes the `make O=...` builds dirty *). Please make sure this doesn't leave > > > >> > > "disgusting turd" )as said by Linus) in the clean tree. > > > >> > > > > > >> > > *) it creates that __pycache__ disaster. And no, .gitignore IS NOT a solution. > > > >> > > > > >> > If nothing else, "make cleandocs" should clean it up, certainly. > > > >> > > > > >> > We can also tell CPython to not create that directory at all. I'll run > > > >> > some tests to see what the effect is on the documentation build times; > > > >> > I'm guessing it will not be huge... > > > >> > > > >> I do not build documentation at all, it's just a regular code build that leaves > > > >> tree dirty. > > > >> > > > >> $ python3 --version > > > >> Python 3.13.2 > > > >> > > > >> It's standard Debian testing distribution, no customisation in the code. > > > >> > > > >> To reproduce. > > > >> 1) I have just done a new build to reduce the churn, so, running make again does nothing; > > > >> 2) The following snippet in shell shows the issue > > > >> > > > >> $ git clean -xdf > > > >> $ git status --ignored > > > >> On branch ... > > > >> nothing to commit, working tree clean > > > >> > > > >> $ make LLVM=-19 O=.../out W=1 C=1 CF=-D__CHECK_ENDIAN__ -j64 > > > >> make[1]: Entering directory '...' > > > >> GEN Makefile > > > >> DESCEND objtool > > > >> CALL .../scripts/checksyscalls.sh > > > >> INSTALL libsubcmd_headers > > > >> .pylintrc: warning: ignored by one of the .gitignore files > > > >> Kernel: arch/x86/boot/bzImage is ready (#23) > > > >> make[1]: Leaving directory '...' > > > >> > > > >> $ touch drivers/gpio/gpiolib-acpi.c > > > >> > > > >> $ make LLVM=-19 O=.../out W=1 C=1 CF=-D__CHECK_ENDIAN__ -j64 > > > >> make[1]: Entering directory '...' > > > >> GEN Makefile > > > >> DESCEND objtool > > > >> CALL .../scripts/checksyscalls.sh > > > >> INSTALL libsubcmd_headers > > > >> ... > > > >> OBJCOPY arch/x86/boot/setup.bin > > > >> BUILD arch/x86/boot/bzImage > > > >> Kernel: arch/x86/boot/bzImage is ready (#24) > > > >> make[1]: Leaving directory '...' > > > >> > > > >> $ git status --ignored > > > >> On branch ... > > > >> Untracked files: > > > >> (use "git add ..." to include in what will be committed) > > > >> scripts/lib/kdoc/__pycache__/ > > > >> > > > >> nothing added to commit but untracked files present (use "git add" to track) > > > > > > > > FWIW, I repeated this with removing the O=.../out folder completely, so it's > > > > fully clean build. Still the same issue. > > > > > > > > And it appears at the very beginning of the build. You don't need to wait to > > > > have the kernel to be built actually. > > > > > > kernel-doc gets run on source files for W=1 builds. See Makefile.build. > > > > Thanks for the clarification, so we know that it runs and we know that it has > > an issue. > > Ideal solution what would I expect is that the cache folder should respect > the given O=... argument, or disabled at all (but I don't think the latter > is what we want as it may slow down the build). From: https://github.com/python/cpython/commit/b193fa996a746111252156f11fb14c12fd6267e6 and: https://peps.python.org/pep-3147/ It sounds that Python 3.8 and above have a way to specify the cache location, via PYTHONPYCACHEPREFIX env var, and via "-X pycache_prefix=path". As the current minimal Python version is 3.9, we can safely use it. So, maybe this would work: make O="../out" PYTHONPYCACHEPREFIX="../out" or a variant of it: PYTHONPYCACHEPREFIX="../out" make O="../out" If this works, we can adjust the building system to fill PYTHONPYCACHEPREFIX env var when O= is used. Regards, Mauro