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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <87o6ymnna8.fsf@trenco.lwn.net>
Date: Fri, 28 Feb 2025 07:42:39 -0700
From: Jonathan Corbet <corbet@....net>
To: David Jander <david@...tonic.nl>
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

David Jander <david@...tonic.nl> writes:

> 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?

I've really been pushing to organize our documentation by the audience
it is addressing, rather than by the developers who write it.  So
driver-api documentation is best put into ... the driver-api book,
Documentation/driver-api.

My plan, that I haven't yet acted on, is to create Documentation/devices
for device-specific docs that don't go anywhere else, then move a lot of
stuff into it.  Much like what was done with Documentation/arch.  But
anything that can go into the existing audience-focused manuals should
go there.

Thanks,

jon