tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

ALSA: docs: Fix code block indentation in ALSA driver example

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@intel.com>
Closes: https://lore.kernel.org/linux-doc/202305021822.4U6XOvGf-lkp@intel.com/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20230503035416.62722-1-bagasdotme@gmail.com
Signed-off-by: Takashi Iwai <tiwai@suse.de>

authored by

Bagas Sanjaya and committed by
Takashi Iwai e4212ed0 1604f51b

+11 -11
+11 -11
Documentation/sound/kernel-api/writing-an-alsa-driver.rst
··· 3994 3994 3995 3995 Suppose you have a file xyz.c. Add the following two lines:: 3996 3996 3997 - snd-xyz-objs := xyz.o 3998 - obj-$(CONFIG_SND_XYZ) += snd-xyz.o 3997 + snd-xyz-objs := xyz.o 3998 + obj-$(CONFIG_SND_XYZ) += snd-xyz.o 3999 3999 4000 4000 2. Create the Kconfig entry 4001 4001 4002 4002 Add the new entry of Kconfig for your xyz driver:: 4003 4003 4004 - config SND_XYZ 4005 - tristate "Foobar XYZ" 4006 - depends on SND 4007 - select SND_PCM 4008 - help 4009 - Say Y here to include support for Foobar XYZ soundcard. 4010 - To compile this driver as a module, choose M here: 4011 - the module will be called snd-xyz. 4004 + config SND_XYZ 4005 + tristate "Foobar XYZ" 4006 + depends on SND 4007 + select SND_PCM 4008 + help 4009 + Say Y here to include support for Foobar XYZ soundcard. 4010 + To compile this driver as a module, choose M here: 4011 + the module will be called snd-xyz. 4012 4012 4013 4013 The line ``select SND_PCM`` specifies that the driver xyz supports PCM. 4014 4014 In addition to SND_PCM, the following components are supported for ··· 4032 4032 1. Add a new directory (``sound/pci/xyz``) in ``sound/pci/Makefile`` 4033 4033 as below:: 4034 4034 4035 - obj-$(CONFIG_SND) += sound/pci/xyz/ 4035 + obj-$(CONFIG_SND) += sound/pci/xyz/ 4036 4036 4037 4037 4038 4038 2. Under the directory ``sound/pci/xyz``, create a Makefile::