* [PATCH] Documentation: typec.rst: Mark ascii art as a comment
@ 2018-04-06 8:22 Heikki Krogerus
2018-04-06 9:12 ` Heikki Krogerus
2018-04-06 9:19 ` Jani Nikula
0 siblings, 2 replies; 3+ messages in thread
From: Heikki Krogerus @ 2018-04-06 8:22 UTC (permalink / raw)
To: Greg KH, Jonathan Corbet
Cc: Masanari Iida, linux-kernel, linux-doc, linux-usb
To prevent processing of ascii art as reStructuredText
elements, marking it as a comment.
Reported-by: Masanari Iida <standby24x7@gmail.com>
Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C Multiplexers")
Signed-off-by: Heikki Krogerus <heikki.krogerus@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 |
------------------------
| |
--
2.16.3
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [PATCH] Documentation: typec.rst: Mark ascii art as a comment
2018-04-06 8:22 [PATCH] Documentation: typec.rst: Mark ascii art as a comment Heikki Krogerus
@ 2018-04-06 9:12 ` Heikki Krogerus
2018-04-06 9:19 ` Jani Nikula
1 sibling, 0 replies; 3+ messages in thread
From: Heikki Krogerus @ 2018-04-06 9:12 UTC (permalink / raw)
To: Greg KH, Jonathan Corbet
Cc: Masanari Iida, linux-kernel, linux-doc, linux-usb
On Fri, Apr 06, 2018 at 11:22:29AM +0300, Heikki Krogerus wrote:
> To prevent processing of ascii art as reStructuredText
> elements, marking it as a comment.
I will change this, and use literal-block instead.
> Reported-by: Masanari Iida <standby24x7@gmail.com>
> Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C Multiplexers")
> Signed-off-by: Heikki Krogerus <heikki.krogerus@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 |
> ------------------------
> | |
Thanks,
--
heikki
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] Documentation: typec.rst: Mark ascii art as a comment
2018-04-06 8:22 [PATCH] Documentation: typec.rst: Mark ascii art as a comment Heikki Krogerus
2018-04-06 9:12 ` Heikki Krogerus
@ 2018-04-06 9:19 ` Jani Nikula
1 sibling, 0 replies; 3+ messages in thread
From: Jani Nikula @ 2018-04-06 9:19 UTC (permalink / raw)
To: Heikki Krogerus, Greg KH, Jonathan Corbet
Cc: Masanari Iida, linux-kernel, linux-doc, linux-usb
On Fri, 06 Apr 2018, Heikki Krogerus <heikki.krogerus@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 <standby24x7@gmail.com>
> Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C Multiplexers")
> Signed-off-by: Heikki Krogerus <heikki.krogerus@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 majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2018-04-06 9:18 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-04-06 8:22 [PATCH] Documentation: typec.rst: Mark ascii art as a comment Heikki Krogerus
2018-04-06 9:12 ` Heikki Krogerus
2018-04-06 9:19 ` Jani Nikula
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).