All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Next Mailing List <linux-next@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux Sound System <linux-sound@vger.kernel.org>
Cc: "Jaroslav Kysela" <perex@perex.cz>,
	"Takashi Iwai" <tiwai@suse.com>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Amadeusz Sławiński" <amadeuszx.slawinski@linux.intel.com>,
	"Palmer Dabbelt" <palmer@rivosinc.com>,
	"Bagas Sanjaya" <bagasdotme@gmail.com>,
	"Stephen Rothwell" <sfr@canb.auug.org.au>
Subject: [PATCH 1/2] ALSA: docs: compress-accel: Format state machine flowchart as code block
Date: Mon, 28 Oct 2024 18:16:46 +0700	[thread overview]
Message-ID: <20241028111647.17378-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20241028111647.17378-1-bagasdotme@gmail.com>

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@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20241028193242.11597640@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.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


  reply	other threads:[~2024-10-28 11:17 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-28 11:16 [PATCH 0/2] Documentation fixes for ALSA Co-processor Acceleration API Bagas Sanjaya
2024-10-28 11:16 ` Bagas Sanjaya [this message]
2024-10-28 11:16 ` [PATCH 2/2] ALSA: docs: Add toctree index entry for co-processor acceleration API Bagas Sanjaya
2024-10-28 15:04 ` [PATCH 0/2] Documentation fixes for ALSA Co-processor Acceleration API Takashi Iwai

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241028111647.17378-2-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=amadeuszx.slawinski@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=linux-sound@vger.kernel.org \
    --cc=palmer@rivosinc.com \
    --cc=perex@perex.cz \
    --cc=sfr@canb.auug.org.au \
    --cc=tiwai@suse.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.