Here is a mini docs fixes for dpll subsystem. The fixes are all code
block-related.
This series is triggered because I was emailed by kernel test robot,
alerting htmldocs warnings (see patch [1/2]).
Changes since v1 [1]:
* Collect Reviewed-by tags
* Rebase on current net-next
[1]: https://lore.kernel.org/all/[email protected]/
Bagas Sanjaya (2):
Documentation: dpll: Fix code blocks
Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block
Documentation/driver-api/dpll.rst | 27 +++++++++++++++------------
1 file changed, 15 insertions(+), 12 deletions(-)
base-commit: 5a1b322cb0b7d0d33a2d13462294dc0f46911172
--
An old man doll... just what I always wanted! - Clara
DPLL_CMD_PIN_GET netlink command output for mux-type pins looks ugly
with normal paragraph formatting. Format it as a code block instead.
Reviewed-by: Vadim Fedorenko <[email protected]>
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
On 9/27/23 22:27, 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.
>
> Reviewed-by: Vadim Fedorenko <[email protected]>
> Signed-off-by: Bagas Sanjaya <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Tested-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> 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
--
~Randy
On 28/09/2023 06:27, Bagas Sanjaya wrote:
> Here is a mini docs fixes for dpll subsystem. The fixes are all code
> block-related.
>
> This series is triggered because I was emailed by kernel test robot,
> alerting htmldocs warnings (see patch [1/2]).
>
> Changes since v1 [1]:
> * Collect Reviewed-by tags
> * Rebase on current net-next
>
> [1]: https://lore.kernel.org/all/[email protected]/
>
> Bagas Sanjaya (2):
> Documentation: dpll: Fix code blocks
> Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block
>
> Documentation/driver-api/dpll.rst | 27 +++++++++++++++------------
> 1 file changed, 15 insertions(+), 12 deletions(-)
>
>
> base-commit: 5a1b322cb0b7d0d33a2d13462294dc0f46911172
For the series:
Reviewed-by: Vadim Fedorenko <[email protected]>
Hello:
This series was applied to netdev/net-next.git (main)
by Jakub Kicinski <[email protected]>:
On Thu, 28 Sep 2023 12:27:06 +0700 you wrote:
> Here is a mini docs fixes for dpll subsystem. The fixes are all code
> block-related.
>
> This series is triggered because I was emailed by kernel test robot,
> alerting htmldocs warnings (see patch [1/2]).
>
> Changes since v1 [1]:
> * Collect Reviewed-by tags
> * Rebase on current net-next
>
> [...]
Here is the summary with links:
- [net-next,v2,1/2] Documentation: dpll: Fix code blocks
https://git.kernel.org/netdev/net-next/c/92425d08a608
- [net-next,v2,2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block
https://git.kernel.org/netdev/net-next/c/c8afdc018329
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html