From patchwork Tue May 10 09:34:37 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Akira Yokosawa X-Patchwork-Id: 12844725 X-Patchwork-Delegate: kuba@kernel.org Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7D7B7C433EF for ; Tue, 10 May 2022 09:34:46 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238912AbiEJJil (ORCPT ); Tue, 10 May 2022 05:38:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52252 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235891AbiEJJij (ORCPT ); Tue, 10 May 2022 05:38:39 -0400 Received: from mail-pl1-x631.google.com (mail-pl1-x631.google.com [IPv6:2607:f8b0:4864:20::631]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 940B128F7D9; Tue, 10 May 2022 02:34:42 -0700 (PDT) Received: by mail-pl1-x631.google.com with SMTP id d22so16227150plr.9; Tue, 10 May 2022 02:34:42 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:date:mime-version:user-agent:content-language:to:cc:from :subject:content-transfer-encoding; bh=qaDh4Ckz8QrCcHoQ04UJEqXA1un3Pk43mgbPkIGVN1I=; b=KVEJAoTst/XMBdGnBfrFVplKvsiqSzit2RwnZ7YD0A3CpnQAafw/CLzObaclOYYcMR VY0VtGrEwffts3ooJ/aWd6Y3OiGHrKNnA+2TQfO5EbQLI2np25d2zdp36orDc7NCaDsy p7hnQ50UM/95iDTalSnkgGuGu31IAPd7odOCq8d2mz8IrW8+zS8ruIQw9H9NfmfdQOd1 mKVOLdEvvAGLEyVhv1dAmbEwLRVfIT4MrEqmuQo8ozINm3iLE/uyN/W9dPE/FgQfpUfe pwXBYLO6p0XZrZ1+YZ6eGPqe1BsvHXXZPfIveHzDLlu+kC0RzTHrJNVb8894S6f+c5oe sfcQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:date:mime-version:user-agent :content-language:to:cc:from:subject:content-transfer-encoding; bh=qaDh4Ckz8QrCcHoQ04UJEqXA1un3Pk43mgbPkIGVN1I=; b=6CIzvJzjXsjt/Tm5xisYKaZszkWE6lMZh9YuJYSBUxhBBW3oova3K3r5lnIJR5fDD/ v35Ka9mnU7ceW3t7IbNjwAaSYS4qAO5bRaL5pjO47+mUFi34I8tdUud2DVSOtSzEDnEt XZZIuTIG/L9z1BfxL0PP8R3aFFhH2VmlzbhN0Synyw1QVEW3hHjQJbSrx7Rv/DeOw0xf tPWTK4MdMG7uYm+ezRp+aMnt/OcqeuUEDDP1hg8zz++Ezvug3E7zYb7ICHiJv4pPiMFk z5rnl5ASH3tilRJ38cul+a+rMnkE9/a1FWlpQDYFd/B/emCo5MfIdTgqvVx1D3E0meWQ ckeg== X-Gm-Message-State: AOAM530WcDYwrhJmMKoXdB0Bi07ZH7krjhx4+QbevR+eFS50eafesf0G Xv7+ArbbbYKVSUGm4lk0I/4E+9BRIQOMIw== X-Google-Smtp-Source: ABdhPJy/YUSbDEPTeKe1+Vh8Kbzycu5xwlQFcScA9EB0LpH/f0Zgcz/Kilxl0fL/79wxmIjbIQMvJg== X-Received: by 2002:a17:902:d510:b0:15e:afc4:85a0 with SMTP id b16-20020a170902d51000b0015eafc485a0mr19918712plg.64.1652175282090; Tue, 10 May 2022 02:34:42 -0700 (PDT) Received: from [192.168.11.5] (KD106167171201.ppp-bb.dion.ne.jp. [106.167.171.201]) by smtp.gmail.com with ESMTPSA id i8-20020aa796e8000000b0050dc762812bsm10176399pfq.5.2022.05.10.02.34.39 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 10 May 2022 02:34:41 -0700 (PDT) Message-ID: <05d491d4-c498-9bab-7085-9c892b636d68@gmail.com> Date: Tue, 10 May 2022 18:34:37 +0900 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.8.1 Content-Language: en-US To: Marc Kleine-Budde , Pavel Pisa Cc: Martin Jerabek , Ondrej Ille , "David S. Miller" , Jakub Kicinski , netdev@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org From: Akira Yokosawa Subject: [PATCH net-next] docs: ctucanfd: Use 'kernel-figure' directive instead of 'figure' Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org X-Patchwork-Delegate: kuba@kernel.org Two issues were observed in the ReST doc added by commit c3a0addefbde ("docs: ctucanfd: CTU CAN FD open-source IP core documentation."). 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 documentations, 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 Fixes: c3a0addefbde ("docs: ctucanfd: CTU CAN FD open-source IP core documentation.") Cc: Pavel Pisa Cc: Martin Jerabek Cc: Ondrej Ille Cc: Marc Kleine-Budde Acked-by: Pavel Pisa --- .../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