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 CF543C4332F for ; Sat, 17 Dec 2022 16:03:01 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 7E95B85373; Sat, 17 Dec 2022 17:02:59 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com 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; unprotected) header.d=gmail.com header.i=@gmail.com header.b="F9kCSFkZ"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 1F17885375; Sat, 17 Dec 2022 17:02:58 +0100 (CET) Received: from mail-qt1-x829.google.com (mail-qt1-x829.google.com [IPv6:2607:f8b0:4864:20::829]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id CC10685362 for ; Sat, 17 Dec 2022 17:02:55 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=maxim.cournoyer@gmail.com Received: by mail-qt1-x829.google.com with SMTP id bw27so2936686qtb.3 for ; Sat, 17 Dec 2022 08:02:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:user-agent:message-id:in-reply-to:date:references :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=lZyaSeIxKENaiN94zYBppVGEF+ca1yEiw4IimamoBK4=; b=F9kCSFkZlUVjDe+pjma6oOev6p/Ox41E0lA1yrTDVR/o5yrcmHRO2C9erpdFeW/2I/ I4TQXC+t3fDMOGT5IOaYZ0CbOe5eiAYn8FklrQyXDZ+0TTKnYqg47yvVebqO1Fil0t1V PguoYDVdAjma5M3shF7ZCAu8Cwi8QB5zebTAP8yRX3/gTJ034MQ76x3j+RbL9yA5LvUk /70mthA7R5OEUFaEFK2i7h1o+0EmOAQuU1iJAY3AKZbKyr1lIJUalZYAGr99X4FPT/vl uycfDLeDs8BuNeg8LpRed9xPtLFMiGeJi9Li/yIIWJX4Qgs2OtNDfLQ1UsOnIHZVC9ez 1jcQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:user-agent:message-id:in-reply-to:date:references :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=lZyaSeIxKENaiN94zYBppVGEF+ca1yEiw4IimamoBK4=; b=kvJFE5mn9FXooj8anPZV5zb7s9sEb1gmDxkZoZGqH1ZEre2cLo/yXU4LSeuezKb+op XY8OZcfUmDiOmacKCpmWuAjhrfhTrf/FylIcyIJrhC41XTJQ1yVtuOvIoIfDSXBUa+hy zBVOp5xqBrsanO5hfxRuTl4TyXYBQW7RRViu5LVyqYqSucE9qViSdgeH/LF/3XFc6WRo D0RhkyWXXwDLlcl4FP36j/wzBe8QKug8uCIu963io5Ee5PqUUnJRewPTPlpeQRR+QqW0 bctvRl8a6Q3KTqC9BYLvml819aLXfOY29/iVKRCX3QziwhI+5liDcQ0GlrKgX1wLMCRn 8IHQ== X-Gm-Message-State: ANoB5pnB3OSlo8RYtJe/AYg0kkisSs3C/fk3Gw6UfPvH51ivGAUHmP5v omm9TgCz07w5MOUk/LipAHg= X-Google-Smtp-Source: AA0mqf5u4ORuwqpKZ+3Ld7oYhsDqjfkzPvb8lyIwikZfGqodL9vzh6ulykAsKmWvsBzsIhw3vsqy4Q== X-Received: by 2002:ac8:58ca:0:b0:3a8:a8e:c0e0 with SMTP id u10-20020ac858ca000000b003a80a8ec0e0mr58756014qta.8.1671292974628; Sat, 17 Dec 2022 08:02:54 -0800 (PST) Received: from hurd (dsl-159-157.b2b2c.ca. [66.158.159.157]) by smtp.gmail.com with ESMTPSA id a12-20020ac84d8c000000b003434d3b5938sm3141052qtw.2.2022.12.17.08.02.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 17 Dec 2022 08:02:54 -0800 (PST) From: Maxim Cournoyer To: Heinrich Schuchardt Cc: u-boot@lists.denx.de, Maxim Cournoyer , Marek =?utf-8?Q?Beh=C3=BAn?= , Pali =?utf-8?Q?Roh=C3=A1r?= , Quentin Schulz , Simon Glass , Tom Rini Subject: Re: [PATCH] doc: add texinfodocs and infodocs targets References: <20221217025137.2514-1-maxim.cournoyer@savoirfairelinux.com> <112c5967-ae51-7312-0534-9bb01d9ef404@gmx.de> Date: Sat, 17 Dec 2022 11:02:53 -0500 In-Reply-To: <112c5967-ae51-7312-0534-9bb01d9ef404@gmx.de> (Heinrich Schuchardt's message of "Sat, 17 Dec 2022 13:27:52 +0000") Message-ID: <87cz8i587m.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain 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 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 := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs \ >> - linkcheckdocs dochelp refcheckdocs >> + linkcheckdocs dochelp refcheckdocs texinfodocs infodocs >> PHONY += $(DOC_TARGETS) >> $(DOC_TARGETS): scripts_basic FORCE >> $(Q)$(MAKE) $(build)=doc $@ >> 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 = SPHINX $@ --> file://$(abspath $(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,$(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 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. 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). -- Thanks, Maxim