Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > linux.kernel > #1527367
| From | Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> |
|---|---|
| Newsgroups | linux.kernel |
| Subject | Re: [PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd |
| Date | 2016-11-22 11:20 +0100 |
| Message-ID | <sGglb-5Su-7@gated-at.bofh.it> (permalink) |
| References | <sEaWB-56K-15@gated-at.bofh.it> <sEhv3-Uc-15@gated-at.bofh.it> <sGfSa-5nS-31@gated-at.bofh.it> |
| Organization | Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo |
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@intel.com>
> >
> > 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
Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread
[PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd Tomas Winkler <tomas.winkler@intel.com> - 2016-11-16 17:10 +0100
[PATCH 3/4 v2] tmp: use pdev for parent device in tpm_chip_alloc Tomas Winkler <tomas.winkler@intel.com> - 2016-11-16 17:10 +0100
Re: [PATCH 3/4 v2] tmp: use pdev for parent device in tpm_chip_alloc Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> - 2016-11-24 14:20 +0100
[PATCH 4/4] tpm/vtpm: fix kdoc warnings Tomas Winkler <tomas.winkler@intel.com> - 2016-11-16 17:10 +0100
Re: [PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> - 2016-11-17 00:10 +0100
RE: [PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd "Winkler, Tomas" <tomas.winkler@intel.com> - 2016-11-22 10:50 +0100
Re: [PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> - 2016-11-22 11:20 +0100
Re: [PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> - 2016-11-24 14:20 +0100
csiph-web