On Fri, 06 Apr 2018, Heikki Krogerus <heikki.kroge...@linux.intel.com> wrote:
> To prevent processing of ascii art as reStructuredText
> elements, marking it as a comment.
Please don't. This hides the ascii art from the generated documentation.
The right fix is to use a reStructuredText literal block like this:
diff --git a/Documentation/driver-api/usb/typec.rst
b/Documentation/driver-api/usb/typec.rst
index feb31946490b..48ff58095f11 100644
--- a/Documentation/driver-api/usb/typec.rst
+++ b/Documentation/driver-api/usb/typec.rst
@@ -210,7 +210,7 @@ If the connector is dual-role capable, there may also be a
switch for the data
role. USB Type-C Connector Class does not supply separate API for them. The
port drivers can use USB Role Class API with those.
-Illustration of the muxes behind a connector that supports an alternate mode:
+Illustration of the muxes behind a connector that supports an alternate mode::
------------------------
| Connector |
BR,
Jani.
>
> Reported-by: Masanari Iida <standby2...@gmail.com>
> Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C
> Multiplexers")
> Signed-off-by: Heikki Krogerus <heikki.kroge...@linux.intel.com>
> ---
> Documentation/driver-api/usb/typec.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/driver-api/usb/typec.rst
> b/Documentation/driver-api/usb/typec.rst
> index feb31946490b..972c11bf4141 100644
> --- a/Documentation/driver-api/usb/typec.rst
> +++ b/Documentation/driver-api/usb/typec.rst
> @@ -212,7 +212,7 @@ port drivers can use USB Role Class API with those.
>
> Illustration of the muxes behind a connector that supports an alternate mode:
>
> - ------------------------
> +.. ------------------------
> | Connector |
> ------------------------
> | |
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
