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 437A0C4332F for ; Sat, 17 Dec 2022 13:28:14 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id D6AD385175; Sat, 17 Dec 2022 14:28:11 +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="VS3VcSTv"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id AF7BD84E00; Sat, 17 Dec 2022 14:28:10 +0100 (CET) Received: from mout.gmx.net (mout.gmx.net [212.227.17.21]) (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 4B29A851D8 for ; Sat, 17 Dec 2022 14:28:08 +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=1671283676; bh=tQUKXdTuEeZbxO9V+G8ruEizl5q0wSyXO4RniJxxN2k=; h=X-UI-Sender-Class:Date:Subject:To:Cc:References:From:In-Reply-To; b=VS3VcSTvqMYFmYq9PaXHiayPiJpTK/XpTbrOCst+ueFqLbMEft5430vW3QxkC/NW5 4Ke82Kd5sDqlesw6yeXK50LI9yc0VxFWwoNRWq05xkNdfJmObHf17lrzme07JHYtc7 x2uhTBG5NDuN8rPCQaS+tnT9gbgUP3qNxdgBPL3cmQcSHS/0CbmdSp7Nehh2QOWZgt 0mkF/Uuq1UL119S49gxduOj4Kf7oygltUA19J67El2TgSlPGI+tE7QkXdx0eRlj+Kw vbNRNU3QmA/buWqlt9mFGH2CCj1h2CMw2vl4SIDqY24o30HzZcRPajYYwPxBE+Ctqt /iu+eD71uMfDQ== X-UI-Sender-Class: 724b4f7f-cbec-4199-ad4e-598c01a50d3a Received: from [192.168.123.94] ([88.152.145.137]) by mail.gmx.net (mrgmx104 [212.227.17.168]) with ESMTPSA (Nemesis) id 1MacOQ-1oVYW603Uw-00cBn9; Sat, 17 Dec 2022 14:27:56 +0100 Message-ID: <112c5967-ae51-7312-0534-9bb01d9ef404@gmx.de> Date: Sat, 17 Dec 2022 13:27:52 +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 Content-Language: en-US To: Maxim Cournoyer , u-boot@lists.denx.de Cc: Maxim Cournoyer , Heinrich Schuchardt , =?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> From: Heinrich Schuchardt In-Reply-To: <20221217025137.2514-1-maxim.cournoyer@savoirfairelinux.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: quoted-printable X-Provags-ID: V03:K1:cDroTjJ16SGCieF9RFuZmquEpJkKAqJ2IM9TOVhCkotCQwXuSjt ZDy+6FCA0hF2sCklEIzwyecil19Prpf8eKcY53nvrD5k7YwReofd/Mbly1FSiJY6aliYAm5 QQlkszC5LYy3I/PRzMzrSv6mzxWZaGTsp5s+7dWMa4IJaTPfOWc3qnlJUdE1CXj1qRu60sr gyCgmGf795EmrZNZ5KmfQ== UI-OutboundReport: notjunk:1;M01:P0:z0PhxFEpDTs=;5s+kL/Uu8FWmDfgawcFMgx5p6r1 D2PM0bGO8XuFf8nSbofRjTlMdQ6kcxemjigIXX9Nnl2n6IXZk5zV4BqPEsTysI5OQYSsMqvN+ Xb9CbdNFVbmGii73mWdNN4VtWLZOL9eqDwYfIk4oL34kBTWkzjanzGGoET7hI0HZ+Yn8CSSvL kJfb+RYzQYirJ6u0VmEkgUEqvn4tq74GZWK2SYuHeI0aI0toZnnKfR95SFPKxZoxvADjfiQVo Qn5J1CIUlvqoB86D5oK7f8DXWYM4l69Qm4A2aU+wDqmp/6HiH72kCbLIYiAkRLJAlCaP+Lz45 t9UOQdfvPlHrvUDiLDHXMwfelRDok3x62ufdlMXC3hYvgGZB8xAkL6tTVenPtlAhrBrQq4Ds5 RWK+qbIMdbo6CIZ/G8Zfs6tjk7JxlotU5vlfwLO2VamngvnX25z6POVIgMXj1vnBiFk32/8lA ORT3M2MoU1xj8N+g9jsPEhsrLFbRJnveRZ0r9pOt9VMWQuTYr7hfPQpoPOjmkX9tGSuRsnaDJ vyCJSIEC5srGZP2iuUdH+UDDpY7g46CTB68sAghV+/kp0M98YSu69a779tmM0Jk/Po4v1kNJF DFsnLH+DMugEsGqxH0mmhuCvldzOQcI3BqBTxYKOO/U+iLkl0Xp/bqYpb/6cIFoYQyw5Ohe7I XXU7iH/OjWVV37Hl6IAjtqu+h2N3Um4yPGvjoXXcCTnCTVYgg2B3W11xnjSfjkSWmmFbczpPM Vb00e1iksrMqV1KAQHEHIn50mF1tI9JWeFg8mJsYAwJxBPMM+ye082PNvwp/aORAGVpFD+1M8 IDj+U1puyB6smUgH3bI+xwsarQu3YFJLDGN2wNVpCgpglGpBRXf10D3y9hSkxnBjZgUzQSHSL mjn1fHt+rbJhZansJAejkJod+yB+d2z87RxxKileawkNQSQkUfdpwDcI2Lt0PpBNN+rX2BSxT z08PTrW0kSnwrUb8TPintRX1IxM= 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 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 cleandocs= \ > - 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://$(abspath = $(BUILDDIR)/$3/$4) > htmldocs: > @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(v= ar))) > > +texinfodocs: > + @$(srctree)/scripts/sphinx-pre-install --version-check > + @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),te= xinfo,$(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,$(var),= ,$(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 $ make texinfodocs make[1]: ./scripts/sphinx-pre-install: No such file or directory make[1]: *** [doc/Makefile:73: texinfodocs] Error 127 make: *** [Makefile:2378: texinfodocs] Error 2 @Tom: Should we add a build step for each of the new targets to .gitlab-ci.yml and .azure-pipelines.yml? Best regards Heinrich > @echo ' latexdocs - LaTeX' > @echo ' pdfdocs - PDF' > @echo ' epubdocs - EPUB' > diff --git a/doc/media/Makefile b/doc/media/Makefile > index b9b43a34c3..9b32258696 100644 > --- a/doc/media/Makefile > +++ b/doc/media/Makefile > @@ -22,10 +22,11 @@ $(BUILDDIR)/linker_lists.h.rst: ${API}/linker_lists.= h ${PARSER} $(SRC_DIR)/linke > > # Media build rules > > -.PHONY: all html epub xml latex > +.PHONY: all html texinfo epub xml latex > > all: $(IMGDOT) $(BUILDDIR) ${TARGETS} > html: all > +texinfo: all > epub: all > xml: all > latex: $(IMGPDF) all > > base-commit: 9bd3d354a1a0712ac27c717df9ad60566b0406ee