]> asedeno.scripts.mit.edu Git - linux.git/commit
drm/drv: Use // for comments in example code
authorJonathan Neuschäfer <j.neuschaefer@gmx.net>
Thu, 8 Aug 2019 16:36:28 +0000 (18:36 +0200)
committerSam Ravnborg <sam@ravnborg.org>
Mon, 19 Aug 2019 17:21:49 +0000 (19:21 +0200)
commit56d8d6413d0218a0b3cebc5decdcaedc9a0b7e4e
tree51be1a4f28aa50da84e6e2fcf2d8e20beec4efdf
parent2989f6451084aed3f8cc9992477f7a9bf57a3716
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
drivers/gpu/drm/drm_drv.c