From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D268245D54; Wed, 20 Nov 2024 16:58:43 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6850640285; Wed, 20 Nov 2024 16:58:43 +0100 (CET) Received: from mail-pf1-f177.google.com (mail-pf1-f177.google.com [209.85.210.177]) by mails.dpdk.org (Postfix) with ESMTP id 783204021E for ; Wed, 20 Nov 2024 16:58:42 +0100 (CET) Received: by mail-pf1-f177.google.com with SMTP id d2e1a72fcca58-7242f559a9fso2303496b3a.1 for ; Wed, 20 Nov 2024 07:58:42 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1732118321; x=1732723121; darn=dpdk.org; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=2TXTMFwAJQt/lSp8ufqkIl/CJ6RggpzgjnYuSYzyO1w=; b=HUx+XiiRk4hctPi5wCs1Ic7dRMkCgbB7OITq2A76c/qpO0RMs81OCZOsWYbAhmXCcb 9QD5s3gOWLUp/eXM1W69d3RSYotzZ8Plnat72PlNcZFBY3msUE5MCxpn/aqCPJAjGyp/ Ro+wybpFwO11KtEaGMXIKrRVreOuJLHp8njCg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732118321; x=1732723121; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=2TXTMFwAJQt/lSp8ufqkIl/CJ6RggpzgjnYuSYzyO1w=; b=bL3G00MOe7X8vOnAhF27LzZdJMslWGbk1sXWt9LorLzaH6NMlDaIsrphnMVDlzxp0/ I7RgVvXBTUaPXdoZ6KC4ZGYZdmv9EkiQFahU4nI5RkG2PFI8nEkZ2zOV4TG89Zfdmcv6 hNBJwBoH4KyYNkshywHa33x5Uzo5FXHgoG7s757YOHYg6PeINeCpaRUVwS3sq83o/NrG BFeXelDAsevUgOhLiiFhxq1CmoTzS8fNrdmzuImBhcjoM9zFmNeuv3PB75H/UVZP6TsD tPl/qMCbbI5txXjy3DfddvkFthZ9NouXln3+Y0tmH9xETgaX7Lij1svgp2VfBzfnwy1i Hl6g== X-Forwarded-Encrypted: i=1; AJvYcCUS2FkqjgXd83hND8eSX7BVVgDqFDf8bK/7s00c4IGb8kLnpZ1ygOnw84wl57QejiADVzM=@dpdk.org X-Gm-Message-State: AOJu0YzUC1q5zep9wSDjcg093UfmnLEqi92DFtGvWrlnkrHD4OkNMPIW AmuAH+z7q2hDPLw1owoTyBaNsbM1oL0fDBztM/BCYnXJdDZy5PEVxHCe0lzd/goLaDe0WfRPpGf 7vdTlGoEKIUo+/N3RByEgHJTH6K5TsKtbgnqjZXXN//+dUe3W X-Google-Smtp-Source: AGHT+IGuK2hLM5ucic8O5MW5918bBjsOsE7k2ot1iScYIVMwabIFSU6VaK/KwPiosf4+5SEV3JifF9rI6IkLHOnHQzU= X-Received: by 2002:a05:6a00:b85:b0:724:6dd7:ca1d with SMTP id d2e1a72fcca58-724bed756b8mr4094833b3a.25.1732118321627; Wed, 20 Nov 2024 07:58:41 -0800 (PST) MIME-Version: 1.0 References: <20241120144101.1826555-1-luca.vizzarro@arm.com> <5896563.1B3tZ46Xf9@thomas> <2371296.bcXerOTE6V@thomas> In-Reply-To: <2371296.bcXerOTE6V@thomas> From: Patrick Robb Date: Wed, 20 Nov 2024 10:56:39 -0500 Message-ID: Subject: Re: [PATCH] dts: fix API doc build warnings To: Thomas Monjalon Cc: Luca Vizzarro , dev@dpdk.org, Paul Szczepanek Content-Type: multipart/alternative; boundary="00000000000045264306275a3977" X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org --00000000000045264306275a3977 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Thanks Luca, Thomas, I see Thomas just applied it to main, but I'll mention I tested with meson werror and I think this fix is appropriate. This is a good reminder for us to always build with --werror On Wed, Nov 20, 2024 at 10:54=E2=80=AFAM Thomas Monjalon wrote: > 20/11/2024 16:05, Thomas Monjalon: > > 20/11/2024 15:41, Luca Vizzarro: > > > Sphinx-autodoc issues warnings about some symbols due to bad autodoc > > > "automock"ing when optional dependencies are missing. > > > > > > The current meson setup allows to treat warnings as errors, halting t= he > > > process and exiting early. Given these warnings should be ignored, th= is > > > patch removes this behavior. > > > > So the patch is not fixing warnings, it allows them. > > I will change the title. > > > > > Until optional dependencies are enforced, > > > warnings for DTS API docs will be checked manually as part of the DTS > > > approval process. > > > > No, optional dependencies should never be enforced. > > > > [...] > > > -if get_option('werror') > > > - extra_sphinx_args +=3D '-W' > > > -endif > > It makes the CI issue disappear. > > Applied with this modified message, thanks for fixing quickly: > > doc: allow warnings in Sphinx for DTS > > Sphinx-autodoc issues warnings about some symbols due to bad autodoc > "automock"ing when optional dependencies are missing: > > Warning, treated as error: > Failed to get a method signature for > framework.config.TestSuiteConfig.convert_from_string: > at 0x7f1a4ec10790>)> is not a callable object > > The current meson setup allows to treat warnings as errors, halting t= he > process and exiting early. Given these warnings should be ignored, th= is > patch removes this behavior. Until optional dependencies are detected= , > warnings for DTS API docs will be checked manually as part of the DTS > approval process. > > Fixes: 6597fa4a30ad ("dts: add autodoc Pydantic") > > Signed-off-by: Luca Vizzarro > > > > > --00000000000045264306275a3977 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Thanks Luca, Thomas,

I see Thomas just = applied it to main, but I'll mention I tested with meson werror and I t= hink this fix is appropriate.

This is a good remin= der for us to always build with --werror=C2=A0

On Wed, Nov 20, 2024 at= 10:54=E2=80=AFAM Thomas Monjalon <thomas@monjalon.net> wrote:
20/11/2024 16:05, Thomas Monjalon:
> 20/11/2024 15:41, Luca Vizzarro:
> > Sphinx-autodoc issues warnings about some symbols due to bad auto= doc
> > "automock"ing when optional dependencies are missing. > >
> > The current meson setup allows to treat warnings as errors, halti= ng the
> > process and exiting early. Given these warnings should be ignored= , this
> > patch removes this behavior.
>
> So the patch is not fixing warnings, it allows them.
> I will change the title.
>
> > Until optional dependencies are enforced,
> > warnings for DTS API docs will be checked manually as part of the= DTS
> > approval process.
>
> No, optional dependencies should never be enforced.
>
> [...]
> > -if get_option('werror')
> > -=C2=A0 =C2=A0 extra_sphinx_args +=3D '-W'
> > -endif

It makes the CI issue disappear.

Applied with this modified message, thanks for fixing quickly:

=C2=A0 =C2=A0 doc: allow warnings in Sphinx for DTS

=C2=A0 =C2=A0 Sphinx-autodoc issues warnings about some symbols due to bad = autodoc
=C2=A0 =C2=A0 "automock"ing when optional dependencies are missin= g:

=C2=A0 =C2=A0 Warning, treated as error:
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 Failed to get a method signature = for
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 framework.config.TestSuiteConfig.= convert_from_string:
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 <classmethod(<function Test= SuiteConfig.convert_from_string
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 at 0x7f1a4ec10790>)> is not= a callable object

=C2=A0 =C2=A0 The current meson setup allows to treat warnings as errors, h= alting the
=C2=A0 =C2=A0 process and exiting early. Given these warnings should be ign= ored, this
=C2=A0 =C2=A0 patch removes this behavior. Until optional dependencies are = detected,
=C2=A0 =C2=A0 warnings for DTS API docs will be checked manually as part of= the DTS
=C2=A0 =C2=A0 approval process.

=C2=A0 =C2=A0 Fixes: 6597fa4a30ad ("dts: add autodoc Pydantic")
=C2=A0 =C2=A0 Signed-off-by: Luca Vizzarro <luca.vizzarro@arm.com>




--00000000000045264306275a3977--