From: Sam Ravnborg <sam@ravnborg.org>
To: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
Cc: dri-devel@lists.freedesktop.org,
Maxime Ripard <maxime.ripard@bootlin.com>,
linux-kernel@vger.kernel.org, David Airlie <airlied@linux.ie>,
Sean Paul <sean@poorly.run>
Subject: Re: [PATCH] drm/drv: Use // for comments in example code
Date: Mon, 19 Aug 2019 19:06:55 +0200 [thread overview]
Message-ID: <20190819170655.GA27109@ravnborg.org> (raw)
In-Reply-To: <20190808163629.14280-1-j.neuschaefer@gmx.net>
Hi Jonathan.
Thanks for making this more readable in the html output.
On Thu, Aug 08, 2019 at 06:36:28PM +0200, Jonathan Neuschäfer wrote:
> 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>
I got Acked-by from Daniel Vetter and has now applied this patch
to drm-misc-next.
It will show up in linux-next after the merge window.
Sam
prev parent reply other threads:[~2019-08-19 17:07 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-08 16:36 [PATCH] drm/drv: Use // for comments in example code Jonathan Neuschäfer
2019-08-11 21:32 ` Best practice for embedded code samles? [Was: drm/drv: Use // for comments in example code] Sam Ravnborg
2019-08-13 22:07 ` Jonathan Corbet
2019-08-14 7:37 ` Jani Nikula
2019-08-19 17:06 ` Sam Ravnborg [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190819170655.GA27109@ravnborg.org \
--to=sam@ravnborg.org \
--cc=airlied@linux.ie \
--cc=dri-devel@lists.freedesktop.org \
--cc=j.neuschaefer@gmx.net \
--cc=linux-kernel@vger.kernel.org \
--cc=maxime.ripard@bootlin.com \
--cc=sean@poorly.run \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox