Use doxygen or another tool to generate a documentation ?
Hi all,
I don't know if there is a project based on Doxygen to make (or generate) a documentation of the kernel.
Do you think that will be interesting to make a such document ?
I want to learn the kernel's engine, but I don't know how to help the kernel hackers.
Best regards,
Stephane
Signature · 2 lines
Stephane Wirtel <[email protected]> <[email protected]>
Quoted 4 lines · Stephane Wirtel
I don't know if there is a project based on Doxygen to make (or generate) a documentation of the kernel.
Do you think that will be interesting to make a such document ?
The kernel already has it's own API documentation generator called kerneldoc. See the file Documentation/kernel-doc-nano-HOWTO.txt for details.
Pekka
Le Saturday 20 August 2005 a 00:08, Pekka Enberg ecrivait:
Quoted 9 lines · Stephane Wirtel
Quoted 4 lines
I don't know if there is a project based on Doxygen to make (or generate) a documentation of the kernel.
Do you think that will be interesting to make a such document ?
The kernel already has it's own API documentation generator called kerneldoc. See the file
Documentation/kernel-doc-nano-HOWTO.txtfor details.
Ok, with scripts/kernel-doc, I can produce some html files containing the functions' documentation.
make pdfdocs or others targets don't work :|
Do you have ideas ?
Thanks
Signature · 2 lines
Stephane Wirtel <[email protected]> <[email protected]>
Quoted 5 lines
Ok, with
scripts/kernel-doc, I can produce some html files containing the functions' documentation.make pdfdocs or others targets don't work :|
You probarly need some additional packages.
But it's not easy to help you with no log of what happened.
Sam
Le Saturday 20 August 2005 a 09:08, Sam Ravnborg ecrivait:
Quoted 8 lines
Quoted 5 lines
Ok, with
scripts/kernel-doc, I can produce some html files containing the functions' documentation.make pdfdocs or others targets don't work :|
You probarly need some additional packages.
But it's not easy to help you with no log of what happened.
Yes, sorry,
Kernel : 2.6.12 from the git repository of Linus.
In make_docs.log.tar.bz2, you can find log files from make htmldocs, make psdocs and make pdfdocs.
Thanks,
Stephane
Signature · 2 lines
Stephane Wirtel <[email protected]> <[email protected]>
Quoted 9 lines · Stephane Wirtel
Le Saturday 20 August 2005 a 09:08, Sam Ravnborg ecrivait:
Quoted 8 lines
Quoted 5 lines
Ok, with
scripts/kernel-doc, I can produce some html files containing the functions' documentation.make pdfdocs or others targets don't work :|
You probarly need some additional packages.
But it's not easy to help you with no log of what happened.
Quoted 8 lines
Yes, sorry,
Kernel : 2.6.12 from the git repository of Linus.
In make_docs.log.tar.bz2, you can find log files from make htmldocs, make psdocs and make pdfdocs.
From your log-files I could not see what went wrong. It seems to be
error in the generated files.
Maybe Martin can help - Martin?
Sam
Le Saturday 20 August 2005 a 19:08, Sam Ravnborg ecrivait:
Quoted 12 lines · Stephane Wirtel
Quoted 11 lines
Le Saturday 20 August 2005 a 09:08, Sam Ravnborg ecrivait:
Quoted 8 lines
Quoted 5 lines
Ok, with
scripts/kernel-doc, I can produce some html files containing the functions' documentation.make pdfdocs or others targets don't work :|
You probarly need some additional packages.
But it's not easy to help you with no log of what happened.Yes, sorry,
Quoted 8 lines
Quoted 4 lines
Kernel : 2.6.12 from the git repository of Linus.
In make_docs.log.tar.bz2, you can find log files from make htmldocs, make psdocs and make pdfdocs.
From your log-files I could not see what went wrong. It seems to be error in the generated files.
Maybe Martin can help - Martin?
No news from Martin,
Sam, Could you generate the documentation in PDF format, and send me ?
Thanks,
Stephane
Signature · 2 lines
Stephane Wirtel <[email protected]> <[email protected]>
hoi :)
Quoted 5 lines · Sam Ravnborg
Quoted 2 lines
In make_docs.log.tar.bz2, you can find log files from make htmldocs, make psdocs and make pdfdocs.
From your log-files I could not see what went wrong. It seems to be error in the generated files.
kerneldoc could not understand a macro definition.
please try
http://tali.admingilde.org/patches/linux-docbook/docbook-fixes.patch
Signature · 1 line
Martin Waitz
Quoted 11 lines · Sam Ravnborg
Quoted 5 lines
Quoted 2 lines
In make_docs.log.tar.bz2, you can find log files from make htmldocs, make psdocs and make pdfdocs.
From your log-files I could not see what went wrong. It seems to be error in the generated files.
kerneldoc could not understand a macro definition.
please try
http://tali.admingilde.org/patches/linux-docbook/docbook-fixes.patch
Martin, your patch works for the htmldocs target, but not for the pdfdocs, I think there is a bug in a latex package. I don't know which one, but it's the same error.
Thanks for your patch,
Stephane
Signature · 2 lines
Stephane Wirtel <[email protected]> <[email protected]>
hoi :)
Quoted 3 lines · Stephane Wirtel
Martin, your patch works for the htmldocs target, but not for the pdfdocs, I think there is a bug in a latex package. I don't know which one, but it's the same error.
yes, some pdfdocs are broken and I haven't found the cause yet. I guess we have to ditch xmlto, at least for PDF/PS.
Signature · 1 line
Martin Waitz