[lkml]   [2019]   [Aug]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
SubjectRe: Best practice for embedded code samles? [Was: drm/drv: Use // for comments in example code]
On Tue, 13 Aug 2019, Jonathan Corbet <> wrote:
> On Sun, 11 Aug 2019 23:32:15 +0200
> Sam Ravnborg <> wrote:
>> I wonder if there is a better way to embed a code sample
>> than reverting to // style comments.
>> As the kernel do not like // comments we should try to avoid them in
>> examples.
> If you're embedding a code sample *into a code comment* then I suspect
> this is about as good as it gets. The alternative is to put it in as a
> plain literal text block. That would lose the syntax highlighting; I
> think that's an entirely bearable cost, but others seem to feel
> differently about it.

Not really a Sphinx limitation, is it? You can't embed a /* */ block
comment within a /* */ block comment anyway, Sphinx or not.


Jani Nikula, Intel Open Source Graphics Center

 \ /
  Last update: 2019-08-14 09:39    [W:0.048 / U:10.680 seconds]
©2003-2018 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site