Re: [PATCH v2 1/2] ALSA: docs: Add Marian M2 driver documentation

From: Greg KH
Date: Tue Sep 19 2023 - 04:31:26 EST


On Mon, Sep 18, 2023 at 10:10:43PM +0400, Ivan Orlov wrote:
> Add documentation for the new MARIAN Seraph M2 sound card. It covers
> current development status, available controls of the card and
> information about the integrated loopback.
>
> Signed-off-by: Ivan Orlov <ivan.orlov0322@xxxxxxxxx>
> ---
> V1 -> V2:
> - Remove redundant documentation fix from the next patch in the series
>
> Documentation/sound/cards/index.rst | 1 +
> Documentation/sound/cards/marian-m2.rst | 104 ++++++++++++++++++++++++
> 2 files changed, 105 insertions(+)
> create mode 100644 Documentation/sound/cards/marian-m2.rst
>
> diff --git a/Documentation/sound/cards/index.rst b/Documentation/sound/cards/index.rst
> index e68bbb13c384..e873592d8d00 100644
> --- a/Documentation/sound/cards/index.rst
> +++ b/Documentation/sound/cards/index.rst
> @@ -19,3 +19,4 @@ Card-Specific Information
> serial-u16550
> img-spdif-in
> pcmtest
> + marian-m2
> diff --git a/Documentation/sound/cards/marian-m2.rst b/Documentation/sound/cards/marian-m2.rst
> new file mode 100644
> index 000000000000..bf12445e20d7
> --- /dev/null
> +++ b/Documentation/sound/cards/marian-m2.rst
> @@ -0,0 +1,104 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=======================
> +MARIAN Seraph M2 Driver
> +=======================
> +
> +Sep 18, 2023
> +
> +Ivan Orlov <ivan.orlov0322@xxxxxxxxx>
> +
> +STATE OF DEVELOPMENT
> +====================
> +
> +This driver is based on the driver written by Florian Faber in 2012, which seemed to work fine.
> +However, the initial code contained multiple issues, which had to be solved before sending the
> +driver upstream.

Minor nit, shouldn't these lines be wrapped a bit shorter as it's a text
file? 80 columns? The other files in this directory seem to all do
that so maybe do the same here as well?

thanks,

greg k-h