linux-kernel - Re: [RFC PATCH v8 01/10] dpll: documentation on DPLL subsystem interface

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 for Android: free password hash cracker in your pocket

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

Message-ID: <20230612153009.5f0e1b4a@kernel.org>
Date:   Mon, 12 Jun 2023 15:30:09 -0700
From:   Jakub Kicinski <kuba@...nel.org>
To:     Jiri Pirko <jiri@...nulli.us>
Cc:     Arkadiusz Kubalewski <arkadiusz.kubalewski@...el.com>,
        vadfed@...a.com, jonathan.lemon@...il.com, pabeni@...hat.com,
        corbet@....net, davem@...emloft.net, edumazet@...gle.com,
        vadfed@...com, jesse.brandeburg@...el.com,
        anthony.l.nguyen@...el.com, saeedm@...dia.com, leon@...nel.org,
        richardcochran@...il.com, sj@...nel.org, javierm@...hat.com,
        ricardo.canuelo@...labora.com, mst@...hat.com, tzimmermann@...e.de,
        michal.michalik@...el.com, gregkh@...uxfoundation.org,
        jacek.lawrynowicz@...ux.intel.com, airlied@...hat.com,
        ogabbay@...nel.org, arnd@...db.de, nipun.gupta@....com,
        axboe@...nel.dk, linux@...y.sk, masahiroy@...nel.org,
        benjamin.tissoires@...hat.com, geert+renesas@...der.be,
        milena.olech@...el.com, kuniyu@...zon.com, liuhangbin@...il.com,
        hkallweit1@...il.com, andy.ren@...cruise.com, razor@...ckwall.org,
        idosch@...dia.com, lucien.xin@...il.com, nicolas.dichtel@...nd.com,
        phil@....cc, claudiajkang@...il.com, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, netdev@...r.kernel.org,
        intel-wired-lan@...ts.osuosl.org, linux-rdma@...r.kernel.org,
        linux-arm-kernel@...ts.infradead.org, poros@...hat.com,
        mschmidt@...hat.com, linux-clk@...r.kernel.org,
        vadim.fedorenko@...ux.dev
Subject: Re: [RFC PATCH v8 01/10] dpll: documentation on DPLL subsystem
 interface

On Sat, 10 Jun 2023 18:28:45 +0200 Jiri Pirko wrote:
> Fri, Jun 09, 2023 at 02:18:44PM CEST, arkadiusz.kubalewski@...el.com wrote:
> >From: Vadim Fedorenko <vadim.fedorenko@...ux.dev>
> >
> >Add documentation explaining common netlink interface to configure DPLL
> >devices and monitoring events. Common way to implement DPLL device in
> >a driver is also covered.
> >
> >Signed-off-by: Vadim Fedorenko <vadim.fedorenko@...ux.dev>
> >Signed-off-by: Arkadiusz Kubalewski <arkadiusz.kubalewski@...el.com>
> >---
> > Documentation/driver-api/dpll.rst  | 458 +++++++++++++++++++++++++++++
> > Documentation/driver-api/index.rst |   1 +
> > 2 files changed, 459 insertions(+)
> > create mode 100644 Documentation/driver-api/dpll.rst  
> 
> Looks fine to me. I just wonder if the info redundancy of this file and
> the netlink yaml could be somehow reduce. IDK.

Certainly possible, I even talked to Peter of the pyroute2 fame about
this. Should be fairly easy to generate a .rst file, and/or Sphinx
plugin to go directly from the YAML. Is it on my TODO list? Nope :)