From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([209.51.188.92]:41943) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hK987-0006gA-Sd for qemu-devel@nongnu.org; Fri, 26 Apr 2019 18:15:40 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hK985-0000WE-Te for qemu-devel@nongnu.org; Fri, 26 Apr 2019 18:15:39 -0400 From: John Snow Date: Fri, 26 Apr 2019 18:15:27 -0400 Message-Id: <20190426221528.30293-2-jsnow@redhat.com> In-Reply-To: <20190426221528.30293-1-jsnow@redhat.com> References: <20190426221528.30293-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Subject: [Qemu-devel] [PATCH v3 1/2] Makefile: add nit-picky mode to sphinx-build List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org, qemu-block@nongnu.org Cc: John Snow , vsementsov@virtuozzo.com, kchamart@redhat.com, armbru@redhat.com, aliang@redhat.com, nsoffer@redhat.com, Fam Zheng , qemu-stable@nongnu.org, eblake@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 --- 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)/inter= op/index.html =20 # Canned command to build a single manual -build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -b htm= l -D version=3D$(VERSION) -D release=3D"$(FULL_VERSION)" -d .doctrees/$1 = $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$= 1") +build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -W -n = -b html -D version=3D$(VERSION) -D release=3D"$(FULL_VERSION)" -d .doctre= es/$1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILD= DIR)/$1") # We assume all RST files in the manual's directory are used in it manual-deps =3D $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$= 1/conf.py $(SRC_PATH)/docs/conf.py =20 --=20 2.20.1 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 X-Spam-Level: X-Spam-Status: No, score=-6.9 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 15908C43218 for ; Fri, 26 Apr 2019 22:17:12 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id DDFA62084F for ; Fri, 26 Apr 2019 22:17:11 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org DDFA62084F Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([127.0.0.1]:52641 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hK99b-00086c-0h for qemu-devel@archiver.kernel.org; Fri, 26 Apr 2019 18:17:11 -0400 Received: from eggs.gnu.org ([209.51.188.92]:41943) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hK987-0006gA-Sd for qemu-devel@nongnu.org; Fri, 26 Apr 2019 18:15:40 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hK985-0000WE-Te for qemu-devel@nongnu.org; Fri, 26 Apr 2019 18:15:39 -0400 Received: from mx1.redhat.com ([209.132.183.28]:52340) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hK983-0000TJ-EW; Fri, 26 Apr 2019 18:15:35 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id B1B11A0E68; Fri, 26 Apr 2019 22:15:33 +0000 (UTC) Received: from probe.bos.redhat.com (dhcp-17-206.bos.redhat.com [10.18.17.206]) by smtp.corp.redhat.com (Postfix) with ESMTP id 991CA60923; Fri, 26 Apr 2019 22:15:32 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org, qemu-block@nongnu.org Date: Fri, 26 Apr 2019 18:15:27 -0400 Message-Id: <20190426221528.30293-2-jsnow@redhat.com> In-Reply-To: <20190426221528.30293-1-jsnow@redhat.com> References: <20190426221528.30293-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.28]); Fri, 26 Apr 2019 22:15:33 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v3 1/2] Makefile: add nit-picky mode to sphinx-build X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Fam Zheng , vsementsov@virtuozzo.com, aliang@redhat.com, kchamart@redhat.com, armbru@redhat.com, qemu-stable@nongnu.org, nsoffer@redhat.com, John Snow Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="UTF-8" Message-ID: <20190426221527.8m5GJ74U2F5oMnvd4PZlZbbylV0k19ELka9ee6WtiKQ@z> 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 --- 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)/inter= op/index.html =20 # Canned command to build a single manual -build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -b htm= l -D version=3D$(VERSION) -D release=3D"$(FULL_VERSION)" -d .doctrees/$1 = $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$= 1") +build-manual =3D $(call quiet-command,sphinx-build $(if $(V),,-q) -W -n = -b html -D version=3D$(VERSION) -D release=3D"$(FULL_VERSION)" -d .doctre= es/$1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILD= DIR)/$1") # We assume all RST files in the manual's directory are used in it manual-deps =3D $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$= 1/conf.py $(SRC_PATH)/docs/conf.py =20 --=20 2.20.1