On Fri, 28 Feb 2025 07:42:39 -0700 Jonathan Corbet <corbet@xxxxxxx> wrote: > David Jander <david@xxxxxxxxxxx> 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. Sounds reasonable. I will put the driver api docs there once I come around to writing them (I have the code commented already so that could be a start). > 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. Ok, I'll keep that in mind. Thanks. Best regards, -- David Jander
