Re: [PATCH 3/4] media: admin-guide: Add an introduction chapter

[Hans Verkuil <hverkuil-cisco@xs4all.nl>]

On 16/04/2020 13:36, Mauro Carvalho Chehab wrote:
> The media's admin guide is currently just a group of
> not-connected docs.
> 
> Add an introduction chapter for it to start making sense
> to a random reader.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  Documentation/admin-guide/media/index.rst |  2 ++
>  Documentation/admin-guide/media/intro.rst | 25 +++++++++++++++++++++++
>  2 files changed, 27 insertions(+)
>  create mode 100644 Documentation/admin-guide/media/intro.rst
> 
> diff --git a/Documentation/admin-guide/media/index.rst b/Documentation/admin-guide/media/index.rst
> index 6e5e6bdb6d4b..f79d4f1e05ba 100644
> --- a/Documentation/admin-guide/media/index.rst
> +++ b/Documentation/admin-guide/media/index.rst
> @@ -34,6 +34,8 @@ Video4Linux (V4L)  driver-specific documentation
>  	:maxdepth: 5
>  	:numbered:
>  
> +	intro
> +
>  	cardlist
>  
>  	v4l-with-ir
> diff --git a/Documentation/admin-guide/media/intro.rst b/Documentation/admin-guide/media/intro.rst
> new file mode 100644
> index 000000000000..9b6399fd904f
> --- /dev/null
> +++ b/Documentation/admin-guide/media/intro.rst
> @@ -0,0 +1,25 @@
> +============
> +Introduction
> +============
> +
> +The media subsystem consists on Linux support for several different types
> +of devices:

I'd rephrase this to:

The media subsystem supports several different types of devices:

> +
> +- Audio and video grabbers;

I'd say 'Video and audio grabbers' since video is the main use-case.

> +- PC and Laptop Cameras;

I'd replace 'PC' with 'Webcams'.

> +- Complex cameras found on Embedded hardware;
> +- Analog and digital TV;
> +- HDMI Customer Electronics Control (CEC);

Customer -> Consumer

> +- Multi-touch input devices;
> +- Remote Controllers;
> +- Media encoders and decoders.

Add:

- AM/FM Radio and RDS receivers/transmitters
- Software Defines Radio receivers/transmitters

> +
> +Due to the diversity of devices, the subsystem provides several different
> +APIs:
> +
> +- Remote Controller API;
> +- HDMI CEC API;
> +- Video4Linux API;
> +- Media controller API;
> +- Video4Linux Request API (experimental);

I think this can be dropped since it is part of the Media controller API. It's
not a separate API as such.

> +- Digital TV API (also known as DVB API).
> 

Regards,

	Hans