Re: [PATCH] docs: sound: kernel-api: writing-an-alsa-driver.rst: polishing

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Oswald,

kernel test robot noticed the following build warnings:

[auto build test WARNING on tiwai-sound/for-next]
[also build test WARNING on next-20230406]
[cannot apply to tiwai-sound/for-linus linus/master v6.3-rc5]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Oswald-Buddenhagen/docs-sound-kernel-api-writing-an-alsa-driver-rst-polishing/20230406-042253
base:   https://git.kernel.org/pub/scm/linux/kernel/git/tiwai/sound.git for-next
patch link:    https://lore.kernel.org/r/20230405201220.2197863-1-oswald.buddenhagen%40gmx.de
patch subject: [PATCH] docs: sound: kernel-api: writing-an-alsa-driver.rst: polishing
reproduce:
        # https://github.com/intel-lab-lkp/linux/commit/7d621283190964e9edd72b8960fe9819339d62d8
        git remote add linux-review https://github.com/intel-lab-lkp/linux
        git fetch --no-tags linux-review Oswald-Buddenhagen/docs-sound-kernel-api-writing-an-alsa-driver-rst-polishing/20230406-042253
        git checkout 7d621283190964e9edd72b8960fe9819339d62d8
        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@xxxxxxxxx>
| Link: https://lore.kernel.org/oe-kbuild-all/202304062227.WvZq9Td4-lkp@xxxxxxxxx/

All warnings (new ones prefixed by >>):

>> Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3992: WARNING: Literal block expected; none found.
>> Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4004: WARNING: Unexpected indentation.

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

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

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



[Index of Archives]     [ALSA User]     [Linux Audio Users]     [Pulse Audio]     [Kernel Archive]     [Asterisk PBX]     [Photo Sharing]     [Linux Sound]     [Video 4 Linux]     [Gimp]     [Yosemite News]

  Powered by Linux