From: Randy Dunlap <rdunlap@xenotime.net>
To: "Peter Teoh" <htmldeveloper@gmail.com>
Cc: LKML <linux-kernel@vger.kernel.org>,
"linuxkernelnewbies@googlegroups.com"
<linuxkernelnewbies@googlegroups.com>
Subject: Re: make htmldocs errors
Date: Tue, 22 Jul 2008 08:42:11 -0700 [thread overview]
Message-ID: <20080722084211.10d21eb5.rdunlap@xenotime.net> (raw)
In-Reply-To: <804dabb00807220407x683f0eb2we0b64821b9279e3c@mail.gmail.com>
On Tue, 22 Jul 2008 19:07:59 +0800 Peter Teoh wrote:
> "make htmldocs" generated the following errors:
>
> Warning(/sda4/download/linux_linus/linux-2.6//include/asm-x86/unaligned.h):
> no structured comments found
kernel-api.tmpl "includes" asm-x86/unaligned.h, but the latter contains no
kernel-doc comments. This is due to some unaligned macro/inline function
"fixes" (movement/restructuring). This head file used to contain kernel-doc
comments for unaligned functions, but it no longer does.
I'm not sure if any header file does now. If one does, it needs to be used here
instead of this header file.
> Warning(/sda4/download/linux_linus/linux-2.6//kernel/rcupdate.c:81):
> No description found for parameter 'synchronize_rcu'
> Warning(/sda4/download/linux_linus/linux-2.6//kernel/rcupdate.c:81):
> No description found for parameter 'call_rcu'
Confusing syntax for a simplistic perl parser. I'll have to take a look
at that.
> Error(/sda4/download/linux_linus/linux-2.6//drivers/pci/pci.c:1133):
> duplicate section name 'Description'
> Error(/sda4/download/linux_linus/linux-2.6//drivers/pci/pci.c:1189):
> duplicate section name 'Description'
I have already posted a patch for these. The function short description
must be on one line. Having it on multiple lines confused scripts/kernel-doc.
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'id'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'attach_adapter'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'detach_adapter'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'detach_client'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'probe'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'remove'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'shutdown'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'suspend'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'resume'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'command'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'driver'
> Warning(/sda4/download/linux_linus/linux-2.6//include/linux/i2c.h:169):
> No description found for parameter 'id_table'
These aren't a mystery at all: include/linux/i2c.h is missing lots of
struct i2c_driver field/member descriptions.
> make[1]: *** [Documentation/DocBook/kernel-api.xml] Error 2
> make: *** [htmldocs] Error 2
>
> Can someone explain what is the cause of the error? Is it because
> "make htmldocs" attempt to detect for description marked as "/* */"
> beside the field name?
No. drivers/pci/pci.c had invalid kernel-doc comments in it (function
short description on multiple lines).
---
~Randy
Linux Plumbers Conference, 17-19 September 2008, Portland, Oregon USA
http://linuxplumbersconf.org/
next prev parent reply other threads:[~2008-07-22 15:42 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-07-22 11:07 Peter Teoh
2008-07-22 15:42 ` Randy Dunlap [this message]
2008-07-23 2:48 ` Peter Teoh
2008-07-23 3:23 ` Randy Dunlap
2008-11-05 16:25 Peter Teoh
2008-11-05 16:35 ` Randy Dunlap
2008-11-05 17:04 ` Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20080722084211.10d21eb5.rdunlap@xenotime.net \
--to=rdunlap@xenotime.net \
--cc=htmldeveloper@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxkernelnewbies@googlegroups.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®