linux-kernel - Re: [PATCH] ALSA: docs: Fix code block indentation in ALSA driver example

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] [day] [month] [year] [list]

Message-ID: <87fs8endz6.wl-tiwai@suse.de>
Date:   Wed, 03 May 2023 08:09:01 +0200
From:   Takashi Iwai <tiwai@...e.de>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     Linux ALSA Subsystem Development <alsa-devel@...a-project.org>,
        Linux Documentation <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Jaroslav Kysela <perex@...ex.cz>,
        Takashi Iwai <tiwai@...e.com>,
        Jonathan Corbet <corbet@....net>,
        Oswald Buddenhagen <oswald.buddenhagen@....de>,
        Miquel Raynal <miquel.raynal@...tlin.com>,
        Takashi Sakamoto <o-takashi@...amocchi.jp>,
        kernel test robot <lkp@...el.com>
Subject: Re: [PATCH] ALSA: docs: Fix code block indentation in ALSA driver example

On Wed, 03 May 2023 05:54:16 +0200,
Bagas Sanjaya wrote:
> 
> Sphinx reports htmldocs warnings:
> 
> Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3997: WARNING: Literal block expected; none found.
> Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4004: WARNING: Literal block expected; none found.
> Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4009: WARNING: Unexpected indentation.
> Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4035: WARNING: Literal block expected; none found.
> 
> These are due to indentation of example driver snippets which is outside
> the code block scope.
> 
> Fix these by indenting code blocks in question to the scope.
> 
> Fixes: 4d421eebe1465d ("ALSA: docs: writing-an-alsa-driver.rst: polishing")
> Reported-by: kernel test robot <lkp@...el.com>
> Closes: https://lore.kernel.org/linux-doc/202305021822.4U6XOvGf-lkp@intel.com/
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>

Thanks, applied.


Takashi