linux-media.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: unlisted-recipients:; (no To-header on input)@bombadil.infradead.org
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Linux Media Mailing List <linux-media@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Sergey Kozlov <serjk@netup.ru>, Abylay Ospan <aospan@netup.ru>
Subject: [PATCH 08/22] media: netup_unidvb: fix a bad kernel-doc markup
Date: Wed, 29 Nov 2017 14:08:26 -0500	[thread overview]
Message-ID: <f7469ec9bf32f13642c8e63761263417cd8b0fe4.1511982439.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <73497577f67fbb917e40ab4328104ff310a7c356.1511982439.git.mchehab@s-opensource.com>
In-Reply-To: <73497577f67fbb917e40ab4328104ff310a7c356.1511982439.git.mchehab@s-opensource.com>

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 | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/media/pci/netup_unidvb/netup_unidvb_core.c b/drivers/media/pci/netup_unidvb/netup_unidvb_core.c
index 11829c0fa138..509d69e6ca4a 100644
--- a/drivers/media/pci/netup_unidvb/netup_unidvb_core.c
+++ b/drivers/media/pci/netup_unidvb/netup_unidvb_core.c
@@ -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
-- 
2.14.3

  parent reply	other threads:[~2017-11-29 19:08 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-29 19:08 [PATCH 01/22] media: sta2x11: document missing function parameters Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 02/22] media: pxa_camera: get rid of kernel_doc warnings Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 03/22] media: tw68: fix kernel-doc markups Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 04/22] media: ix2505v: get rid of /** comments Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 05/22] media: radio-si476x: fix kernel-doc markups Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 06/22] media: s5k6a3: document some fields at struct s5k6a3 Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 07/22] media: s5k6aa: describe some function parameters Mauro Carvalho Chehab
2017-11-30 19:17   ` Nicholas Mc Guire
2017-11-29 19:08 ` Mauro Carvalho Chehab [this message]
2017-11-29 19:08 ` [PATCH 09/22] media: tvp514x: fix kernel-doc parameters Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 10/22] media: vdec: fix some kernel-doc warnings Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 11/22] media: mtk-vpu: add description for wdt fields at struct mtk_vpu Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 12/22] media: s3c-camif: add missing description at s3c_camif_find_format() Mauro Carvalho Chehab
     [not found]   ` <CGME20171130095946epcas2p47a595044e5f5328db0b5a8a17e8888e2@epcas2p4.samsung.com>
2017-11-30  9:59     ` Sylwester Nawrocki
2017-11-29 19:08 ` [PATCH 13/22] media: radio-wl1273: fix a parameter name at kernel-doc macro Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 14/22] media: mt2063: fix some kernel-doc warnings Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 15/22] media: soc_camera: fix a kernel-doc markup Mauro Carvalho Chehab
2017-11-30  7:33   ` Guennadi Liakhovetski
2017-11-29 19:08 ` [PATCH 16/22] media: vsp1: add a missing kernel-doc parameter Mauro Carvalho Chehab
2017-11-30  9:32   ` Kieran Bingham
2017-11-29 19:08 ` [PATCH 17/22] media: rcar_jpu: fix two kernel-doc markups Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 18/22] media: lm3560: add a missing kernel-doc parameter Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 19/22] media: drivers: remove "/**" from non-kernel-doc comments Mauro Carvalho Chehab
2017-11-30  9:30   ` Kieran Bingham
2017-11-29 19:08 ` [PATCH 20/22] media: dvb_frontends: fix kernel-doc macros Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 21/22] media: docs: add documentation for frontend attach info Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 22/22] media: dvb-frontends: complete kernel-doc markups Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=f7469ec9bf32f13642c8e63761263417cd8b0fe4.1511982439.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=aospan@netup.ru \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=serjk@netup.ru \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).