Re: [PATCH RFC 0/2] Move media uAPI and kAPI docs to a better place

[Jonathan Corbet]

On Wed,  4 Mar 2020 11:51:01 +0100
Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> wrote:

> This is something that you always wanted: move uAPI and kAPI to
> separate books.

Oh goodie...Christmas is coming early this year...:)

> This RFC series start doing it for the media docs.
> 
> For now, this is just a RFC, being only an initial step for it. I'm sending
> it on this early stage just to rise some discussions.
> 
> This changeset basically moves:
> 
>   - the media kAPI files to be under driver-api/media;
>   - the media uAPI files to be under userspace-api/media.
> 
> This version keeps including both inside Documentation/media/index.rst.

The moves make sense to me.  The including part I'm not so sure about.  It
seems kind of strange to have the structure of the rendered docs be
different from that of the plain-text docs; it suggests that one of the two
placements is wrong.

My own choice (as you suggest later) would be to keep the structure the
same in both domains, and to use cross-references to create paths where
they are needed.

> The driver-specific information is messy, as each file there may contain
> either one or more of the following items:
> 
> 	- driver-development information;
> 	- on a few drivers, drivers-specific uAPI.
> 	- modprobe parameters;
> 	- List of devices supported by each driver;
> 
> The last two are probably contents for the admin-guide, but not sure
> where to place driver-specific development information. Does it
> belong to "driver-api" book too?
> 
> I guess that driver-specific uAPI could fit at the userspace-api, but I
> don't want them to be at the same place as the core media API stuff.
> 
> Suggestions?

That is a good question.  I've wondered for a bit if we need a separate
hardware manual for documentation specific to a given device.  In cases
like this, it could perhaps consist mostly of cross-references to the
relevant documentation in the other manuals.  It's hard to argue, for
example, that "modprobe parameters" should be somewhere other than with all
the other command-line parameters...

Thanks,

jon