diff mbox

[2/2] media: dvb-core: fix demux.h non-ASCII characters

Message ID 5fb15c64-e376-f461-8a7c-d0c6776870c9@infradead.org (mailing list archive)
State New, archived
Headers show

Commit Message

Randy Dunlap Aug. 28, 2017, 11:10 p.m. UTC 
From: Randy Dunlap <rdunlap@infradead.org>

Fix non-ASCII charactes in kernel-doc comment to prevent the kernel-doc
build warning below.

WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno ../drivers/media/dvb-core/demux.h' processing failed with: 'ascii' codec can't decode byte 0xe2 in position 6368: ordinal not in range(128)

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
 drivers/media/dvb-core/demux.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jonathan Corbet Aug. 30, 2017, 9:24 p.m. UTC | #1 
On Mon, 28 Aug 2017 16:10:16 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:

> Fix non-ASCII charactes in kernel-doc comment to prevent the kernel-doc
> build warning below.
> 
> WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno ../drivers/media/dvb-core/demux.h' processing failed with: 'ascii' codec can't decode byte 0xe2 in position 6368: ordinal not in range(128)

I'll leave this one for Mauro to decide on.  My inclination would be to
apply it, though, my previous comments on handling non-ASCII text
notwithstanding.  The weird quotes don't buy us anything here.

Thanks,

jon
Mauro Carvalho Chehab Aug. 30, 2017, 10:17 p.m. UTC | #2 
Em Wed, 30 Aug 2017 15:24:30 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Mon, 28 Aug 2017 16:10:16 -0700
> Randy Dunlap <rdunlap@infradead.org> wrote:
> 
> > Fix non-ASCII charactes in kernel-doc comment to prevent the kernel-doc
> > build warning below.
> > 
> > WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno ../drivers/media/dvb-core/demux.h' processing failed with: 'ascii' codec can't decode byte 0xe2 in position 6368: ordinal not in range(128)  
> 
> I'll leave this one for Mauro to decide on.  My inclination would be to
> apply it, though, my previous comments on handling non-ASCII text
> notwithstanding.  The weird quotes don't buy us anything here.

Yeah, it doesn't make sense to have this character there.

I'll apply it on my tree. Yet, I'm considering adding an UTF-8
character on a kernel-doc markup.

One DVB parameter is called "Rolloff", and its usual symbol is
the greek letter alpha. There, it would make sense to use a
non-ascII character.

By coincidence, I just wrote such patch earlier today.

Regards,
Mauro
diff mbox

Patch

--- lnx-413-rc7.orig/drivers/media/dvb-core/demux.h
+++ lnx-413-rc7/drivers/media/dvb-core/demux.h
@@ -210,7 +210,7 @@  struct dmx_section_feed {
  * the start of the first undelivered TS packet within a circular buffer.
  * The @buffer2 buffer parameter is normally NULL, except when the received
  * TS packets have crossed the last address of the circular buffer and
- * ”wrapped” to the beginning of the buffer. In the latter case the @buffer1
+ * "wrapped" to the beginning of the buffer. In the latter case the @buffer1
  * parameter would contain an address within the circular buffer, while the
  * @buffer2 parameter would contain the first address of the circular buffer.
  * The number of bytes delivered with this function (i.e. @buffer1_length +