2019-10-04 17:05:30

by J. Neuschäfer

[permalink] [raw]
Subject: [PATCH] docs: driver-api: pti_intel_mid: Enable syntax highlighting for C code block

This makes the code snippet more readable.

Signed-off-by: Jonathan Neuschäfer <[email protected]>
---
Documentation/driver-api/pti_intel_mid.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/driver-api/pti_intel_mid.rst b/Documentation/driver-api/pti_intel_mid.rst
index 20f1cff42d5f..bacc2a4ee89f 100644
--- a/Documentation/driver-api/pti_intel_mid.rst
+++ b/Documentation/driver-api/pti_intel_mid.rst
@@ -49,7 +49,9 @@ but is not just blindly executing as 'root'. Keep in mind
the use of ioctl(,TIOCSETD,) is not specific to the n_tracerouter
and n_tracesink line discpline drivers but is a generic
operation for a program to use a line discpline driver
-on a tty port other than the default n_tty::
+on a tty port other than the default n_tty:
+
+.. code-block:: c

/////////// To hook up n_tracerouter and n_tracesink /////////

--
2.20.1


2019-10-19 08:37:15

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] docs: driver-api: pti_intel_mid: Enable syntax highlighting for C code block

On Fri, 4 Oct 2019 19:01:19 +0200
Jonathan Neuschäfer <[email protected]> wrote:

> This makes the code snippet more readable.
>
> Signed-off-by: Jonathan Neuschäfer <[email protected]>
> ---
> Documentation/driver-api/pti_intel_mid.rst | 4 +++-
> 1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/driver-api/pti_intel_mid.rst b/Documentation/driver-api/pti_intel_mid.rst
> index 20f1cff42d5f..bacc2a4ee89f 100644
> --- a/Documentation/driver-api/pti_intel_mid.rst
> +++ b/Documentation/driver-api/pti_intel_mid.rst
> @@ -49,7 +49,9 @@ but is not just blindly executing as 'root'. Keep in mind
> the use of ioctl(,TIOCSETD,) is not specific to the n_tracerouter
> and n_tracesink line discpline drivers but is a generic
> operation for a program to use a line discpline driver
> -on a tty port other than the default n_tty::
> +on a tty port other than the default n_tty:
> +
> +.. code-block:: c
>
> /////////// To hook up n_tracerouter and n_tracesink /////////
>
> --
> 2.20.1

I had to ponder on this a bit...the addition of that sort of markup tends
to clutter the plain-text reading experience, and I'm personally not
hugely attached to syntax highlighting. But others feel differently, I
guess, so I applied it. I'm not sure I want to see a flood of this kind
of change coming in, though.

Thanks,

jon