netdev - Re: kernel doc / docbook pdfdocs question

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:	Thu, 1 Oct 2009 08:57:07 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	Doug Maxey <dwm@...yolf.org>
Cc:	Stephen Hemminger <shemminger@...tta.com>,
	netdev <netdev@...r.kernel.org>
Subject: Re: kernel doc / docbook pdfdocs question

On Thu, 01 Oct 2009 00:42:27 -0500 Doug Maxey wrote:

> 
> On Wed, 30 Sep 2009 17:30:02 PDT, Stephen Hemminger wrote:
> >On Wed, 30 Sep 2009 14:59:36 -0500
> >Doug Maxey <dwm@...yolf.org> wrote:
> >
> >> 
> >> Randy,
> >> 
> >> This may be slightly off topic for this list, but it does involve an
> >> (as yet un-released) network driver. :)
> >> 
> >> Do you have any insight that could guide me toward a fix for an issue
> >> seen with some header file constructs when trying to generate a pdf
> >> docbook?
> >> 
> >
> >Why clutter docbook output (which is supposed to be about general kernel
> >API's) with output for data structures in one driver.
> 
> It would be a general mechanism, and it would be to document an API.
> There are other subsystems that use DECLARE_BITMAP() (e.g., scsi).
> Just none at the moment that attempt to describe such a member,
> possibly because there isn't a way to document it.  Dunno.  Build it
> and they will come.  There is one party that is interested anyway.
> 
> Finally did find where this was getting warned about / tossed, in
> kernel-doc itself. =)

Hi,

Sorry for the delayed reply.  I was away yesterday.

What did you find in kernel-doc?  Something like the
"cannot understand prototype" message or something else?

Features/support in kernel-doc is mostly added on an as-needed basis.
Now that you have provided a sample, I can try to add support for it,
but it's not exactly a high priority for me... or you can add support
for it to kernel-doc and send a patch for it.  :)


---
~Randy
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html