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

From: Jakub Kicinski
Date: Mon Jun 12 2023 - 18:30:18 EST


On Sat, 10 Jun 2023 18:28:45 +0200 Jiri Pirko wrote:
> Fri, Jun 09, 2023 at 02:18:44PM CEST, arkadiusz.kubalewski@xxxxxxxxx wrote:
> >From: Vadim Fedorenko <vadim.fedorenko@xxxxxxxxx>
> >
> >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@xxxxxxxxx>
> >Signed-off-by: Arkadiusz Kubalewski <arkadiusz.kubalewski@xxxxxxxxx>
> >---
> > 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 :)