Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output

From: Richard Cochran
Date: Wed Oct 28 2020 - 18:05:28 EST


On Wed, Oct 28, 2020 at 03:23:18PM +0100, Mauro Carvalho Chehab wrote:

> diff --git a/Documentation/ABI/testing/sysfs-uevent b/Documentation/ABI/testing/sysfs-uevent
> index aa39f8d7bcdf..d0893dad3f38 100644
> --- a/Documentation/ABI/testing/sysfs-uevent
> +++ b/Documentation/ABI/testing/sysfs-uevent
> @@ -19,7 +19,8 @@ Description:
> a transaction identifier so it's possible to use the same UUID
> value for one or more synthetic uevents in which case we
> logically group these uevents together for any userspace
> - listeners. The UUID value appears in uevent as
> + listeners. The UUID value appears in uevent as:

I know almost nothing about Sphinx, but why have one colon here ^^^ and ...

> +
> "SYNTH_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" environment
> variable.
>
> @@ -30,18 +31,19 @@ Description:
> It's possible to define zero or more pairs - each pair is then
> delimited by a space character ' '. Each pair appears in
> synthetic uevent as "SYNTH_ARG_KEY=VALUE". That means the KEY
> - name gains "SYNTH_ARG_" prefix to avoid possible collisions
> + name gains `SYNTH_ARG_` prefix to avoid possible collisions
> with existing variables.
>
> - Example of valid sequence written to the uevent file:
> + Example of valid sequence written to the uevent file::

... two here?

Thanks,
Richard