(apologies for the spate of recent postings ... just trying to
resolve a bunch of kerneldoc things as i want to use some kerneldoc
manuals in some upcoming classes i'm teaching.)
On Tue, 10 Feb 2015, Randy Dunlap wrote:
> On 02/03/15 11:31, Robert P. J. Day wrote:
> > 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?
>
> I would create a new one unless it is fairly small.
i would lean to starting a new manual so as to not interfere with
anyone else's efforts in another manual, and i think there is enough
content to justify a new manual.
there's already some kerneldoc content in include/linux/of.h and
under drivers/of/ that can be used as a starting point, and i don't
see any of the OF kerneldoc content being referenced in any other
manual -- correct me if i'm wrong.
is there a boilerplate doc for a new manual? or should i just grab
an existing one and hack it? as a starting point, i'd just include the
kerneldoc that's already there, and add more content over time.
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
