* [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem
@ 2023-09-28 5:27 Bagas Sanjaya
2023-09-28 5:27 ` [PATCH net-next v2 1/2] Documentation: dpll: Fix code blocks Bagas Sanjaya
` (3 more replies)
0 siblings, 4 replies; 7+ messages in thread
From: Bagas Sanjaya @ 2023-09-28 5:27 UTC (permalink / raw)
To: Linux Networking, Linux Documentation, Linux Kernel Mailing List
Cc: Vadim Fedorenko, Arkadiusz Kubalewski, Jiri Pirko,
Jonathan Corbet, Bagas Sanjaya, David S. Miller
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/20230918093240.29824-1-bagasdotme@gmail.com/
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
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH net-next v2 1/2] Documentation: dpll: Fix code blocks
2023-09-28 5:27 [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem Bagas Sanjaya
@ 2023-09-28 5:27 ` Bagas Sanjaya
2023-09-28 20:42 ` Randy Dunlap
2023-09-28 5:27 ` [PATCH net-next v2 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block Bagas Sanjaya
` (2 subsequent siblings)
3 siblings, 1 reply; 7+ messages in thread
From: Bagas Sanjaya @ 2023-09-28 5:27 UTC (permalink / raw)
To: Linux Networking, Linux Documentation, Linux Kernel Mailing List
Cc: Vadim Fedorenko, Arkadiusz Kubalewski, Jiri Pirko,
Jonathan Corbet, Bagas Sanjaya, David S. Miller,
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")
Reviewed-by: Vadim Fedorenko <vadim.fedorenko@linux.dev>
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] 7+ messages in thread
* [PATCH net-next v2 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block
2023-09-28 5:27 [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem Bagas Sanjaya
2023-09-28 5:27 ` [PATCH net-next v2 1/2] Documentation: dpll: Fix code blocks Bagas Sanjaya
@ 2023-09-28 5:27 ` Bagas Sanjaya
2023-09-28 20:42 ` Randy Dunlap
2023-09-29 1:00 ` [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem Vadim Fedorenko
2023-10-03 22:10 ` patchwork-bot+netdevbpf
3 siblings, 1 reply; 7+ messages in thread
From: Bagas Sanjaya @ 2023-09-28 5:27 UTC (permalink / raw)
To: Linux Networking, Linux Documentation, Linux Kernel Mailing List
Cc: Vadim Fedorenko, Arkadiusz Kubalewski, Jiri Pirko,
Jonathan Corbet, Bagas Sanjaya, David S. Miller
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 <vadim.fedorenko@linux.dev>
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] 7+ messages in thread
* Re: [PATCH net-next v2 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block
2023-09-28 5:27 ` [PATCH net-next v2 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block Bagas Sanjaya
@ 2023-09-28 20:42 ` Randy Dunlap
0 siblings, 0 replies; 7+ messages in thread
From: Randy Dunlap @ 2023-09-28 20:42 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Networking, Linux Documentation,
Linux Kernel Mailing List
Cc: Vadim Fedorenko, Arkadiusz Kubalewski, Jiri Pirko,
Jonathan Corbet, David S. Miller
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 <vadim.fedorenko@linux.dev>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
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
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH net-next v2 1/2] Documentation: dpll: Fix code blocks
2023-09-28 5:27 ` [PATCH net-next v2 1/2] Documentation: dpll: Fix code blocks Bagas Sanjaya
@ 2023-09-28 20:42 ` Randy Dunlap
0 siblings, 0 replies; 7+ messages in thread
From: Randy Dunlap @ 2023-09-28 20:42 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Networking, Linux Documentation,
Linux Kernel Mailing List
Cc: Vadim Fedorenko, Arkadiusz Kubalewski, Jiri Pirko,
Jonathan Corbet, David S. Miller, kernel test robot,
Stephen Rothwell
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 <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")
> Reviewed-by: Vadim Fedorenko <vadim.fedorenko@linux.dev>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
> 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
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem
2023-09-28 5:27 [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem Bagas Sanjaya
2023-09-28 5:27 ` [PATCH net-next v2 1/2] Documentation: dpll: Fix code blocks Bagas Sanjaya
2023-09-28 5:27 ` [PATCH net-next v2 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block Bagas Sanjaya
@ 2023-09-29 1:00 ` Vadim Fedorenko
2023-10-03 22:10 ` patchwork-bot+netdevbpf
3 siblings, 0 replies; 7+ messages in thread
From: Vadim Fedorenko @ 2023-09-29 1:00 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Networking, Linux Documentation,
Linux Kernel Mailing List
Cc: Arkadiusz Kubalewski, Jiri Pirko, Jonathan Corbet, David S. Miller
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/20230918093240.29824-1-bagasdotme@gmail.com/
>
> 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 <vadim.fedorenko@linux.dev>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem
2023-09-28 5:27 [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem Bagas Sanjaya
` (2 preceding siblings ...)
2023-09-29 1:00 ` [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem Vadim Fedorenko
@ 2023-10-03 22:10 ` patchwork-bot+netdevbpf
3 siblings, 0 replies; 7+ messages in thread
From: patchwork-bot+netdevbpf @ 2023-10-03 22:10 UTC (permalink / raw)
To: Bagas Sanjaya
Cc: netdev, linux-doc, linux-kernel, vadim.fedorenko,
arkadiusz.kubalewski, jiri, corbet, davem
Hello:
This series was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:
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
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2023-10-03 22:10 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-09-28 5:27 [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem Bagas Sanjaya
2023-09-28 5:27 ` [PATCH net-next v2 1/2] Documentation: dpll: Fix code blocks Bagas Sanjaya
2023-09-28 20:42 ` Randy Dunlap
2023-09-28 5:27 ` [PATCH net-next v2 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block Bagas Sanjaya
2023-09-28 20:42 ` Randy Dunlap
2023-09-29 1:00 ` [PATCH net-next v2 0/2] Documentation fixes for dpll subsystem Vadim Fedorenko
2023-10-03 22:10 ` patchwork-bot+netdevbpf
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.