* [PATCH 1/2] Documentation: dpll: Fix code blocks
2023-09-18 9:32 [PATCH 0/2] Documentation fixes for dpll subsystem Bagas Sanjaya
@ 2023-09-18 9:32 ` Bagas Sanjaya
2023-09-18 10:01 ` Vadim Fedorenko
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:04 ` [PATCH 0/2] Documentation fixes for dpll subsystem Vadim Fedorenko
2 siblings, 1 reply; 6+ messages in thread
From: Bagas Sanjaya @ 2023-09-18 9:32 UTC (permalink / raw)
To: Vadim Fedorenko, Arkadiusz Kubalewski, Jiri Pirko,
Jonathan Corbet, David S. Miller
Cc: Linux Kernel Mailing List, Linux Networking, Linux Documentation,
Bagas Sanjaya, kernel test robot, Stephen Rothwell
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>
---
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]);
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH 1/2] Documentation: dpll: Fix code blocks
2023-09-18 9:32 ` [PATCH 1/2] Documentation: dpll: Fix code blocks Bagas Sanjaya
@ 2023-09-18 10:01 ` Vadim Fedorenko
0 siblings, 0 replies; 6+ messages in thread
From: Vadim Fedorenko @ 2023-09-18 10:01 UTC (permalink / raw)
To: Bagas Sanjaya, Arkadiusz Kubalewski, Jiri Pirko, Jonathan Corbet,
David S. Miller
Cc: Linux Kernel Mailing List, Linux Networking, Linux Documentation,
Stephen Rothwell
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]);
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block
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 9:32 ` Bagas Sanjaya
2023-09-18 10:03 ` Vadim Fedorenko
2023-09-18 10:04 ` [PATCH 0/2] Documentation fixes for dpll subsystem Vadim Fedorenko
2 siblings, 1 reply; 6+ messages in thread
From: Bagas Sanjaya @ 2023-09-18 9:32 UTC (permalink / raw)
To: Vadim Fedorenko, Arkadiusz Kubalewski, Jiri Pirko,
Jonathan Corbet, David S. Miller
Cc: Linux Kernel Mailing List, Linux Networking, Linux Documentation,
Bagas Sanjaya
DPLL_CMD_PIN_GET netlink command output for mux-type pins looks ugly
with normal paragraph formatting. Format it as a code block instead.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/driver-api/dpll.rst | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/Documentation/driver-api/dpll.rst b/Documentation/driver-api/dpll.rst
index 01eb4de867036f..69670deb8c4e09 100644
--- a/Documentation/driver-api/dpll.rst
+++ b/Documentation/driver-api/dpll.rst
@@ -119,19 +119,19 @@ with.
If a pin was registered with multiple parent pins, they behave like a
multiple output multiplexer. In this case output of a
``DPLL_CMD_PIN_GET`` would contain multiple pin-parent nested
-attributes with current state related to each parent, like:
+attributes with current state related to each parent, like::
-'pin': [{{
- 'clock-id': 282574471561216,
- 'module-name': 'ice',
- 'capabilities': 4,
- 'id': 13,
- 'parent-pin': [
- {'parent-id': 2, 'state': 'connected'},
- {'parent-id': 3, 'state': 'disconnected'}
- ],
- 'type': 'synce-eth-port'
- }}]
+ 'pin': [{{
+ 'clock-id': 282574471561216,
+ 'module-name': 'ice',
+ 'capabilities': 4,
+ 'id': 13,
+ 'parent-pin': [
+ {'parent-id': 2, 'state': 'connected'},
+ {'parent-id': 3, 'state': 'disconnected'}
+ ],
+ 'type': 'synce-eth-port'
+ }}]
Only one child pin can provide its signal to the parent MUX-type pin at
a time, the selection is done by requesting change of a child pin state
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block
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
0 siblings, 0 replies; 6+ messages in thread
From: Vadim Fedorenko @ 2023-09-18 10:03 UTC (permalink / raw)
To: Bagas Sanjaya, Arkadiusz Kubalewski, Jiri Pirko, Jonathan Corbet,
David S. Miller
Cc: Linux Kernel Mailing List, Linux Networking, Linux Documentation
On 18/09/2023 10:32, Bagas Sanjaya wrote:
> DPLL_CMD_PIN_GET netlink command output for mux-type pins looks ugly
> with normal paragraph formatting. Format it as a code block instead.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Vadim Fedorenko <vadim.fedorenko@linux.dev>
> ---
> Documentation/driver-api/dpll.rst | 24 ++++++++++++------------
> 1 file changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/Documentation/driver-api/dpll.rst b/Documentation/driver-api/dpll.rst
> index 01eb4de867036f..69670deb8c4e09 100644
> --- a/Documentation/driver-api/dpll.rst
> +++ b/Documentation/driver-api/dpll.rst
> @@ -119,19 +119,19 @@ with.
> If a pin was registered with multiple parent pins, they behave like a
> multiple output multiplexer. In this case output of a
> ``DPLL_CMD_PIN_GET`` would contain multiple pin-parent nested
> -attributes with current state related to each parent, like:
> +attributes with current state related to each parent, like::
>
> -'pin': [{{
> - 'clock-id': 282574471561216,
> - 'module-name': 'ice',
> - 'capabilities': 4,
> - 'id': 13,
> - 'parent-pin': [
> - {'parent-id': 2, 'state': 'connected'},
> - {'parent-id': 3, 'state': 'disconnected'}
> - ],
> - 'type': 'synce-eth-port'
> - }}]
> + 'pin': [{{
> + 'clock-id': 282574471561216,
> + 'module-name': 'ice',
> + 'capabilities': 4,
> + 'id': 13,
> + 'parent-pin': [
> + {'parent-id': 2, 'state': 'connected'},
> + {'parent-id': 3, 'state': 'disconnected'}
> + ],
> + 'type': 'synce-eth-port'
> + }}]
>
> Only one child pin can provide its signal to the parent MUX-type pin at
> a time, the selection is done by requesting change of a child pin state
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH 0/2] Documentation fixes for dpll subsystem
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 9:32 ` [PATCH 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block Bagas Sanjaya
@ 2023-09-18 10:04 ` Vadim Fedorenko
2 siblings, 0 replies; 6+ messages in thread
From: Vadim Fedorenko @ 2023-09-18 10:04 UTC (permalink / raw)
To: Bagas Sanjaya, Arkadiusz Kubalewski, Jiri Pirko, Jonathan Corbet,
David S. Miller
Cc: Linux Kernel Mailing List, Linux Networking, Linux Documentation
On 18/09/2023 10:32, Bagas Sanjaya wrote:
> First of all, sorry for not reviewing dpll series [1] before it gets merged. I
> was prompted to post this doc fixup mini series because I was emailed by kernel
> test robot (see [1/2] for the warnings).
>
> This fixup is all code block related.
Thanks for cleaning the documentation part.
Vadim
^ permalink raw reply [flat|nested] 6+ messages in thread