2024-02-16 05:16:52

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH -next] spi: spi-summary.rst: fix underline length

The change to use "target" requires an underline to be extended by
one more character to fix a documentation build warning:

Documentation/spi/spi-summary.rst:274: WARNING: Title underline too short.
Declare target Devices
^^^^^^^^^^^^^^^^^^^^^

Fixes: hash ("spi: Update the "master/slave" terminology in documentation")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Dhruva Gole <[email protected]>
Cc: Mark Brown <[email protected]>
Cc: [email protected]
---
Documentation/spi/spi-summary.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/Documentation/spi/spi-summary.rst b/Documentation/spi/spi-summary.rst
--- a/Documentation/spi/spi-summary.rst
+++ b/Documentation/spi/spi-summary.rst
@@ -271,7 +271,7 @@ an external clock, where another derives
settings of some master clock.

Declare target Devices
-^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^

The second kind of information is a list of what SPI target devices exist
on the target board, often with some board-specific data needed for the


2024-02-16 05:42:58

by Dhruva Gole

[permalink] [raw]
Subject: Re: [PATCH -next] spi: spi-summary.rst: fix underline length

Hi,

On Feb 15, 2024 at 21:16:37 -0800, Randy Dunlap wrote:
> The change to use "target" requires an underline to be extended by
> one more character to fix a documentation build warning:
>
> Documentation/spi/spi-summary.rst:274: WARNING: Title underline too short.
> Declare target Devices
> ^^^^^^^^^^^^^^^^^^^^^

Oops, looks like I missed it.

>
> Fixes: hash ("spi: Update the "master/slave" terminology in documentation")
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Dhruva Gole <[email protected]>
> Cc: Mark Brown <[email protected]>
> Cc: [email protected]
> ---
> Documentation/spi/spi-summary.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/Documentation/spi/spi-summary.rst b/Documentation/spi/spi-summary.rst
> --- a/Documentation/spi/spi-summary.rst
> +++ b/Documentation/spi/spi-summary.rst
> @@ -271,7 +271,7 @@ an external clock, where another derives
> settings of some master clock.
>
> Declare target Devices
> -^^^^^^^^^^^^^^^^^^^^^
> +^^^^^^^^^^^^^^^^^^^^^^

Good catch,
Reviewed-by: Dhruva Gole <[email protected]>

Mark,
Will you be just squashing the commits since they're still in next
or will this be a separate commit? Just curious how fixes work while
they're still not in any mainline linux tree

--
Best regards,
Dhruva Gole <[email protected]>

2024-02-19 16:33:20

by Mark Brown

[permalink] [raw]
Subject: Re: [PATCH -next] spi: spi-summary.rst: fix underline length

On Thu, 15 Feb 2024 21:16:37 -0800, Randy Dunlap wrote:
> The change to use "target" requires an underline to be extended by
> one more character to fix a documentation build warning:
>
> Documentation/spi/spi-summary.rst:274: WARNING: Title underline too short.
> Declare target Devices
> ^^^^^^^^^^^^^^^^^^^^^
>
> [...]

Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-next

Thanks!

[1/1] spi: spi-summary.rst: fix underline length
commit: afd2a4ae296d5e8b13aefb056c1060ddf302a199

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark