Skip to content

Commit e4212ed

Browse files
bagasmetiwai
authored andcommitted
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: 4d421ee ("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>
1 parent 1604f51 commit e4212ed

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3994,21 +3994,21 @@ Driver with A Single Source File
39943994

39953995
Suppose you have a file xyz.c. Add the following two lines::
39963996

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
39993999

40004000
2. Create the Kconfig entry
40014001

40024002
Add the new entry of Kconfig for your xyz driver::
40034003

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.
40124012

40134013
The line ``select SND_PCM`` specifies that the driver xyz supports PCM.
40144014
In addition to SND_PCM, the following components are supported for
@@ -4032,7 +4032,7 @@ located in the new subdirectory, sound/pci/xyz.
40324032
1. Add a new directory (``sound/pci/xyz``) in ``sound/pci/Makefile``
40334033
as below::
40344034

4035-
obj-$(CONFIG_SND) += sound/pci/xyz/
4035+
obj-$(CONFIG_SND) += sound/pci/xyz/
40364036

40374037

40384038
2. Under the directory ``sound/pci/xyz``, create a Makefile::

0 commit comments

Comments
 (0)