linux-kernel - Re: [PATCH 2/2] Documentation: dpll: wrap DPLL_CMD_PIN

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <63f877b6-1142-82ac-a723-5dc276137283@linux.dev>
Date:   Mon, 18 Sep 2023 11:03:22 +0100
From:   Vadim Fedorenko <vadim.fedorenko@...ux.dev>
To:     Bagas Sanjaya <bagasdotme@...il.com>,
        Arkadiusz Kubalewski <arkadiusz.kubalewski@...el.com>,
        Jiri Pirko <jiri@...nulli.us>,
        Jonathan Corbet <corbet@....net>,
        "David S. Miller" <davem@...emloft.net>
Cc:     Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Linux Networking <netdev@...r.kernel.org>,
        Linux Documentation <linux-doc@...r.kernel.org>
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 <bagasdotme@...il.com>

Reviewed-by: Vadim Fedorenko <vadim.fedorenko@...ux.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