From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932611AbcKCM5T (ORCPT ); Thu, 3 Nov 2016 08:57:19 -0400 Received: from mga07.intel.com ([134.134.136.100]:47255 "EHLO mga07.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932467AbcKCM5R (ORCPT ); Thu, 3 Nov 2016 08:57:17 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,438,1473145200"; d="scan'208";a="781926077" Date: Thu, 3 Nov 2016 06:57:12 -0600 From: Jarkko Sakkinen To: Jani Nikula Cc: tpmdd-devel@lists.sourceforge.net, Jonathan Corbet , Peter Huewe , Marcel Selhorst , Jason Gunthorpe , Stefan Berger , "open list:DOCUMENTATION" , open list Subject: Re: [PATCH] tpm: transition tpm_vtpm_proxy documentation to the Sphinx Message-ID: <20161103125712.qrjlabme5r3lupjy@intel.com> References: <20161102180207.16583-1-jarkko.sakkinen@linux.intel.com> <874m3pj7n3.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <874m3pj7n3.fsf@intel.com> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo User-Agent: Mutt/1.6.2-neo (2016-08-21) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, Nov 03, 2016 at 10:21:36AM +0200, Jani Nikula wrote: > On Wed, 02 Nov 2016, Jarkko Sakkinen 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 > > --- > > 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