[Documentation] Use doxygen or another tool to generate a documentation ?

[Documentation] Use doxygen or another tool to generate a documentation ?

[Stephane Wirtel]

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

-- 
Stephane Wirtel <stephane.wirtel@belgacom.net>
                <stephane.wirtel@gmail.com>

Re: [Documentation] Use doxygen or another tool to generate a documentation ?

[Pekka Enberg]

On 8/20/05, Stephane Wirtel <stephane.wirtel@belgacom.net> wrote:
> 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

Re: [Documentation] Use doxygen or another tool to generate a documentation ?

[Stephane Wirtel]

Le Saturday 20 August 2005 a 00:08, Pekka Enberg ecrivait: 
> On 8/20/05, Stephane Wirtel <stephane.wirtel@belgacom.net> wrote:
> > 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.

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
-- 
Stephane Wirtel <stephane.wirtel@belgacom.net>
                <stephane.wirtel@gmail.com>

Re: [Documentation] Use doxygen or another tool to generate a documentation ?

[Sam Ravnborg]

> 
> 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

Re: [Documentation] Use doxygen or another tool to generate a documentation ?

[Stephane Wirtel]

[-- Attachment #1: Type: text/plain, Size: 626 bytes --]

Le Saturday 20 August 2005 a 09:08, Sam Ravnborg ecrivait: 
> > 
> > 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



-- 
Stephane Wirtel <stephane.wirtel@belgacom.net>
                <stephane.wirtel@gmail.com>



[-- Attachment #2: make_docs.log.tar.bz2 --]
[-- Type: application/octet-stream, Size: 3152 bytes --]

Re: [Documentation] Use doxygen or another tool to generate a documentation ?

[Sam Ravnborg]

On Sat, Aug 20, 2005 at 11:19:41AM +0200, Stephane Wirtel wrote:
> Le Saturday 20 August 2005 a 09:08, Sam Ravnborg ecrivait: 
> > > 
> > > 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.

>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

Re: [Documentation] Use doxygen or another tool to generate a documentation ?

[Stephane Wirtel]

Le Saturday 20 August 2005 a 19:08, Sam Ravnborg ecrivait: 
> On Sat, Aug 20, 2005 at 11:19:41AM +0200, Stephane Wirtel wrote:
> > Le Saturday 20 August 2005 a 09:08, Sam Ravnborg ecrivait: 
> > > > 
> > > > 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.
> 
> 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 
-- 
Stephane Wirtel <stephane.wirtel@belgacom.net>
                <stephane.wirtel@gmail.com>

Re: [Documentation] Use doxygen or another tool to generate a documentation ?

[Martin Waitz]

[-- Attachment #1: Type: text/plain, Size: 449 bytes --]

hoi :)

On Sat, Aug 20, 2005 at 07:37:06PM +0200, Sam Ravnborg wrote:
> > 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 Waitz

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

Re: [Documentation] Use doxygen or another tool to generate a documentation ?

[Stephane Wirtel]

\b

> On Sat, Aug 20, 2005 at 07:37:06PM +0200, Sam Ravnborg wrote:
> > > 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

-- 
Stephane Wirtel <stephane.wirtel@belgacom.net>
                <stephane.wirtel@gmail.com>

Re: [Documentation] Use doxygen or another tool to generate a documentation ?

[Martin Waitz]

[-- Attachment #1: Type: text/plain, Size: 394 bytes --]

hoi :)

On Sun, Aug 21, 2005 at 08:32:42PM +0200, Stephane Wirtel wrote:
> 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.

-- 
Martin Waitz

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 189 bytes --]