Re: [PATCH net-next v2 1/2] Documentation: dpll: Fix code blocks
From: Randy Dunlap <hidden>
Date: 2023-09-28 20:42:13
Also in:
linux-doc, lkml
On 9/27/23 22:27, 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 <redacted> Closes: https://lore.kernel.org/oe-kbuild-all/202309180456.lOhxy9gS-lkp@intel.com/ (local) Reported-by: Stephen Rothwell <redacted> Closes: https://lore.kernel.org/linux-next/20230918131521.155e9e63@canb.auug.org.au/ (local) Fixes: dbb291f19393b6 ("dpll: documentation on DPLL subsystem interface") Reviewed-by: Vadim Fedorenko <vadim.fedorenko@linux.dev> Signed-off-by: Bagas Sanjaya <redacted>
Acked-by: Randy Dunlap <redacted> Tested-by: Randy Dunlap <redacted> Thanks.
quoted hunk ↗ jump to hunk
--- 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]);
-- ~Randy