a few questions about working with kerneldoc these days

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



  first, is linux-next the proper tree to work with to see the
absolutely latest commits to the documentation? just so i don't
duplicate someone else's work.

  next, in the current "make htmldocs", there are a few diagnostics
like this:

Warning(.//drivers/usb/gadget/function/f_acm.c): no structured comments found
Warning(.//drivers/usb/gadget/function/f_ecm.c): no structured comments found
Warning(.//drivers/usb/gadget/function/f_subset.c): no structured comments found
Warning(.//drivers/usb/gadget/function/f_obex.c): no structured comments found
Warning(.//drivers/usb/gadget/function/f_serial.c): no structured comments found

clearly representing a DocBook .tmpl file pulling in a specified
source file that has no (typically exported) kerneldoc content. is
there any reason for those lines to be there? shouldn't the .tmpl
files be cleansed of "!E" lines that have no value and simply generate
dummy/error pages in the manual?

  finally, i'd like a kerneldoc manual for the open firmware API, and
i see no such thing. if i wanted to start creating one, would it make
more sense to add that to an existing manual (say device-drivers), or
start a new manual?

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux