diff options
| author | Akira Yokosawa <[email protected]> | 2022-05-11 08:45:43 +0900 |
|---|---|---|
| committer | Marc Kleine-Budde <[email protected]> | 2022-05-16 22:11:11 +0200 |
| commit | ba3e2eaef1ae5019775989aeec3be8e9df83baa5 (patch) | |
| tree | 0e00c239e681296902498933aabc91b4a74195e2 | |
| parent | 14e1e9338c08a56454afa982d2880846d0a1609f (diff) | |
docs: ctucanfd: Use 'kernel-figure' directive instead of 'figure'
Two issues were observed in the ReST doc added by commit c3a0addefbde
("docs: ctucanfd: CTU CAN FD open-source IP core documentation.")
with Sphinx versions 2.4.4 and 4.5.0.
The plain "figure" directive broke "make pdfdocs" due to a missing
PDF figure. For conversion of SVG -> PDF to work, the "kernel-figure"
directive, which is an extension for kernel documentation, should
be used instead.
The directive of "code:: raw" causes a warning from both
"make htmldocs" and "make pdfdocs", which reads:
[...]/can/ctu/ctucanfd-driver.rst:75: WARNING: Pygments lexer name
'raw' is not known
A plain literal-block marker should suffice where no syntax
highlighting is intended.
Fix the issues by using suitable directive and marker.
Fixes: c3a0addefbde ("docs: ctucanfd: CTU CAN FD open-source IP core documentation.")
Link: https://lore.kernel.org/all/[email protected]
Signed-off-by: Akira Yokosawa <[email protected]>
Acked-by: Pavel Pisa <[email protected]>
Cc: Martin Jerabek <[email protected]>
Cc: Ondrej Ille <[email protected]>
Cc: Marc Kleine-Budde <[email protected]>
Signed-off-by: Marc Kleine-Budde <[email protected]>
| -rw-r--r-- | Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst b/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst index 2fde5551e756..40c92ea272af 100644 --- a/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst +++ b/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst @@ -72,7 +72,7 @@ it is reachable (on which bus it resides) and its configuration – registers address, interrupts and so on. An example of such a device tree is given in . -.. code:: raw +:: / { /* ... */ @@ -451,7 +451,7 @@ the FIFO is maintained, together with priority rotation, is depicted in | -.. figure:: fsm_txt_buffer_user.svg +.. kernel-figure:: fsm_txt_buffer_user.svg TX Buffer states with possible transitions |