From: John Snow <jsnow@redhat.com> To: qemu-devel@nongnu.org, qemu-block@nongnu.org Cc: John Snow <jsnow@redhat.com>, vsementsov@virtuozzo.com, kchamart@redhat.com, armbru@redhat.com, aliang@redhat.com, nsoffer@redhat.com, Fam Zheng <fam@euphon.net>, qemu-stable@nongnu.org, eblake@redhat.com Subject: [Qemu-devel] [PATCH v3 1/2] Makefile: add nit-picky mode to sphinx-build Date: Fri, 26 Apr 2019 18:15:27 -0400 [thread overview] Message-ID: <20190426221528.30293-2-jsnow@redhat.com> (raw) In-Reply-To: <20190426221528.30293-1-jsnow@redhat.com> If we add references that don't resolve (or accidentally remove them), it will be helpful to have an error message alerting us to that. Turn warnings into errors so we can be alerted to problems in building the documentation when they arise. Signed-off-by: John Snow <jsnow@redhat.com> --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 626a04d305..1211e78c91 100644 --- a/Makefile +++ b/Makefile @@ -926,7 +926,7 @@ docs/version.texi: $(SRC_PATH)/VERSION sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index.html # Canned command to build a single manual -build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -b html -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1") +build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -W -n -b html -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1") # We assume all RST files in the manual's directory are used in it manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py -- 2.20.1
WARNING: multiple messages have this Message-ID (diff)
From: John Snow <jsnow@redhat.com> To: qemu-devel@nongnu.org, qemu-block@nongnu.org Cc: Fam Zheng <fam@euphon.net>, vsementsov@virtuozzo.com, aliang@redhat.com, kchamart@redhat.com, armbru@redhat.com, qemu-stable@nongnu.org, nsoffer@redhat.com, John Snow <jsnow@redhat.com> Subject: [Qemu-devel] [PATCH v3 1/2] Makefile: add nit-picky mode to sphinx-build Date: Fri, 26 Apr 2019 18:15:27 -0400 [thread overview] Message-ID: <20190426221528.30293-2-jsnow@redhat.com> (raw) Message-ID: <20190426221527.8m5GJ74U2F5oMnvd4PZlZbbylV0k19ELka9ee6WtiKQ@z> (raw) In-Reply-To: <20190426221528.30293-1-jsnow@redhat.com> If we add references that don't resolve (or accidentally remove them), it will be helpful to have an error message alerting us to that. Turn warnings into errors so we can be alerted to problems in building the documentation when they arise. Signed-off-by: John Snow <jsnow@redhat.com> --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 626a04d305..1211e78c91 100644 --- a/Makefile +++ b/Makefile @@ -926,7 +926,7 @@ docs/version.texi: $(SRC_PATH)/VERSION sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index.html # Canned command to build a single manual -build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -b html -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1") +build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -W -n -b html -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1") # We assume all RST files in the manual's directory are used in it manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py -- 2.20.1
next prev parent reply other threads:[~2019-04-26 22:15 UTC|newest] Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-04-26 22:15 [Qemu-devel] [PATCH v3 0/2] docs/interop/bitmaps: rewrite and modernize doc John Snow 2019-04-26 22:15 ` John Snow 2019-04-26 22:15 ` John Snow [this message] 2019-04-26 22:15 ` [Qemu-devel] [PATCH v3 1/2] Makefile: add nit-picky mode to sphinx-build John Snow 2019-04-29 9:17 ` Vladimir Sementsov-Ogievskiy 2019-04-29 9:17 ` Vladimir Sementsov-Ogievskiy 2019-04-30 22:53 ` John Snow 2019-04-30 22:53 ` John Snow 2019-04-26 22:15 ` [Qemu-devel] [PATCH v3 2/2] docs/interop/bitmaps: rewrite and modernize doc John Snow 2019-04-26 22:15 ` John Snow 2019-04-29 9:30 ` Vladimir Sementsov-Ogievskiy 2019-04-29 9:30 ` Vladimir Sementsov-Ogievskiy 2019-04-29 13:44 ` Kashyap Chamarthy 2019-04-29 13:44 ` Kashyap Chamarthy 2019-04-30 22:56 ` John Snow 2019-04-30 22:56 ` John Snow
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=20190426221528.30293-2-jsnow@redhat.com \ --to=jsnow@redhat.com \ --cc=aliang@redhat.com \ --cc=armbru@redhat.com \ --cc=eblake@redhat.com \ --cc=fam@euphon.net \ --cc=kchamart@redhat.com \ --cc=nsoffer@redhat.com \ --cc=qemu-block@nongnu.org \ --cc=qemu-devel@nongnu.org \ --cc=qemu-stable@nongnu.org \ --cc=vsementsov@virtuozzo.com \ /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: linkBe 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; as well as URLs for NNTP newsgroup(s).