Messages in this thread | | | Date | Sun, 14 May 2023 08:58:00 +0900 | Subject | Re: [PATCH locking/atomic 18/19] locking/atomic: Refrain from generating duplicate fallback kernel-doc | From | Akira Yokosawa <> |
| |
Hi,
On Fri, 12 May 2023 19:11:15 -0700, Paul E. McKenney wrote: [...]
> > And here is a rough first cut: > > git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git tags/fallback-rework-kernel-doc.2023.05.12a > > Or via HTML: > > https://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git/log/?h=fallback-rework-kernel-doc.2023.05.12a
Running "./scripts/kernel-doc -none include/linux/atomic/atomic-arch-fallback.h" on the tag emits a lot of warnings.
Looks like there are kernel-doc comments who don't have a corresponding function signature next to them.
/** * function_name() - Brief description of function. * @arg1: Describe the first argument. * @arg2: Describe the second argument. * One can provide multiple line descriptions * for arguments. * * A longer description, with more discussion of the function function_name() * that might be useful to those using or modifying it. Begins with an * empty comment line, and may include additional embedded empty * comment lines. */ int function_name(int arg1, int arg2) <---
Note that the kernel-doc script ignores #ifdef -- #else.
BTW, I couldn't checkout the tag so downloaded the tar ball via HTML.
Thanks, Akira
> > Thoughts? > > In the meantime, enjoy the weekend! > > Thanx, Paul
| |