[haiku-doc] Re: Kernel Kit documentation?
- From: "Dale Cieslak" <dmarc-noreply@xxxxxxxxxxxxx> ("dcieslak")
- To: "haiku-doc@xxxxxxxxxxxxx" <haiku-doc@xxxxxxxxxxxxx>
- Date: Tue, 25 Jan 2022 06:43:43 +0000 (UTC)
Personally, I think it'd be great if at some point the BeBook was just a
historical artifact, and all you needed to know about Haiku was in the Haiku
book. I don't know if anyone feels strongly the opposite.
Also I don't know the details of the BeBook copyrights - would it be ok to use
the Be kernel kit docs as a starting point?
Keeping it secret, while ultimately probably more educational, feels like the
wrong way to go. :D
~Dale
On Monday, January 24, 2022, 07:31:31 AM PST, Alexander G. M. Smith
<agmsmith@xxxxxx> wrote:
On 2022-01-23 22:47, Dale Cieslak (dcieslak) wrote:
I was looking for info about Areas, and could only find info in the
Be Book. It seems like none of the Kernel Kit is part of the Haiku
book. Is there a reason for that, or is it just something that no one
has had time to document yet?
I learned about at least one change to Areas that is different in
Haiku vs. BeOS so it'd be nice to write that down somewhere for other
people.
You're right, there's no kernel documentation in
https://git.haiku-os.org/haiku/tree/docs/user
So no info on kernel threads, memory areas, bigtime_t (though
SupportDefs.h docs mentions it) and lots of other functions. You have
to read the old Be Book
(
https://www.haiku-os.org/legacy-docs/bebook/TheKernelKit.html) to find
it. And like you pointed out, some of it has changed and isn't documented.
So, what's the policy on doing kernel docs? Just list the differences
with BeOS? Or have documentation for the full set of data types and
functions? Or keep it secret and tell people to read the headers. :-)
- Alex
Other related posts:
