Re: [PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd
From: Jarkko Sakkinen
Date: Tue Nov 22 2016 - 05:19:14 EST
On Tue, Nov 22, 2016 at 09:44:20AM +0000, Winkler, Tomas wrote:
> >
> > On Wed, Nov 16, 2016 at 07:03:38PM +0200, Tomas Winkler wrote:
> > > Functions tpm_transmit and transmit_cmd are referenced from other
> > > functions kdoc hence deserve documentation.
> > >
> > > Signed-off-by: Tomas Winkler <tomas.winkler@xxxxxxxxx>
> >
> > Do you know how to make "make htmldocs" to generate documentation for the
> > source tree? I do not except the ones that I imported when I created an RST
> > version of the Stefans documentation.
>
> I'm using a quick script like that
> RES=tpm-kdoc.html
> rm -r $RES kdoc.err
> files=$(git ls-files drivers/char/tpm/*.[ch] includ/linux/tpm.h includ/linux/tpm_command.h)
>
> echo '<html>' > $RES
> for f in ${files}; do
> ./scripts/kernel-doc -html $f >> $RES 2>> kdoc.err
> done
> echo '</html>' >> $RES
> cat kdoc.err | grep -v 'warning: no structured comments found'
Thanks. I'll try this as soon as the release chaos is over.
/Jarkko