From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([209.51.188.92]:51839) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hLvn1-0003fH-8a for qemu-devel@nongnu.org; Wed, 01 May 2019 16:25:16 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hLvn0-00018r-B6 for qemu-devel@nongnu.org; Wed, 01 May 2019 16:25:15 -0400 From: John Snow Date: Wed, 1 May 2019 16:25:05 -0400 Message-Id: <20190501202506.13875-2-jsnow@redhat.com> In-Reply-To: <20190501202506.13875-1-jsnow@redhat.com> References: <20190501202506.13875-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Subject: [Qemu-devel] [PULL 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 Cc: jsnow@redhat.com, peter.maydell@linaro.org, qemu-block@nongnu.org, qemu-stable@nongnu.org, Vladimir Sementsov-Ogievskiy If we add references that don't resolve (or accidentally remove them), it will be helpful to have warning messages alerting us to that. Further, turn those warnings into errors so we can be alerted to these problems sooner rather than later. Signed-off-by: John Snow Reviewed-by: Vladimir Sementsov-Ogievskiy Message-id: 20190426221528.30293-2-jsnow@redhat.com [adjusted commit message. --js] Signed-off-by: John Snow --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 6ccb8639b0..f1325947f6 100644 --- a/Makefile +++ b/Makefile @@ -898,7 +898,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,URIBL_BLOCKED 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 7D90BC43219 for ; Wed, 1 May 2019 20:26:49 +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 4F45C20866 for ; Wed, 1 May 2019 20:26:49 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 4F45C20866 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]:40939 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hLvoW-0004yK-JW for qemu-devel@archiver.kernel.org; Wed, 01 May 2019 16:26:48 -0400 Received: from eggs.gnu.org ([209.51.188.92]:51839) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hLvn1-0003fH-8a for qemu-devel@nongnu.org; Wed, 01 May 2019 16:25:16 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hLvn0-00018r-B6 for qemu-devel@nongnu.org; Wed, 01 May 2019 16:25:15 -0400 Received: from mx1.redhat.com ([209.132.183.28]:37650) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hLvmy-00016q-8a; Wed, 01 May 2019 16:25:12 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 7796F81106; Wed, 1 May 2019 20:25:11 +0000 (UTC) Received: from probe.bos.redhat.com (dhcp-17-238.bos.redhat.com [10.18.17.238]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8EC017C5EE; Wed, 1 May 2019 20:25:10 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Date: Wed, 1 May 2019 16:25:05 -0400 Message-Id: <20190501202506.13875-2-jsnow@redhat.com> In-Reply-To: <20190501202506.13875-1-jsnow@redhat.com> References: <20190501202506.13875-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.28]); Wed, 01 May 2019 20:25:11 +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] [PULL 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: peter.maydell@linaro.org, Vladimir Sementsov-Ogievskiy , jsnow@redhat.com, qemu-stable@nongnu.org, qemu-block@nongnu.org Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="UTF-8" Message-ID: <20190501202505.KmgYTxfm0Xa5LTTQs-BNf19kmBr0tiejYHOMrPTZL20@z> If we add references that don't resolve (or accidentally remove them), it will be helpful to have warning messages alerting us to that. Further, turn those warnings into errors so we can be alerted to these problems sooner rather than later. Signed-off-by: John Snow Reviewed-by: Vladimir Sementsov-Ogievskiy Message-id: 20190426221528.30293-2-jsnow@redhat.com [adjusted commit message. --js] Signed-off-by: John Snow --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 6ccb8639b0..f1325947f6 100644 --- a/Makefile +++ b/Makefile @@ -898,7 +898,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