linux-kernel - htmldocs: Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3997: WARNING: Literal block expected; none found.

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

Date:   Tue, 2 May 2023 18:33:15 +0800
From:   kernel test robot <lkp@...el.com>
To:     Oswald Buddenhagen <oswald.buddenhagen@....de>
Cc:     oe-kbuild-all@...ts.linux.dev, linux-kernel@...r.kernel.org,
        Takashi Iwai <tiwai@...e.de>, linux-doc@...r.kernel.org
Subject: htmldocs:
 Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3997: WARNING:
 Literal block expected; none found.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   865fdb08197e657c59e74a35fa32362b12397f58
commit: 4d421eebe1465d94b95867dd025385dc3d661f9b ALSA: docs: writing-an-alsa-driver.rst: polishing
date:   11 days ago
reproduce:
        # https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4d421eebe1465d94b95867dd025385dc3d661f9b
        git remote add linus https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
        git fetch --no-tags linus master
        git checkout 4d421eebe1465d94b95867dd025385dc3d661f9b
        make menuconfig
        # enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS
        make htmldocs

If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@...el.com>
| Link: https://lore.kernel.org/oe-kbuild-all/202305021822.4U6XOvGf-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> 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:4009: WARNING: Unexpected indentation.

vim +3997 Documentation/sound/kernel-api/writing-an-alsa-driver.rst

7ddedebb03b7ec Takashi Iwai       2016-09-29  3994  
4d421eebe1465d Oswald Buddenhagen 2023-04-21  3995     Suppose you have a file xyz.c. Add the following two lines::
7ddedebb03b7ec Takashi Iwai       2016-09-29  3996  
7ddedebb03b7ec Takashi Iwai       2016-09-29 @3997    snd-xyz-objs := xyz.o
7ddedebb03b7ec Takashi Iwai       2016-09-29  3998    obj-$(CONFIG_SND_XYZ) += snd-xyz.o
7ddedebb03b7ec Takashi Iwai       2016-09-29  3999  
7ddedebb03b7ec Takashi Iwai       2016-09-29  4000  2. Create the Kconfig entry
7ddedebb03b7ec Takashi Iwai       2016-09-29  4001  
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4002     Add the new entry of Kconfig for your xyz driver::
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4003  
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4004    config SND_XYZ
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4005      tristate "Foobar XYZ"
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4006      depends on SND
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4007      select SND_PCM
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4008      help
4d421eebe1465d Oswald Buddenhagen 2023-04-21 @4009        Say Y here to include support for Foobar XYZ soundcard.
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4010        To compile this driver as a module, choose M here:
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4011        the module will be called snd-xyz.
4d421eebe1465d Oswald Buddenhagen 2023-04-21  4012  

:::::: The code at line 3997 was first introduced by commit
:::::: 7ddedebb03b7ec030c528ebacdd43e45373476e3 ALSA: doc: ReSTize writing-an-alsa-driver document

:::::: TO: Takashi Iwai <tiwai@...e.de>
:::::: CC: Takashi Iwai <tiwai@...e.de>

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests