Messages in this thread Patch in this message | | | From | Randy Dunlap <> | Subject | [PATCH 1/2] docs: kernel-doc comments are ASCII | Date | Mon, 28 Aug 2017 16:10:09 -0700 |
| |
From: Randy Dunlap <rdunlap@infradead.org>
kernel-doc parsing uses as ASCII codec, so let people know that kernel-doc comments should be in ASCII characters only.
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> --- Documentation/doc-guide/kernel-doc.rst | 3 +++ 1 file changed, 3 insertions(+)
--- lnx-413-rc7.orig/Documentation/doc-guide/kernel-doc.rst +++ lnx-413-rc7/Documentation/doc-guide/kernel-doc.rst @@ -108,6 +108,9 @@ The function and type kernel-doc comment function or type being described. The overview kernel-doc comments may be freely placed at the top indentation level. +.. attention:: kernel-doc comments should be written **only** in ASCII + characters since they are processed as ASCII input. + Example kernel-doc function comment:: /**
| |