On Mon, May 20, 2019 at 9:49 PM Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote: > > On 5/10/19 2:03 PM, Brendan Higgins wrote: > > On Thu, May 9, 2019 at 6:23 PM kbuild test robot <lkp@xxxxxxxxx> wrote: > >> tree: https://git.kernel.org/pub/scm/linux/kernel/git/masahiroy/linux-kbuild.git kunit > >> head: c505c0b2e6237c729634327c178f5b0094f1c958 > >> commit: c69e87665049970d1c2d6fe2fa1ae7a7c8655420 [14/17] Documentation: kunit: add documentation for KUnit > >> reproduce: make htmldocs > >> > >> If you fix the issue, kindly add following tag > >> Reported-by: kbuild test robot <lkp@xxxxxxxxx> > >> > >> All warnings (new ones prefixed by >>): > > < snip > > >> drivers/gpu/drm/i915/i915_vma.h:50: warning: cannot understand function prototype: 'struct i915_vma ' > >> drivers/gpu/drm/i915/i915_vma.h:1: warning: no structured comments found > >> drivers/gpu/drm/i915/intel_guc_fwif.h:536: warning: cannot understand function prototype: 'struct guc_log_buffer_state ' > >> drivers/gpu/drm/i915/i915_trace.h:1: warning: no structured comments found > >> drivers/gpu/drm/i915/i915_reg.h:156: warning: bad line: > >> include/linux/interconnect.h:1: warning: no structured comments found > >>>> include/kunit/kunit-stream.h:58: warning: Function parameter or member '2' not described in '__printf' > > > > This looks like a bug in the kernel-doc parser: __printf in this context is: > > > >> 8dcda743 Brendan Higgins 2019-05-01 56 void __printf(2, 3) kunit_stream_add(struct kunit_stream *this, > >> 8dcda743 Brendan Higgins 2019-05-01 57 const char *fmt, ...); > > > > which is an attribute to tell the compiler that this is a printf style > > function with a printf style format string; it doesn't make sense to > > describe it's parameters. > > Yes. I'm a little surprised that this has never come up before, but in my > quick examination, it seems that most people put the __printf() attribute > in a header file but not in the .c implementation file, then they document > the function in the .c file, not in the header file, so it hasn't been needed. > > Ignoring __printf() could be added to scripts/kernel-doc. I added > kernel-doc notation to <linux/kernel.h> panic() and then tested it with > the patch below. ItWorksForMe. :) > > > >> include/kunit/kunit-stream.h:58: warning: Function parameter or member '3' not described in '__printf' > >> include/kunit/kunit-stream.h:58: warning: Excess function parameter 'this' description in '__printf' > >> include/kunit/kunit-stream.h:58: warning: Excess function parameter 'fmt' description in '__printf' > >> include/linux/skbuff.h:897: warning: Function parameter or member 'dev_scratch' not described in 'sk_buff' > > < snip > > >> fs/debugfs/file.c:439: WARNING: Inline literal start-string without end-string. > >> > >> vim +58 include/kunit/kunit-stream.h > >> > >> 8dcda743 Brendan Higgins 2019-05-01 48 > >> 8dcda743 Brendan Higgins 2019-05-01 49 /** > >> 8dcda743 Brendan Higgins 2019-05-01 50 * kunit_stream_add(): adds the formatted input to the internal buffer. > >> 8dcda743 Brendan Higgins 2019-05-01 51 * @this: the stream being operated on. > >> 8dcda743 Brendan Higgins 2019-05-01 52 * @fmt: printf style format string to append to stream. > >> 8dcda743 Brendan Higgins 2019-05-01 53 * > >> 8dcda743 Brendan Higgins 2019-05-01 54 * Appends the formatted string, @fmt, to the internal buffer. > >> 8dcda743 Brendan Higgins 2019-05-01 55 */ > >> 8dcda743 Brendan Higgins 2019-05-01 56 void __printf(2, 3) kunit_stream_add(struct kunit_stream *this, > >> 8dcda743 Brendan Higgins 2019-05-01 57 const char *fmt, ...); > >> 8dcda743 Brendan Higgins 2019-05-01 @58 > >> > >> :::::: The code at line 58 was first introduced by commit > >> :::::: 8dcda743c31c1ffc0ac13f3d23f3dd1b85b545f8 kunit: test: add kunit_stream a std::stream like logger > > > > Thanks! > > > --- > From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> > > Ignore __printf() function attributes just as other __attribute__ > strings are ignored. > > Fixes this kernel-doc warning message: > include/kunit/kunit-stream.h:58: warning: Function parameter or member '2' not described in '__printf' > > Reported-by: kbuild test robot <lkp@xxxxxxxxx> > Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> > Cc: Brendan Higgins <brendanhiggins@xxxxxxxxxx> > --- Thanks! I just tried out your patch and it looks like it works. Tested-by: Brendan Higgins <brendanhiggins@xxxxxxxxxx>
