Kernel Documentation
Quoted 2 lines · Ignacio Vazquez-Abrams
This is probably a silly question, but why doesn't your site just use DocBook?
DocBook is more "bookish" complete with chapters and all. I've used it before, it's nice, but not for this, in my opinion. Also, the backend just moves the XML data into a temporary MySQL database for easy searching, and sorting, and something like that, I think, would be much more difficult with docbook.
++ 17/07/01 14:02 -0700 - Charles Samuels:
Quoted 11 lines
Quoted 2 lines · Ignacio Vazquez-Abrams
This is probably a silly question, but why doesn't your site just use DocBook?
DocBook is more "bookish" complete with chapters and all. I've used it before, it's nice, but not for this, in my opinion. Also, the backend just moves the XML data into a temporary MySQL database for easy searching, and sorting, and something like that, I think, would be much more difficult with docbook.
2 things:
1: there is a project in the kernel to establish API references. you should not duplicate this work, but should add to it.
Reason: There is no way you can get or stay ahead.
2: the secondary issue of documenting best practices in the kernel is a different matter altogether. I, myself, have started a project to do this. I'm sorta scared of letting people know about it at this point, but I feel it is necessary.
the entry point is:
http://bama.ua.edu/~dunn001/journeyman/
I /am/ looking for help, but it is very early. I am NOT looking for exposure, so dont even bother looking if you dont want to write docs; there isnt anything there for you.
Signature · 3 lines
Crutcher <[email protected]> GCS d--- s+:>+:- a-- C++++$ UL++++$ L+++$>++++ !E PS+++ PE Y+ PGP+>++++ R-(+++) !tv(+++) b+(++++) G+ e>++++ h+>++ r* y+>*$
Quoted 6 lines · Crutcher Dunnavant
the entry point is:
http://bama.ua.edu/~dunn001/journeyman/I /am/ looking for help, but it is very early. I am NOT looking for exposure, so dont even bother looking if you dont want to write docs; there isnt anything there for you.
In reality, there isn't anything there for anyone. There isn't anything at all right now at that address.
Signature · 1 line
Ignacio Vazquez-Abrams <[email protected]>
BTW:
Quoted 6 lines · you
++ 17/07/01 14:02 -0700 - Charles Samuels:
2 things:1: there is a project in the kernel to establish API references. you should not duplicate this work, but should add to it.
Reason: There is no way you can get or stay ahead.
make htmldoc ? I don't have docbook, and don't want to have to install it, well, unless I know that it'l get me what I want. Does it create an actual API reference?
Quoted 8 lines
2: the secondary issue of documenting best practices in the kernel is a different matter altogether. I, myself, have started a project to do this. I'm sorta scared of letting people know about it at this point, but I feel it is necessary.
the entry point is:
http://bama.ua.edu/~dunn001/journeyman/
404. Not sure what this is anyway :)
Quoted 4 lines
I /am/ looking for help, but it is very early. I am NOT looking for exposure, so dont even bother looking if you dont want to write docs; there isnt anything there for you.
In article <[email protected]>,
Quoted 5 lines · Charles Samuels
DocBook is more "bookish" complete with chapters and all. I've used it before, it's nice, but not for this, in my opinion. Also, the backend just moves the XML data into a temporary MySQL database for easy searching, and sorting, and something like that, I think, would be much more difficult with docbook.
DocBook can be XML though.
Wichert.
Signature · 4 lines
_________________________________________________________________ / Nothing is fool-proof to a sufficiently talented fool \ | [email protected] http://www.liacs.nl/~wichert/ | | 1024D/2FA3BC2D 576E 100B 518D 2F16 36B0 2805 3CB8 9250 2FA3 BC2D |
Quoted 1 line · Charles Samuels
BTW:
Sorry, multitasking: I meant to say I'm on the linux-kernel mailing list now, so you don't need to be CCing me
-Charles
++ 17/07/01 17:18 -0400 - Crutcher Dunnavant:
Quoted 3 lines
++ 17/07/01 14:02 -0700 - Charles Samuels:
the entry point is:
http://bama.ua.edu/~dunn001/journeyman/
oops:
http://bama.ua.edu/~dunna001/journeyman/
Signature · 3 lines
Crutcher <[email protected]> GCS d--- s+:>+:- a-- C++++$ UL++++$ L+++$>++++ !E PS+++ PE Y+ PGP+>++++ R-(+++) !tv(+++) b+(++++) G+ e>++++ h+>++ r* y+>*$
Quoted 11 lines · Charles Samuels
Quoted 6 lines · you
++ 17/07/01 14:02 -0700 - Charles Samuels:
2 things:1: there is a project in the kernel to establish API references. you should not duplicate this work, but should add to it.
Reason: There is no way you can get or stay ahead.make htmldoc ? I don't have docbook, and don't want to have to install it, well, unless I know that it'l get me what I want. Does it create an actual API reference?
yes. you can read a recent version at http://kernelnewbies.org/documents/kdoc/
Everyone would much prefer it if you pitched in with this instead I think...
one simple advantage is the docs are inline so have a slightly higher chance of staying up to date.
regards
john
Signature · 4 lines
"Voodoo Programming: Things programmers do that they know shouldn't work but they try anyway, and which sometimes actually work, such as recompiling everything." - Karl Lehenbauer
Quoted 2 lines · John Levon
one simple advantage is the docs are inline so have a slightly higher chance of staying up to date.
BTW Is there any place where the exact format of the inline docs is explained?
bye...
Quoted 2 lines · Tim Jansen
BTW Is there any place where the exact format of the inline docs is explained?
scripts/kernel-doc, which interprets them. ;-)
Seriously though, there is a comment at the top of the file explaining it all.
Tim.
*/