On Thu, Nov 03, 2016 at 10:21:36AM +0200, Jani Nikula wrote:
> On Wed, 02 Nov 2016, Jarkko Sakkinen <jarkko.sakkinen@xxxxxxxxxxxxxxx> wrote:
> > Transitioned the tpm_vtpm_proxy documentation to the Sphinx
> > infrastructure and removed parts from the documentation that are easier
> > to pull from the sources. Restructured vtpm_proxy.h and tpm_vtpm_proxy.c
> > to be compatible with this approach and wrote associated documentation
> > comments.
> >
> > Signed-off-by: Jarkko Sakkinen <jarkko.sakkinen@xxxxxxxxxxxxxxx>
> > ---
> > Documentation/index.rst | 1 +
> > Documentation/tpm/index.rst | 7 +++
> > .../tpm/{tpm_vtpm_proxy.txt => tpm_vtpm_proxy.rst} | 53 +++++-----------
> > drivers/char/tpm/tpm_vtpm_proxy.c | 72 ++++++++++++++--------
> > include/uapi/linux/vtpm_proxy.h | 23 +++++--
>
> I'm not sure it's a good idea to combine this much code change with the
> documentation change. Perhaps split up, at least the function
> movement/abstraction bits?
Sure. I scraped this up quickly to get some feedback whether I'm doing
this right at all :-)
>
> > 5 files changed, 89 insertions(+), 67 deletions(-)
> > create mode 100644 Documentation/tpm/index.rst
> > rename Documentation/tpm/{tpm_vtpm_proxy.txt => tpm_vtpm_proxy.rst} (56%)
> >
> > diff --git a/Documentation/index.rst b/Documentation/index.rst
> > index e0fc729..0058b65 100644
> > --- a/Documentation/index.rst
> > +++ b/Documentation/index.rst
> > @@ -19,6 +19,7 @@ Contents:
> > media/dvb-drivers/index
> > media/v4l-drivers/index
> > gpu/index
> > + tpm/index
> >
> > Indices and tables
> > ==================
> > diff --git a/Documentation/tpm/index.rst b/Documentation/tpm/index.rst
> > new file mode 100644
> > index 0000000..316cdbb
> > --- /dev/null
> > +++ b/Documentation/tpm/index.rst
> > @@ -0,0 +1,7 @@
> > +=================
> > +TPM documentation
> > +=================
>
> This will pop up at the top level of the documentation. I'm not saying
> that's necessarily wrong per se, but IMO you should spell out Trusted
> Platform Module here instead of just using the acronym.
>
> (Sure we have "GPU" at the top level, but I think that's a better known
> acronym. And we might change that to "Graphics" anyway.)
Got you. I'll change it to Trusted Platform Module.
> BR,
> Jani.
>
>
> --
> Jani Nikula, Intel Open Source Technology Center
/Jarkko
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
