From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 25BBDC4332F for ; Sat, 17 Dec 2022 19:37:11 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 77A2385377; Sat, 17 Dec 2022 20:37:09 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; secure) header.d=gmx.de header.i=@gmx.de header.b="qhsGPYei"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id DF66E8537A; Sat, 17 Dec 2022 20:37:07 +0100 (CET) Received: from mout.gmx.net (mout.gmx.net [212.227.15.19]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 0C6F785237 for ; Sat, 17 Dec 2022 20:37:05 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=xypron.glpk@gmx.de DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.de; s=s31663417; t=1671305820; bh=pQD3X+H9jRlCn3Hvv3fjVYg/qNh6lhiJXEahgJ/Fppc=; h=X-UI-Sender-Class:Date:Subject:To:Cc:References:From:In-Reply-To; b=qhsGPYeiZRncxQaSrwt+LWgRAvmafTRTkg/KBZB/4m2NlCdqKP0z67LXdGhmMSZuV GjRAHT72GMVFhfUkFOUd+5Ex7ZpWxtYyoplZStAoPJmINJv+0KT5eWv5IdPOad/zKT V3QaPPWPODoHXO++kS2+egxtYOUj72/67liHAMRwRTERLs5u5UF/ZWzNeaZ7Ynmbt/ bof3iYZ7hgwjVFlz0nCgatN9Yn/SdM6k67HHCjRloSMGSCoKpFgxR19Mo8zKhcVbCw Y6+jDEhWoIW8n3z66arnhmnkMJyLWfd5RavoO90OYXfRvw0dDl48m387GN6lKdk59+ /Z69fv0pob2ww== X-UI-Sender-Class: 724b4f7f-cbec-4199-ad4e-598c01a50d3a Received: from [192.168.123.94] ([88.152.145.137]) by mail.gmx.net (mrgmx004 [212.227.17.190]) with ESMTPSA (Nemesis) id 1MpUUw-1oYgHn3Elw-00pwrF; Sat, 17 Dec 2022 20:36:59 +0100 Message-ID: <14fd390e-5b0b-e6e4-cc7e-7a22048a344c@gmx.de> Date: Sat, 17 Dec 2022 19:36:54 +0000 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.6.0 Subject: Re: [PATCH] doc: add texinfodocs and infodocs targets To: Maxim Cournoyer Cc: u-boot@lists.denx.de, Maxim Cournoyer , =?UTF-8?Q?Marek_Beh=c3=ban?= , =?UTF-8?Q?Pali_Roh=c3=a1r?= , Quentin Schulz , Simon Glass , Tom Rini References: <20221217025137.2514-1-maxim.cournoyer@savoirfairelinux.com> <112c5967-ae51-7312-0534-9bb01d9ef404@gmx.de> <87cz8i587m.fsf@gmail.com> Content-Language: en-US From: Heinrich Schuchardt In-Reply-To: <87cz8i587m.fsf@gmail.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: quoted-printable X-Provags-ID: V03:K1:KQIAO26bH+IPNvv2o+sNq/wNZWHLRQ+CbxyH+Epv5SJSg8O/gn7 pfWjDh4lsIAm/pmMsqpDz0lahMWzcb4ArmziVycEXhoBlqd4IvkD5u6aqPbisLrtOzSGlDf +Ytt2lxWjnegsrpz0HZBkLPmhQ+HrnqjDONTTh7a4gSBJhnWAyE6kFzev/DeNB5a2NrOb7k 5qwtwCPYJY17VnC5qqY7g== UI-OutboundReport: notjunk:1;M01:P0:I8VzNTOWUYE=;cGU94p8YTC61KxlKX+GctJU1O7t 1D9DSDwfvULs/G3kQmzwty9O8rWT9pWEiPHdBnZHa6OqmB+now2Bgu0oS38B/uTdRt6UW3LAb Y+gH+pkW6qmhkl0oSffWSGPzvqu3TmzfvV/SDtNxsu71/xaUNbibpZYtPIAIavKHpIkwQsy+f vN1vbNcMZqEKDkoWtUUXz4/5SmmjcPSTIpQQhwjJFIQ+4OAtp/1yI2T9eq/AL7J69xhY6YSYA nSnrTYndPajOd22h0/GyBMRaKPJVcVefr1s9QaSrP8LYcl6wgaspQ9bx5q64Ky70NT6ON7yQ7 BlLt5AAX7mIWFKi/JcXWvXyymJSA8g4wNZfkKlxfLhOovwdrxeFOo0f8SVX1oDRKAS2cXAWeh fadnWZPcU0aIeupDH2WOcCnKsRzyR8BPfJ9dutDY6fp1b28YliCfj1CPfE4RaRBTp7h4vNJZ8 /uD3I0VdRPt8mLD5DrMV8bDTExon1bC60AOmw4HmXfOzsh5SWcBJY+mTZJwvzBce1IbSWBrIl xGRNc69qa2w3ceMW1sm5n7wAhqgTIu2nVjyQ4/rdoDNtq4FuPVYuN8hJaY4beZN296FZAt2zj giJRc6f+ISUSoOm2Z8SuKwLYOun7c2DGJw6cKZ/7lV7+mQz42ff0E6OijaFafMGKakAZIevUb 3z4V09UCdKSHGB2HbuQIFTeEkRfLMEV3uwrgLA+x2FMVa+hLwps4fw5156w/9YfOaRiERLA71 Xrv1YM+DyF/NpA4UfgF1FxNJcQRO7C3MAYiBsOfStwGERlSAJl334xLYk6wVVjz79b2mMTLqi fdmEXfTuVS04/JjqrEoZNCpwg8Gxr9zZQ54W/rBYO7P3a9J2ANXLVSx8F6AP947rAz1ip3opl 3llFpB97tVSH0J3ChAnwFPtqVGsQmn2kaQy1SNKmKZQYEFBdc7pplUdwqIH3EvOt0YN+6LYWM cAnZTurWSPSXx9vaAdop+YH7+V8= X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.6 at phobos.denx.de X-Virus-Status: Clean On 12/17/22 16:02, Maxim Cournoyer wrote: > Hi Heinrich, > > Heinrich Schuchardt writes: > >> On 12/17/22 02:51, Maxim Cournoyer wrote: >>> Sphinx supports generating Texinfo sources and Info documentation, >>> which can be navigated easily and is convenient to search (via the >>> indexed nodes or anchors, for example). This is basically the same as >>> 1f050e904dd6f2955eecbd22031d912ccb2e7683, which was recently applied >>> to the Linux kernel. >>> >>> Signed-off-by: Maxim Cournoyer >>> --- >>> >>> Makefile | 2 +- >>> doc/Makefile | 11 +++++++++++ >>> doc/media/Makefile | 3 ++- >>> 3 files changed, 14 insertions(+), 2 deletions(-) >>> >>> diff --git a/Makefile b/Makefile >>> index de5746399a..597a8886c3 100644 >>> --- a/Makefile >>> +++ b/Makefile >>> @@ -2372,7 +2372,7 @@ tcheck: >>> # Documentation targets >>> # -----------------------------------------------------------------= ---------- >>> DOC_TARGETS :=3D xmldocs latexdocs pdfdocs htmldocs epubdocs cleand= ocs \ >>> - linkcheckdocs dochelp refcheckdocs >>> + linkcheckdocs dochelp refcheckdocs texinfodocs infodocs >>> PHONY +=3D $(DOC_TARGETS) >>> $(DOC_TARGETS): scripts_basic FORCE >>> $(Q)$(MAKE) $(build)=3Ddoc $@ >>> diff --git a/doc/Makefile b/doc/Makefile >>> index f5de65e927..62effd0fec 100644 >>> --- a/doc/Makefile >>> +++ b/doc/Makefile >>> @@ -69,6 +69,15 @@ quiet_cmd_sphinx =3D SPHINX $@ --> file://$(abspat= h $(BUILDDIR)/$3/$4) >>> htmldocs: >>> @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,= $(var))) >>> >>> +texinfodocs: >>> + @$(srctree)/scripts/sphinx-pre-install --version-check >>> + @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),= texinfo,$(var))) >>> + >>> +# Note: the 'info' Make target is generated by sphinx itself when >>> +# running the texinfodocs target defined above. >>> +infodocs: texinfodocs >>> + $(MAKE) -C $(BUILDDIR)/texinfo info >>> + >>> linkcheckdocs: >>> @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(va= r),,$(var))) >>> >>> @@ -109,6 +118,8 @@ cleandocs: >>> dochelp: >>> @echo ' U-Boot documentation in different formats from ReST:' >>> @echo ' htmldocs - HTML' >>> + @echo ' texinfodocs - Texinfo' >>> + @echo ' infodocs - Info' >> >> This does not work: >> >> $ make infodocs >> make[1]: ./scripts/sphinx-pre-install: No such file or directory > > Good catch; this is not a problem introduced by the new targets, I think > (already in the Makefile -- it must happen for other documentation > targets too, no?). I'll look into it. make htmldocs is what we rely on to generate https://u-boot.readthedocs.io. This works fine. Best regards Heinrich > > The reason I overlooked this was that I'm already patching out the > 'sphinx-pre-install' script invocation in the to-become > 'u-boot-documentation' Guix package, as that was problematic in the > Linux tree, which uses the same build system (I forgot why exactly, > perhaps it used sudo or wanted to setup its own virtualenvs). >