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 25AE42AF16; Fri, 14 Feb 2025 02:25:06 +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=1739499907; cv=none; b=M6Ngd0rYSRQV+QMXMcE1BiKZsPZOIlWr5InQwh0YsTVCkQFQZecsKDtTmjcVcQBqh4CBUnu6j3vQR4LsANvATkes9I6i14GpXordTB22+6dLBj9aol9Bh/sGnfoH+2qcRFwQdc/hubFWo3tR6G5BaZCxo01xNbPGbK5cfCkQJIU= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739499907; c=relaxed/simple; bh=Z6DGSCB3WS833S/uhOUTmiOjUXJ0YGRt01DkitcHLwM=; h=Date:From:To:Cc:Subject:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=M/bD/wHwctG9hQzSHdM0vtH9cW6+du1G/DA9kU8U9KISBiSMzPFHQ7gLRF3aE+y2VmVBJzB71ywHZ6vIGBrldB+3a/TFU/g0+TsUmHZd91NXKEt/NgeOt+8fFZa2iR/GCCwz4P2G0pf1JwCVu0sGGRhpWgtQBYyAuQBw2UGu0s0= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=dXYIY680; 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="dXYIY680" Received: by smtp.kernel.org (Postfix) with ESMTPSA id BA9FDC4CED1; Fri, 14 Feb 2025 02:25:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1739499906; bh=Z6DGSCB3WS833S/uhOUTmiOjUXJ0YGRt01DkitcHLwM=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=dXYIY680jj1PYNQ9zGGqc1G4ZxDUBjQnvqNidNfdCJ5sEA1zjaVwFZU1DMJeTTpWs 0Z6cATMzF9L8zFUdpwjT3mVi7N0Zq8DX6gia6+H+ETwQtuwKZEBiTTO2zWYj6pQNBo HPTPufHKHlgIK7yPVXxNiNVZA0qLMphx6LcikiZ/q6egV0CwCibVpzzJcMkpAbZuif +jNtcq6apOR9UgOn7QEfORebng8r5Y5SFcMF3fjwAob/9gox+g9VpcDFGUKp9GwUHf XIwgoedwx+CuDvFMw1s16toDQgmPEqkbLOVr8k7X0zRMWsF+lOb+gRJpGujKQT95vl hR8Bj7agXwxPA== Date: Fri, 14 Feb 2025 03:24:57 +0100 From: Mauro Carvalho Chehab To: Jonathan Corbet Cc: Linux Doc Mailing List , linux-kernel@vger.kernel.org Subject: Re: [PATCH] scripts/kernel-doc: remove an obscure logic from kernel-doc Message-ID: <20250214032457.6444ee93@foz.lan> In-Reply-To: <87wmdt6bv5.fsf@trenco.lwn.net> References: <87wmdt6bv5.fsf@trenco.lwn.net> X-Mailer: Claws Mail 4.3.0 (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: quoted-printable Em Thu, 13 Feb 2025 09:35:58 -0700 Jonathan Corbet escreveu: > Mauro Carvalho Chehab writes: >=20 > > Kernel-doc has an obscure logic that uses an external file > > to map files via a .tmp_filelist.txt file stored at the current > > directory. The rationale for such code predates git time, > > as it was added on Kernel v2.4.5.5, with the following description: > > > > # 26/05/2001 - Support for separate source and object trees. > > # Return error code. > > # Keith Owens > > > > from commit 396a6123577d ("v2.4.5.4 -> v2.4.5.5") at the historic > > tree: > > https://git.kernel.org/pub/scm/linux/kernel/git/history/history.git/ > > > > Support for separate source and object trees is now done on a different > > way via make O=3D. > > > > There's no logic to create such file, so it sounds to me that this is > > just dead code. > > > > So, drop it. > > > > Fixes: 1da177e4c3f4 ("Linux-2.6.12-rc2") > > Signed-off-by: Mauro Carvalho Chehab > > --- > > scripts/kernel-doc | 19 +------------------ > > 1 file changed, 1 insertion(+), 18 deletions(-) =20 >=20 > Weird ... I went and looked, and can't find anything that ever created > that tmp_filelist.txt file; I wonder if this code ever did anything? I wonder the same ;-) Anyway, better to remove this now, as, if people complain, it would be easier to revert than after switching to the Python version. > Don't put that functionality into the Python version :) Yeah, I started implementing it, but it sounded a waste of time, so I dropped it from the RFC versions. It sounded too complex for people to maintain a separate tmp file when make O=3Ddir would do it on a much better and automated way. - With regards to the Python transition, since our Makefile allows switching to a different script since ever[1], I'm playing with=20 the idea of sending a patch series with: Patch 1:=20 - drops Sphinx version check from both kerneldoc=20 (-sphinx-version parameter) and the corresponding Sphinx extension; patch 2:=20 - renames kerneldoc to kerneldoc.pl - creates a symlink: kerneldoc.pl -> kerneldoc patch 3: - adds kerneldoc.py: patch 4: - add info messages on both versions related to the transition, and instructions about using KERNELDOC=3D