From: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>
To: "Winkler, Tomas" <tomas.winkler@intel.com>
Cc: "tpmdd-devel@lists.sourceforge.net"
<tpmdd-devel@lists.sourceforge.net>,
Jason Gunthorpe <jgunthorpe@obsidianresearch.com>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd
Date: Tue, 22 Nov 2016 12:19:02 +0200 [thread overview]
Message-ID: <20161122101902.mkjoaajjvicd7ia5@intel.com> (raw)
In-Reply-To: <5B8DA87D05A7694D9FA63FD143655C1B5432F79C@hasmsx108.ger.corp.intel.com>
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
next prev parent reply other threads:[~2016-11-22 10:19 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-16 17:03 [PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd Tomas Winkler
2016-11-16 17:03 ` [PATCH 2/4 v2] tpm/tpm2-chip: fix kdoc errors Tomas Winkler
2016-11-24 13:16 ` Jarkko Sakkinen
2016-11-16 17:03 ` [PATCH 3/4 v2] tmp: use pdev for parent device in tpm_chip_alloc Tomas Winkler
2016-11-24 13:17 ` Jarkko Sakkinen
2016-11-16 17:03 ` [PATCH 4/4] tpm/vtpm: fix kdoc warnings Tomas Winkler
2016-11-16 23:00 ` [PATCH 1/4] tpm: add kdoc for tpm_transmit and tpm_transmit_cmd Jarkko Sakkinen
2016-11-22 9:44 ` Winkler, Tomas
2016-11-22 10:19 ` Jarkko Sakkinen [this message]
2016-11-24 13:11 ` Jarkko Sakkinen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20161122101902.mkjoaajjvicd7ia5@intel.com \
--to=jarkko.sakkinen@linux.intel.com \
--cc=jgunthorpe@obsidianresearch.com \
--cc=linux-kernel@vger.kernel.org \
--cc=tomas.winkler@intel.com \
--cc=tpmdd-devel@lists.sourceforge.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox