From: Vadim Fedorenko <vadim.fedorenko@linux.dev>
To: Bagas Sanjaya <bagasdotme@gmail.com>,
Arkadiusz Kubalewski <arkadiusz.kubalewski@intel.com>,
Jiri Pirko <jiri@resnulli.us>, Jonathan Corbet <corbet@lwn.net>,
"David S. Miller" <davem@davemloft.net>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Networking <netdev@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH 1/2] Documentation: dpll: Fix code blocks
Date: Mon, 18 Sep 2023 11:01:34 +0100 [thread overview]
Message-ID: <d3b22c8c-a69a-22a7-74c5-88c2336ad9e0@linux.dev> (raw)
In-Reply-To: <20230918093240.29824-2-bagasdotme@gmail.com>
On 18/09/2023 10:32, Bagas Sanjaya wrote:
> kernel test robot and Stephen Rothwell report htmldocs warnings:
>
> Documentation/driver-api/dpll.rst:427: WARNING: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 18 supplied.
>
> .. code-block:: c
> <snipped>...
> Documentation/driver-api/dpll.rst:444: WARNING: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 21 supplied.
>
> .. code-block:: c
> <snipped>...
> Documentation/driver-api/dpll.rst:474: WARNING: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 12 supplied.
>
> .. code-block:: c
> <snipped>...
>
> Fix these above by adding missing blank line separator after code-block
> directive.
>
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202309180456.lOhxy9gS-lkp@intel.com/
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20230918131521.155e9e63@canb.auug.org.au/
> Fixes: dbb291f19393b6 ("dpll: documentation on DPLL subsystem interface")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Vadim Fedorenko <vadim.fedorenko@linux.dev>
> ---
> Documentation/driver-api/dpll.rst | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/Documentation/driver-api/dpll.rst b/Documentation/driver-api/dpll.rst
> index bb52f1b8c0be31..01eb4de867036f 100644
> --- a/Documentation/driver-api/dpll.rst
> +++ b/Documentation/driver-api/dpll.rst
> @@ -425,6 +425,7 @@ The simplest implementation is in the OCP TimeCard driver. The ops
> structures are defined like this:
>
> .. code-block:: c
> +
> static const struct dpll_device_ops dpll_ops = {
> .lock_status_get = ptp_ocp_dpll_lock_status_get,
> .mode_get = ptp_ocp_dpll_mode_get,
> @@ -442,6 +443,7 @@ structures are defined like this:
> The registration part is then looks like this part:
>
> .. code-block:: c
> +
> clkid = pci_get_dsn(pdev);
> bp->dpll = dpll_device_get(clkid, 0, THIS_MODULE);
> if (IS_ERR(bp->dpll)) {
> @@ -472,6 +474,7 @@ The registration part is then looks like this part:
> In the error path we have to rewind every allocation in the reverse order:
>
> .. code-block:: c
> +
> while (i) {
> --i;
> dpll_pin_unregister(bp->dpll, bp->sma[i].dpll_pin, &dpll_pins_ops, &bp->sma[i]);
next prev parent reply other threads:[~2023-09-18 10:02 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-18 9:32 [PATCH 0/2] Documentation fixes for dpll subsystem Bagas Sanjaya
2023-09-18 9:32 ` [PATCH 1/2] Documentation: dpll: Fix code blocks Bagas Sanjaya
2023-09-18 10:01 ` Vadim Fedorenko [this message]
2023-09-18 9:32 ` [PATCH 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block Bagas Sanjaya
2023-09-18 10:03 ` Vadim Fedorenko
2023-09-18 10:04 ` [PATCH 0/2] Documentation fixes for dpll subsystem Vadim Fedorenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=d3b22c8c-a69a-22a7-74c5-88c2336ad9e0@linux.dev \
--to=vadim.fedorenko@linux.dev \
--cc=arkadiusz.kubalewski@intel.com \
--cc=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=jiri@resnulli.us \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Powered by JetHome