linux-kernel - [PATCH 1/2] ALSA: docs: compress-accel: Format state machine flowchart as code block

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20241028111647.17378-2-bagasdotme@gmail.com>
Date: Mon, 28 Oct 2024 18:16:46 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linux Next Mailing List <linux-next@...r.kernel.org>,
	Linux Documentation <linux-doc@...r.kernel.org>,
	Linux Sound System <linux-sound@...r.kernel.org>
Cc: Jaroslav Kysela <perex@...ex.cz>,
	Takashi Iwai <tiwai@...e.com>,
	Jonathan Corbet <corbet@....net>,
	Amadeusz Sławiński <amadeuszx.slawinski@...ux.intel.com>,
	Palmer Dabbelt <palmer@...osinc.com>,
	Bagas Sanjaya <bagasdotme@...il.com>,
	Stephen Rothwell <sfr@...b.auug.org.au>
Subject: [PATCH 1/2] ALSA: docs: compress-accel: Format state machine flowchart as code block

Stephen Rothwell reports multiple htmldocs indentation warnings when
merging sound tree for linux-next:

Documentation/sound/designs/compress-accel.rst:67: ERROR: Unexpected indentation.
Documentation/sound/designs/compress-accel.rst:67: WARNING: Blank line required after table.
Documentation/sound/designs/compress-accel.rst:68: WARNING: Line block ends without a blank line.
Documentation/sound/designs/compress-accel.rst:72: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/sound/designs/compress-accel.rst:73: WARNING: Block quote ends without a blank line; unexpected unindent.

Fix these above by wrapping passthrough audio stream state machine
flowchart in a literal code block.

Fixes: 04177158cf98 ("ALSA: compress_offload: introduce accel operation mode")
Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20241028193242.11597640@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 Documentation/sound/designs/compress-accel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/sound/designs/compress-accel.rst b/Documentation/sound/designs/compress-accel.rst
index abf1f76a87785c..c9c1744b94c2c0 100644
--- a/Documentation/sound/designs/compress-accel.rst
+++ b/Documentation/sound/designs/compress-accel.rst
@@ -57,7 +57,7 @@ from the input buffer size).
 State Machine
 =============
 
-The passthrough audio stream state machine is described below :
+The passthrough audio stream state machine is described below::
 
                                        +----------+
                                        |          |
-- 
An old man doll... just what I always wanted! - Clara