]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/commitdiff
media: netup_unidvb: fix a bad kernel-doc markup
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 29 Nov 2017 14:10:03 +0000 (09:10 -0500)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Thu, 30 Nov 2017 09:18:58 +0000 (04:18 -0500)
There is a bad kernel-doc markup, producing the following warnings:

  drivers/media/pci/netup_unidvb/netup_unidvb_core.c:85: warning: bad line:  Bits [0-7]: DMA packet size, 188 bytes
  drivers/media/pci/netup_unidvb/netup_unidvb_core.c:86: warning: bad line:  Bits [16-23]: packets count in block, 128 packets
  drivers/media/pci/netup_unidvb/netup_unidvb_core.c:87: warning: bad line:  Bits [24-31]: blocks count, 8 blocks
  drivers/media/pci/netup_unidvb/netup_unidvb_core.c:89: warning: bad line:  For example, value of 375000000 equals to 3 sec

Fix that, and use a list for the bits option, in order for it
to be better format, if we add it to a driver's documentation
file.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
drivers/media/pci/netup_unidvb/netup_unidvb_core.c

index 11829c0fa138050df4a80be72da20d422e6f9c54..509d69e6ca4adc27e7d26d05367f9d75d96e656d 100644 (file)
@@ -82,11 +82,11 @@ DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nr);
  * @start_addr_lo:     DMA ring buffer start address, lower part
  * @start_addr_hi:     DMA ring buffer start address, higher part
  * @size:              DMA ring buffer size register
                      Bits [0-7]:     DMA packet size, 188 bytes
                      Bits [16-23]:   packets count in block, 128 packets
                      Bits [24-31]:   blocks count, 8 blocks
*                     * Bits [0-7]:   DMA packet size, 188 bytes
*                     * Bits [16-23]: packets count in block, 128 packets
*                     * Bits [24-31]: blocks count, 8 blocks
  * @timeout:           DMA timeout in units of 8ns
                      For example, value of 375000000 equals to 3 sec
*                     For example, value of 375000000 equals to 3 sec
  * @curr_addr_lo:      Current ring buffer head address, lower part
  * @curr_addr_hi:      Current ring buffer head address, higher part
  * @stat_pkt_received: Statistic register, not tested