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

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: <20250228140212.346c4ef5@erd003.prtnl>
Date: Fri, 28 Feb 2025 14:02:12 +0100
From: David Jander <david@...tonic.nl>
To: Jonathan Corbet <corbet@....net>
Cc: linux-kernel@...r.kernel.org, linux-iio@...r.kernel.org, Rob Herring
 <robh@...nel.org>, Krzysztof Kozlowski <krzk+dt@...nel.org>, Conor Dooley
 <conor+dt@...nel.org>, devicetree@...r.kernel.org,
 linux-doc@...r.kernel.org, Nuno Sa <nuno.sa@...log.com>, Jonathan Cameron
 <jic23@...nel.org>, Oleksij Rempel <o.rempel@...gutronix.de>
Subject: Re: [RFC PATCH 4/7] Documentation: Add Linux Motion Control
 documentation

Dear Jonathan,

Thanks for reviewing...

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

> David Jander <david@...tonic.nl> writes:
> 
> > Add general- and UAPI documentation for the Linux Motion Control
> > subsystem.
> >
> > Signed-off-by: David Jander <david@...tonic.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