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

[David Marchand]

On Thu, Jan 19, 2023 at 8:42 PM Stephen Hemminger
<stephen at networkplumber.org> wrote:
>
> On Thu, 19 Jan 2023 19:46:12 +0100
> David Marchand <david.marchand at redhat.com> wrote:
>
> > +#ifndef __DOXYGEN__
> > +     __rte_exclusive_lock_function(&seqlock->lock)
> > +#endif
> >  {
>
> Would be cleaner any required ifdefs was in rte_lock_annotations
> rather than sprinkling the code
>

IIRC doxygen was getting confused about parens around seqlock->lock
for this place only.
Other places seem fine, so it seemed more like a doxygen bug and I
waived the only location where it was needed.

I kind of forgot to investigate again.

Here is the trace:
$  ninja-build -C build-gcc doc
ninja: Entering directory `build-gcc'
[1/2] Generating doc/api/doxygen with a custom command
FAILED: doc/api/html
/usr/bin/python3 ../doc/api/generate_doxygen.py doc/api/html
/usr/bin/doxygen doc/api/doxy-api.conf
/home/dmarchan/git/pub/dpdk.org/main/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 "/home/dmarchan/git/pub/dpdk.org/main/build-gcc/../doc/api/generate_doxygen.py",
line 13, in <module>
    subprocess.run(doxygen_command, check=True, stdout=out)
  File "/usr/lib64/python3.11/subprocess.py", line 571, in run
    raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['/usr/bin/doxygen',
'doc/api/doxy-api.conf']' returned non-zero exit status 1.
ninja: build stopped: subcommand failed.

$ doxygen --version
1.9.5


-- 
David Marchand