From patchwork Sat Dec 17 02:51:37 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Cournoyer X-Patchwork-Id: 1716883 X-Patchwork-Delegate: xypron.glpk@gmx.de Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.denx.de (client-ip=85.214.62.61; helo=phobos.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20210112 header.b=Rf4cwL0R; dkim-atps=neutral Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384)) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4NZ4kr3BQPz23yr for ; Sat, 17 Dec 2022 23:18:44 +1100 (AEDT) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 4400585381; Sat, 17 Dec 2022 13:17:52 +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="Rf4cwL0R"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 9595285225; Sat, 17 Dec 2022 03:56:05 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM,SPF_HELO_NONE, SPF_PASS autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-qv1-xf34.google.com (mail-qv1-xf34.google.com [IPv6:2607:f8b0:4864:20::f34]) (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 11DC384E8F for ; Sat, 17 Dec 2022 03:56:02 +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-qv1-xf34.google.com with SMTP id a17so2831734qvt.9 for ; Fri, 16 Dec 2022 18:56:01 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=3rrBD3pjXDwmpneB5HwuEPAIhFfHBYGZkoo5iDAM3WA=; b=Rf4cwL0R5G4SdF+1WnmI2W9d4SjNg7XrlVfwr2gF2/cQ657tBcBnK193ICGoYFFOLg mPchJkGgs93EbYap7x4fUk1eMIy7CoacnzWJB/poJ7GcSUfK1Anc84/YPkMlteXn4A1X RkK0ITxoO7M0rdCOM2S8ImDelKn6xbhFF6hy+usK47ja0O9SqS3IVIv3Od7tcACil94n 2B8ieOSAA6auNTtlJBrdr0mk1JD+rg42eFiKaV3rOagx8OJ2htUzD1IeQCMIi/6yFFM0 mhXIB2bgp2yEtJu+w9iPWkhKpSBa8UlaStH3rhMJ0okT2NkITOj4sgNknGS8j824hySW SBBg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=3rrBD3pjXDwmpneB5HwuEPAIhFfHBYGZkoo5iDAM3WA=; b=a1AL8z+FXjJUFUepw7nHuU1EK7IMNkHdZT82y3o6imxY7f83nOr0hAT2sKcn756gDQ vN+HvLU3Sgo+5NdMMDdPacKQoDlk1N/0O6a7hefGJV/txTeTI+dIYkOp8kbGz4rrVrwq QamPeWIK3UyCQteR8ceCZ/iUjNflrUR4C7JrRXU7CXM4DhQiqaq2tPSwN3k8UbQJhBuq 0IAIWjcBlaqVKC4G/XKPGsXSs7zh5PEaeMAJbA3nlPjMS1BwIgWSCrOzxx97cer0Snhb BevYMzBVh/h3vTYXHcjf4zpWzsS2lBABeqpCSecj/hk0/kYYIoDS5na7LuDxWZbJ/eE9 q1fQ== X-Gm-Message-State: ANoB5pnMc/kPdmbFnA7fDbsyo7rdBVm3sAo9MXkLxCfJ8xXeqev5aR+j VopJJ0YvGgX53vK6IhCZ5Y2AEoB+csIMMHvj X-Google-Smtp-Source: AA0mqf4rMM8YKPPbcrp7uskDgTO4W9XyIjFs8sjkPBuL45cKbt39NllQ2xfixNRMAViYObuKpMeAWQ== X-Received: by 2002:a0c:e902:0:b0:4de:83db:b84a with SMTP id a2-20020a0ce902000000b004de83dbb84amr29501607qvo.15.1671245760431; Fri, 16 Dec 2022 18:56:00 -0800 (PST) Received: from localhost.localdomain (dsl-159-157.b2b2c.ca. [66.158.159.157]) by smtp.gmail.com with ESMTPSA id r18-20020a05620a299200b006eeb3165565sm2828664qkp.80.2022.12.16.18.55.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Dec 2022 18:56:00 -0800 (PST) From: Maxim Cournoyer X-Google-Original-From: Maxim Cournoyer To: 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 Subject: [PATCH] doc: add texinfodocs and infodocs targets Date: Fri, 16 Dec 2022 21:51:37 -0500 Message-Id: <20221217025137.2514-1-maxim.cournoyer@savoirfairelinux.com> X-Mailer: git-send-email 2.38.1 MIME-Version: 1.0 X-Mailman-Approved-At: Sat, 17 Dec 2022 13:17:33 +0100 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 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(-) base-commit: 9bd3d354a1a0712ac27c717df9ad60566b0406ee 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' @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