mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Carlos Bilbao <carlos.bilbao@amd.com>
To: <corbet@lwn.net>, <ojeda@kernel.org>
Cc: <jani.nikula@linux.intel.com>, <rdunlap@infradead.org>,
	<linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	<konstantin@linuxfoundation.org>,
	<rust-for-linux@vger.kernel.org>,
	"Carlos Bilbao" <carlos.bilbao@amd.com>,
	Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH v8 2/2] docs: Integrate rustdoc generation into htmldocs
Date: Tue, 18 Jul 2023 10:15:34 -0500	[thread overview]
Message-ID: <20230718151534.4067460-3-carlos.bilbao@amd.com> (raw)
In-Reply-To: <20230718151534.4067460-1-carlos.bilbao@amd.com>

Change target `make htmldocs` to combine RST Sphinx and the generation of
Rust documentation, when support is available and .config exists.

Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com>
---
 Documentation/Makefile | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 023fa658a0a8..2f35793acd2a 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -59,6 +59,12 @@ PAPEROPT_letter = -D latex_paper_size=letter
 KERNELDOC       = $(srctree)/scripts/kernel-doc
 KERNELDOC_CONF  = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
 ALLSPHINXOPTS   =  $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
+ifneq ($(wildcard $(srctree)/.config),)
+ifeq ($(CONFIG_RUST),y)
+	# Let Sphinx know we will include rustdoc
+	ALLSPHINXOPTS   +=  -t rustdoc
+endif
+endif
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
@@ -95,6 +101,16 @@ htmldocs:
 	@$(srctree)/scripts/sphinx-pre-install --version-check
 	@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
 
+# If Rust support is available and .config exists, add rustdoc generated contents.
+# If there are any, the errors from this make rustdoc will be displayed but
+# won't stop the execution of htmldocs
+
+ifneq ($(wildcard $(srctree)/.config),)
+ifeq ($(CONFIG_RUST),y)
+	$(Q)$(MAKE) rustdoc || true
+endif
+endif
+
 texinfodocs:
 	@$(srctree)/scripts/sphinx-pre-install --version-check
 	@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),texinfo,$(var)))
-- 
2.34.1


  parent reply	other threads:[~2023-07-18 15:15 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-18 15:15 [PATCH v8 0/2] docs: Integrate rustdoc into Rust documentation Carlos Bilbao
2023-07-18 15:15 ` [PATCH v8 1/2] docs: Move rustdoc output, cross-reference it Carlos Bilbao
2023-07-19 17:19   ` Martin Rodriguez Reboredo
2023-07-20 19:07   ` Miguel Ojeda
2023-07-18 15:15 ` Carlos Bilbao [this message]
2023-07-19 17:20   ` [PATCH v8 2/2] docs: Integrate rustdoc generation into htmldocs Martin Rodriguez Reboredo
2023-07-20 22:46 ` [PATCH v8 0/2] docs: Integrate rustdoc into Rust documentation Jonathan Corbet
2023-07-21 21:43   ` Jonathan Corbet
2023-07-31 14:15   ` Carlos Bilbao

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230718151534.4067460-3-carlos.bilbao@amd.com \
    --to=carlos.bilbao@amd.com \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@linux.intel.com \
    --cc=konstantin@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ojeda@kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=rust-for-linux@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®