2023-09-18 13:47:58

by Bagas Sanjaya

Subject: [PATCH 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block

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 <[email protected]>
---
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

2023-09-18 20:33:18

by Vadim Fedorenko

Subject: Re: [PATCH 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block

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 <[email protected]>

Reviewed-by: Vadim Fedorenko <[email protected]>

> ---
> 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