Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20200727025323.26712-1-tianjia.zhang@linux.alibaba.com>
In-Reply-To: <20200727025323.26712-1-tianjia.zhang@linux.alibaba.com>
From:   Arnd Bergmann <arnd@arndb.de>
Date:   Mon, 27 Jul 2020 09:10:50 +0200
Message-ID: <CAK8P3a2neQUP2marbRUxpSZE4OTJtf97JKSK5-LC6EzH8rRHDQ@mail.gmail.com>
Subject: Re: [PATCH] tpm: Fix the description error of the help information in Kconfig
To:     Tianjia Zhang <tianjia.zhang@linux.alibaba.com>
Cc:     Peter Huewe <peterhuewe@gmx.de>,
        Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>,
        Jason Gunthorpe <jgg@ziepe.ca>,
        gregkh <gregkh@linuxfoundation.org>,
        linux-integrity@vger.kernel.org,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        Christophe Ricard <christophe.ricard@gmail.com>,
        Peter Huewe <peter.huewe@infineon.com>,
        Alexander Steffen <Alexander.Steffen@infineon.com>
Content-Type: text/plain; charset="UTF-8"
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Mon, Jul 27, 2020 at 4:54 AM Tianjia Zhang
<tianjia.zhang@linux.alibaba.com> wrote:
>
> Obviously, the TPM version number in the help message is wrong, which
> will cause confusion. This patch fixes it.

How is this "obvious"? I tried finding the specification and could not
see anything
to back up TIS 1.3 being only supported with TPM 1.3, or the existence of a
TPM 1.3 specification at all.

Please consider that not everyone reading this patch description is deeply
familiar with the details and explain exactly what the mistake is.

> Signed-off-by: Tianjia Zhang <tianjia.zhang@linux.alibaba.com>

In a bug fix, try to always add a 'FIxes' tag such as 'Fixes: 0edbfea537d1
("tpm/tpm_tis_spi: Add support for spi phy")', and Cc everyone that was
involved in the original patch that introduced a bug so they can Ack or
Nak it.

      Arnd

>  drivers/char/tpm/Kconfig | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/char/tpm/Kconfig b/drivers/char/tpm/Kconfig
> index 58b4c573d176..8eedb3e704f3 100644
> --- a/drivers/char/tpm/Kconfig
> +++ b/drivers/char/tpm/Kconfig
> @@ -62,7 +62,7 @@ config TCG_TIS_SPI
>         help
>           If you have a TPM security chip which is connected to a regular,
>           non-tcg SPI master (i.e. most embedded platforms) that is compliant with the
> -         TCG TIS 1.3 TPM specification (TPM1.2) or the TCG PTP FIFO
> +         TCG TIS 1.3 TPM specification (TPM1.3) or the TCG PTP FIFO
>           specification (TPM2.0) say Yes and it will be accessible from
>           within Linux. To compile this driver as a module, choose  M here;
>           the module will be called tpm_tis_spi.
> --
> 2.17.1
>