Re: [RFC PATCH 4/7] Documentation: Add Linux Motion Control documentation

David Jander
2025-02-28T13:02:19Z

Dear Jonathan,

Thanks for reviewing...

On Thu, 27 Feb 2025 09:37:00 -0700
Jonathan Corbet <corbet@lwn.net> wrote:

> David Jander <david@protonic.nl> writes:
>
> > Add general- and UAPI documentation for the Linux Motion Control
> > subsystem.
> >
> > Signed-off-by: David Jander <david@protonic.nl>
> > ---
> > Documentation/motion/index.rst | 18 +
> > Documentation/motion/motion-uapi.rst | 555 +++++++++++++++++++++++++++
> > Documentation/subsystem-apis.rst | 1 +
> > 3 files changed, 574 insertions(+)
> > create mode 100644 Documentation/motion/index.rst
> > create mode 100644 Documentation/motion/motion-uapi.rst
>
> I am glad to see this feature coming with documentation! Please,
> though, do not create a top-level "motion" directory for it - that is
> just the kind of organization I've been trying to get us away from for a
> while. This document is clearly aimed at user-space developers, and
> thus should be part of the userspace-api book ... please?

Ok, I understood UAPI documentation should go in
Documentation/userspace-api/motion.rst. Will fix that.

What I am unsure of is the rest of the documentation (which arguably still
needs to be written). I initially selected this place because of
Documentation/subsystem-apis.rst. LMC being a new "subsystem", made me think it
was the right thing to follow the structure of the contents there.
What I mean to put there is documentation of the driver API for motion
control drivers. I understand that while it doesn't really exist yet, I should
leave it out of this patch set, but when I am going to write it, should it
still go there, or is there now a better place?

Best regards,

--
David Jander