From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755849AbcKCIVn (ORCPT ); Thu, 3 Nov 2016 04:21:43 -0400 Received: from mga11.intel.com ([192.55.52.93]:60721 "EHLO mga11.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755731AbcKCIVl (ORCPT ); Thu, 3 Nov 2016 04:21:41 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,585,1473145200"; d="scan'208";a="781835155" From: Jani Nikula To: Jarkko Sakkinen , tpmdd-devel@lists.sourceforge.net Cc: Jarkko Sakkinen , 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 In-Reply-To: <20161102180207.16583-1-jarkko.sakkinen@linux.intel.com> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo References: <20161102180207.16583-1-jarkko.sakkinen@linux.intel.com> Date: Thu, 03 Nov 2016 10:21:36 +0200 Message-ID: <874m3pj7n3.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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? > 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.) BR, Jani. -- Jani Nikula, Intel Open Source Technology Center