From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id D2334A051C; Fri, 17 Jan 2020 18:59:55 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id A1D811BE3D; Fri, 17 Jan 2020 18:59:55 +0100 (CET) Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [207.211.31.81]) by dpdk.org (Postfix) with ESMTP id BCA481B203 for ; Fri, 17 Jan 2020 18:59:53 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1579283992; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=RmQpnmeCqGTNult7oHRFnU1p+5KVoNZS/yfPmeNYu0g=; b=W6zsmiJ2NbwTEwVHM2pbUbxRXYY28iyrJ5Fj69wyTuv9uaNFSSVgi/4mGi6XxRjiMZ4IpU +pAX6UVfQtJ/jONOixtq3nU0UluoZB8AkrtCyyI9pj5Put9fbwWKSYMyhUkgWMEyzQSU+W 7m0S2kfw7r85MAxVA8Z2PkeG7uWkd9g= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-327-Sen4B91FN4WJsuEi4Xdytw-1; Fri, 17 Jan 2020 12:59:50 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id AE6508017CC; Fri, 17 Jan 2020 17:59:49 +0000 (UTC) Received: from dhcp-25.97.bos.redhat.com (ovpn-124-121.rdu2.redhat.com [10.10.124.121]) by smtp.corp.redhat.com (Postfix) with ESMTPS id A69961081333; Fri, 17 Jan 2020 17:59:46 +0000 (UTC) From: Aaron Conole To: Bruce Richardson Cc: david.marchand@redhat.com, dev@dpdk.org References: <20200117104820.71403-1-bruce.richardson@intel.com> <20200117104820.71403-2-bruce.richardson@intel.com> <20200117132502.GA1714@bricha3-MOBL.ger.corp.intel.com> <20200117174216.GA1724@bricha3-MOBL.ger.corp.intel.com> Date: Fri, 17 Jan 2020 12:59:45 -0500 In-Reply-To: <20200117174216.GA1724@bricha3-MOBL.ger.corp.intel.com> (Bruce Richardson's message of "Fri, 17 Jan 2020 17:42:16 +0000") Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.2 (gnu/linux) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-MC-Unique: Sen4B91FN4WJsuEi4Xdytw-1 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Subject: Re: [dpdk-dev] [PATCH 2/2] doc: pass "werror" setting through to doc build X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Bruce Richardson writes: > On Fri, Jan 17, 2020 at 08:34:01AM -0500, Aaron Conole wrote: >> Bruce Richardson writes: >>=20 >> > On Fri, Jan 17, 2020 at 08:16:55AM -0500, Aaron Conole wrote: >> >> Bruce Richardson writes: >> >>=20 >> >> > When werror is set for the build, we should pass that flag through = to >> >> > sphinx so that it can flag warnings as errors too. >> >> > >> >> > Signed-off-by: Bruce Richardson >> >> > --- >> >>=20 >> >> I see that this actually works to generate the errors... BUT >> >>=20 >> >> if we merge this it will break the build. Can you also insert a patc= h >> >> to address the warning so that the series could be merged? >> >>=20 >> > >> > Ok, I didn't have any warnings in my setup, which is why I didn't see = any >> > problems. I assume that the warnings are showing up in travis? Anywher= e >> > else? >>=20 >> I only saw them on Travis. >>=20 > The error from sphinx in travis looks like a false positive that is fixed > in later versions of sphinx. The error I see is: > > /home/travis/build/bruce-richardson/dpdk/doc/guides/linux_gsg/eal_args.in= clude.rst:: > WARNING: document isn't included in any toctree > > However, that file is an include one that is included in both the linux a= nd > freebsd eal parameters docs, and so is not missing though not included in > the index. What is the best approach to deal with this, do you think? > > * rework so it has a toctree entry e.g. by creating a new section for > common parameters > * other workaround in the code, e.g. rename the file to not end in .rst > * can we update sphinx in the travis build to avoid the warning altogethe= r? I think the third option is best. Distributions can always disable werror on doc builds or upgrade their own sphinx packages. If that isn't acceptable to anyone else, then the 1st option is my next choice. I dislike the approach of renaming the file. > /Bruce