From nobody Thu Oct 2 06:14:49 2025 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 DEADE247291; Sun, 21 Sep 2025 09:13:43 +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=1758446024; cv=none; b=p/Fy2CzKfNKsHXazGrNUPVaCwGdGOsvf9mLthT5jZlaI/GlcT19hYT+ggM6P6P1nO05o4ltk25qK6eFEyCICgDNhNd2TpO0P6Lgnn3JJvQN9rTeU74LIHIidO2BK548+prcq/Fgaah2gkiHU5YWbNGtbYyxMpmVEhRQfThuGPSs= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758446024; c=relaxed/simple; bh=qtWjq2u9Fz9LWQsKY5HbV/3WErrU5ohWZJS1W0AyBoo=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=doL5iTXkRe6w6ymJlAUINftF3Fw++ZyrHrmTtwDcrKs7TFPD9TCX4RNrROspRaYMkJiDmC6ilZVryEqSHGABjklwZ+UU1tJ4QmLWFGXG0EVgBVvXlBW1aG5BCPweeAgC3xO500lg80hPHfIz8lhXkQOwewumQm0T9mXweHNIBM0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=DzmkkGtw; 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="DzmkkGtw" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 7D0ECC4CEE7; Sun, 21 Sep 2025 09:13:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1758446023; bh=qtWjq2u9Fz9LWQsKY5HbV/3WErrU5ohWZJS1W0AyBoo=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DzmkkGtwmx+MgXwzuo1cUHVBxl7FhCVbHK4/Zmyf3Lghh3q8URwGpQHgCcrWgdi7h qQIxid75RgatbwynS5glKMSdb5pvp+oYRUjq+KeHOuAW+j99I1xZi5mVDi9pBzoZBH nVhLpRsGimMgx7M9Sv2GBLaeKSwlWEFlXMzkc+0FRiFx7jKtcyllN2104AEYlN8ugv rB4NpNYAA+qwVeeo5y/ko6+8cnNiv/CFxMxjPHQgeKF6eZN51gcRMHwL+W1hMO7E/2 hhnlRCH5Q1r0P+AdSGAC3UjhKIKgnjApUafyxH3O58zRUV/hXAOBJGgR02UhQh5O1O wI8j8w4bu+DTQ== Received: from mchehab by mail.kernel.org with local (Exim 4.98.2) (envelope-from ) id 1v0G8b-00000005CWE-21XV; Sun, 21 Sep 2025 11:13:41 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Jonathan Corbet Cc: Mauro Carvalho Chehab , "Akira Yokosawa" , "Mauro Carvalho Chehab" , linux-kernel@vger.kernel.org Subject: [PATCH 1/1] tools/docs/sphinx-build-wrapper: allow skipping sphinx-build step Date: Sun, 21 Sep 2025 11:13:25 +0200 Message-ID: <10e440eafe6bf00cbc9f50df66fd7516b6f92769.1758444913.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.51.0 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab Content-Type: text/plain; charset="utf-8" Most targets have two steps: - step 1: run sphinx-build; - step 2: run a post-build logic. The second step can be as simple as copying static files like CSS, but may may also envolve running make. allowing to skip the first step helps debugging what's broken, and also allows using make command line arguments like --ignore-errors. Add an option to skip step 1. Requested-by: Akira Yokosawa Link: https://lore.kernel.org/linux-doc/5031e0c4-f17e-41b8-8955-959989e797f= 2@gmail.com/ Signed-off-by: Mauro Carvalho Chehab --- tools/docs/sphinx-build-wrapper | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/tools/docs/sphinx-build-wrapper b/tools/docs/sphinx-build-wrap= per index bd8e2ed746e7..1f9c66ab33fe 100755 --- a/tools/docs/sphinx-build-wrapper +++ b/tools/docs/sphinx-build-wrapper @@ -603,7 +603,8 @@ class SphinxBuilder: shutil.rmtree(self.builddir, ignore_errors=3DTrue) =20 def build(self, target, sphinxdirs=3DNone, - theme=3DNone, css=3DNone, paper=3DNone, deny_vf=3DNone, rust= doc=3DFalse): + theme=3DNone, css=3DNone, paper=3DNone, deny_vf=3DNone, rust= doc=3DFalse, + skip_sphinx=3DFalse): """ Build documentation using Sphinx. This is the core function of this module. It prepares all arguments required by sphinx-build. @@ -625,9 +626,10 @@ class SphinxBuilder: # # Other targets require sphinx-build, so check if it exists # - sphinxbuild =3D shutil.which(self.sphinxbuild, path=3Dself.env["PA= TH"]) - if not sphinxbuild and target !=3D "mandocs": - sys.exit(f"Error: {self.sphinxbuild} not found in PATH.\n") + if not skip_sphinx: + sphinxbuild =3D shutil.which(self.sphinxbuild, path=3Dself.env= ["PATH"]) + if not sphinxbuild and target !=3D "mandocs": + sys.exit(f"Error: {self.sphinxbuild} not found in PATH.\n") =20 if builder =3D=3D "latex": if not self.pdflatex_cmd and not self.latexmk_cmd: @@ -713,7 +715,7 @@ class SphinxBuilder: =20 if target =3D=3D "mandocs": self.handle_man(kerneldoc, docs_dir, src_dir, output_dir) - else: + elif not skip_sphinx: try: result =3D self.run_sphinx(sphinxbuild, build_args, env=3Dself.env) @@ -795,6 +797,9 @@ def main(): parser.add_argument('-i', '--interactive', action=3D'store_true', help=3D"Change latex default to run in interactive= mode") =20 + parser.add_argument('-s', '--skip-sphinx-build', action=3D'store_true', + help=3D"Skip sphinx-build step") + parser.add_argument("-V", "--venv", nargs=3D'?', const=3Df'{VENV_DEFAU= LT}', default=3DNone, help=3Df'If used, run Sphinx from a venv dir (defa= ult dir: {VENV_DEFAULT})') @@ -810,7 +815,8 @@ def main(): =20 builder.build(args.target, sphinxdirs=3Dargs.sphinxdirs, theme=3Dargs.theme, css=3Dargs.css, paper=3Dargs.paper, - rustdoc=3Dargs.rustdoc, deny_vf=3Dargs.deny_vf) + rustdoc=3Dargs.rustdoc, deny_vf=3Dargs.deny_vf, + skip_sphinx=3Dargs.skip_sphinx_build) =20 if __name__ =3D=3D "__main__": main() --=20 2.51.0