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 D5D921E5B71; Tue, 2 Sep 2025 11:55:27 +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=1756814128; cv=none; b=XGR8shYEgD47Lb86L+P4ETmY9ePuMpE7hOycb148kP++2U9Dv2Nys5ng7Qf88wxUffPtc2gFNHvKP6qmRHRloKll0KIbHyBd60b4BwioY261ls3vz5e/5TGJwbnyE1IzD2SVHHMZ9rSp8jDS0Z6N7Xq0Ez7CcS9+L/NHbN7fVPU= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756814128; c=relaxed/simple; bh=gSqWkTJBO56jPr151Fe/ahxA7INrL55vY30gRenSK2Q=; h=Date:From:To:Cc:Subject:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=UdCXgtUj1fnMkJ8pBkYinXsmB4qJizU5a+pThxGLmtuz/tk/gpoJCsr6Z4o81MgrZMC/Ec9JBNaFWcxyoTFJnLS9zxjOIbiZiFYUEIuOLDK3vrgv99wJb1iqCF6SIf6VkhIBuWNHDzvov6Ah/VLgc6H5UgYG023nDbJ4/dbjXv8= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=ef+7awhL; 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="ef+7awhL" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 03639C4CEF7; Tue, 2 Sep 2025 11:55:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1756814127; bh=gSqWkTJBO56jPr151Fe/ahxA7INrL55vY30gRenSK2Q=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=ef+7awhLqj0A5ooej8L1IdethLMOVqudtnp9KIEnzf7d9FvZMX2EStM25+ve/jCGO CpRmQ8i+5/2FStJRcLRCPh8XBWd4enaiUNY0XnZVCHb6ml4EDJfB0herX6IssfOTC0 KKx6uQ3vF0AoH+K+yw/KfDGcXOoaKWJ4+vlG4SiJR8yoOHDDr8/v2FB95sCvSOQ/Zg 87iSv1GOfXvjksz4rrHeOHw7iRMU2rY6doBAhTdAXJ0Nd9Fn4L/thm/JqPiIhe+sGL oIsRt2VnX+P8ziVKALnKcjOaE1qZ3Cm38zBP+/MyWxkfou5QMR6Od27MhFhnKP8Ema 8yx0+U5trEiIg== Date: Tue, 2 Sep 2025 13:55:21 +0200 From: Mauro Carvalho Chehab To: Jani Nikula Cc: Randy Dunlap , Jonathan Corbet , Laurent Pinchart , Vegard Nossum , ksummit@lists.linux.dev, Linux Documentation , Mauro Carvalho Chehab , Akira Yokosawa , Bagas Sanjaya , Matthew Wilcox Subject: Re: [TECH TOPIC] Kernel documentation - update and future directions Message-ID: <20250902135521.51482530@foz.lan> In-Reply-To: References: <87plcndkzs.fsf@trenco.lwn.net> <20250828230104.GB26612@pendragon.ideasonboard.com> <87wm6l0w2y.fsf@trenco.lwn.net> <930d1b37-a588-43db-9867-4e1a58072601@oracle.com> <20250830222351.GA1705@pendragon.ideasonboard.com> <87h5xo1k6y.fsf@trenco.lwn.net> <20250831160339.2c45506c@foz.lan> X-Mailer: Claws Mail 4.3.1 (GTK 3.24.49; 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, 02 Sep 2025 13:42:45 +0300 Jani Nikula escreveu: > On Mon, 01 Sep 2025, Randy Dunlap wrote: > > ISTM that there are lots of non-docs developers who either just don't care > > about that or never run 'make W=1 htmldocs' to see the problems in their > > drivers or subsystems. OK, maybe it's just a very low priority for them. > > > > Willy had a suggestion that we just make checking kernel-doc during > > all .c builds a permanent feature instead of a W=1 option. > > This helps, but still doesn't force 'make htmldocs' to be run. > > > > And it causes around 450 build warnings in my testing of an x86_64 allmodconfig > > build. > > I think in general the build system lacks proper support for subsystems > or drivers being ahead of the curve in keeping them W=1 or kernel-doc > -Wall clean. It is trivial to add a spinx/kerneldoc parameter to allow setting -Wall per each .. kernel-doc markup. Yet, one would need to add it for every markup within the subsystem. It is probably easier to do something similar to that via a CI. > > We hack around this in parts of drm Makefiles, and it really has helped > to keep the kernel-doc and W=1 breakage/fix churn down. But it's not > pretty. > > > BR, > Jani. > Thanks, Mauro