Re: [PATCH v5 1/9] eal: annotate spinlock, rwlock and seqlock

From: David Marchand <david.marchand@redhat.com>
To: "Tu, Lijuan" <lijuan.tu@intel.com>
Cc: "Chen, Zhaoyan" <zhaoyan.chen@intel.com>,
	sys_stv <sys_stv@intel.com>,  "dev@dpdk.org" <dev@dpdk.org>,
	"Coquelin, Maxime" <maxime.coquelin@redhat.com>,
	"stephen@networkplumber.org" <stephen@networkplumber.org>,
	"Xia, Chenbo" <chenbo.xia@intel.com>,
	 "Hu, Jiayu" <jiayu.hu@intel.com>,
	"Wang, YuanX" <yuanx.wang@intel.com>,
	 "Ding, Xuan" <xuan.ding@intel.com>,
	"mb@smartsharesystems.com" <mb@smartsharesystems.com>,
	 "Burakov, Anatoly" <anatoly.burakov@intel.com>,
	 "mattias.ronnblom" <mattias.ronnblom@ericsson.com>,
	David Christensen <drc@linux.vnet.ibm.com>,
	 "Richardson, Bruce" <bruce.richardson@intel.com>,
	 Konstantin Ananyev <konstantin.v.ananyev@yandex.ru>,
	Thomas Monjalon <thomas@monjalon.net>
Subject: Re: [PATCH v5 1/9] eal: annotate spinlock, rwlock and seqlock
Date: Mon, 6 Feb 2023 09:12:41 +0100	[thread overview]
Message-ID: <CAJFAV8x0vD9zqXoc1W8aBpv8WgqzDp=5i5tn0pLFZtLzJqiVDA@mail.gmail.com> (raw)
In-Reply-To: <CY5PR11MB618735108D3E9D90C67EEF96F5DA9@CY5PR11MB6187.namprd11.prod.outlook.com>

Hello,

On Mon, Feb 6, 2023 at 2:02 AM Tu, Lijuan <lijuan.tu@intel.com> wrote:
> > I received this report:
> > http://mails.dpdk.org/archives/test-report/2023-February/345705.html
> >
> > FAILED: doc/api/html
> > /usr/bin/python3 ../doc/api/generate_doxygen.py doc/api/html
> > /usr/bin/doxygen doc/api/doxy-api.conf
> > /root/UB2204-64_K5.15.0_GCC11.3.0/x86_64-native-linuxapp-
> > doc/26733/dpdk/lib/eal/include/rte_seqlock.h:218:
> > error: Found ')' without opening '(' for trailing return type ' -> lock)...' (warning
> > treated as error, aborting now) Traceback (most recent call last):
> >   File "/root/UB2204-64_K5.15.0_GCC11.3.0/x86_64-native-linuxapp-
> > doc/26733/dpdk/x86_64-native-linuxapp-doc/../doc/api/generate_doxygen.py",
> > line 13, in <module>
> >     subprocess.run(doxygen_command, check=True, stdout=out)
> >   File "/usr/lib/python3.10/subprocess.py", line 524, in run
> >     raise CalledProcessError(retcode, process.args,
> > subprocess.CalledProcessError: Command '['/usr/bin/doxygen', 'doc/api/doxy-
> > api.conf']' returned non-zero exit status 1.
> >
> > This error is what the patch 1 in this series (with the doc/api/doxy-api.conf.in
> > update) tries to avoid.
> >
> > I tested my series in a fresh Ubuntu 22.04 container and I can't reproduce this
> > error.
> > Please share how this test was run in your lab so I can replicate.
>
> Sorry, bothered you. There is no error with this series.
>
> The error is caused by the CI doesn't apply any changes with doc/*.
> Community decided to exclude doc/*,  as doc/* change frequently,
> especially the release notes, cause a lot of conflict with main tree.
>
> Here is command we used:
> git pw series apply 26733 --exclude=doc/**
>
> We will raise a discussion for this in community CI meeting.
> My thought is to narrow down exclude scope to doc/guides or
> doc/guides/rel_notes/*

Ok, thanks for the analysis.

- I was not aware of such behavior (I probably missed it in CI minutes).
Is this something that only Intel CI does?
At least for GHA, I am sure it is not the case.

- What is the point of calling the documentation generation target if
doc/ updates are ignored?

-- 
David Marchand