On Wed, 11 May 2022 08:45:43 +0900, Akira Yokosawa wrote:
> 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.
>
> Signed-off-by: Akira Yokosawa <akiyks@xxxxxxxxx>
> Fixes: c3a0addefbde ("docs: ctucanfd: CTU CAN FD open-source IP core documentation.")
> Acked-by: Pavel Pisa <pisa@xxxxxxxxxxxxxxxx>
> Cc: Martin Jerabek <martin.jerabek01@xxxxxxxxx>
> Cc: Ondrej Ille <ondrej.ille@xxxxxxxxx>
> Cc: Marc Kleine-Budde <mkl@xxxxxxxxxxxxxx>
> ---
> Changes in v1 -> v2
> - no change in diff
> - added explicit Sphinx versions the issues were observed
> - picked Pavel's Acked-by
>
Gentle ping to netdev maintainers.
I believe this one should go upstream together with the
offending commit.
If there is something I can do better, please let me know.
Thanks, Akira
> --
> .../networking/device_drivers/can/ctu/ctucanfd-driver.rst | 4 ++--
> 1 file 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
>
