Re: [PATCH 26/26] docs: i2c: rename sections so the overall picture is clearer

Jean Delvare
2020-01-16T09:49:11Z

On Mon, 6 Jan 2020 08:49:05 +0100, Luca Ceresoli wrote:
> Some of the section names are not very clear. Reading those names in the
> index.rst page does not help much in grasping what the content is supposed
> to be.
>
> Rename those sections to clarify their content, especially when reading
> the index page.
>
> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
> Acked-by: Peter Rosin <peda@axentia.se>
> ---
>
> Note: here checkpatch complains:
>
> WARNING: Missing or malformed SPDX-License-Identifier tag in line 1
>
> Thas's because those files have no license line. I would gladly add a
> proper license line, but what it the correct license here? Should I ask the
> authors? GPLv2-only as the kernel default?
>
> I'd appreciate a guidance here, thanks in advance.

I don't think we need a license for such documentation files, so I
would just ignore checkpatch.

> ---
> Documentation/i2c/dev-interface.rst | 6 +++---
> Documentation/i2c/i2c-protocol.rst | 6 +++---
> Documentation/i2c/i2c-topology.rst | 6 +++---
> Documentation/i2c/old-module-parameters.rst | 6 +++---
> Documentation/i2c/smbus-protocol.rst | 6 +++---
> Documentation/i2c/summary.rst | 6 +++---
> Documentation/i2c/writing-clients.rst | 6 +++---
> 7 files changed, 21 insertions(+), 21 deletions(-)
> (...)
> diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
> index fc69d9567d9d..ae3bbb9fd8f1 100644
> --- a/Documentation/i2c/summary.rst
> +++ b/Documentation/i2c/summary.rst
> @@ -1,6 +1,6 @@
> -=============
> -I2C and SMBus
> -=============
> +==============================
> +Introductions to I2C and SMBus
> +==============================

I would use "Introduction", singular.

>
> I²C (pronounce: I squared C and written I2C in the kernel documentation) is
> a protocol developed by Philips. It is a slow two-wire protocol (variable
> (...)

Reviewed-by: Jean Delvare <jdelvare@suse.de>

--
Jean Delvare
SUSE L3 Support