diff options
author | Jonathan Neuschäfer <j.neuschaefer@gmx.net> | 2019-08-08 18:36:28 +0200 |
---|---|---|
committer | Sam Ravnborg <sam@ravnborg.org> | 2019-08-19 19:21:49 +0200 |
commit | 56d8d6413d0218a0b3cebc5decdcaedc9a0b7e4e (patch) | |
tree | 51be1a4f28aa50da84e6e2fcf2d8e20beec4efdf /drivers/gpu/drm/i915/Kconfig.debug | |
parent | 2989f6451084aed3f8cc9992477f7a9bf57a3716 (diff) |
drm/drv: Use // for comments in example code
This improves Sphinx output in two ways:
- It avoids an unmatched single-quote ('), about which Sphinx complained:
Documentation/gpu/drm-internals.rst:298:
WARNING: Could not lex literal_block as "c". Highlighting skipped.
An alternative approach would be to replace "can't" with a word that
doesn't have a single-quote.
- It lets Sphinx format the comments in italics and grey, making the
code slightly easier to read.
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Acked-by: Daniel Vetter <daniel@ffwll.ch> [via irc]
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20190808163629.14280-1-j.neuschaefer@gmx.net
Diffstat (limited to 'drivers/gpu/drm/i915/Kconfig.debug')
0 files changed, 0 insertions, 0 deletions