Re: [PATCH net-next v4 14/14] yt6801: update ethernet documentation and maintainer

[Yanteng Si <si.yanteng@linux.dev>]

Hi Frank, Xiaogang, Zhang Fei, and Sun Hua,

在 4/8/25 5:28 PM, Frank Sae 写道:
> Add the yt6801.rst in ethernet/motorcomm folder
> Add the yt6801 entry in the index.rst.
> Add myself as the maintainer for the motorcomm ethernet driver.
Would it be possible to split it into two patches?

patch 1 Add docs
patch 2 Modify MAINTAINERS

> 
> Signed-off-by: Frank Sae <Frank.Sae@motor-comm.com>
> ---
>   .../device_drivers/ethernet/index.rst         |  1 +
>   .../ethernet/motorcomm/yt6801.rst             | 20 +++++++++++++++++++
>   MAINTAINERS                                   |  8 ++++++++
>   3 files changed, 29 insertions(+)
>   create mode 100644 Documentation/networking/device_drivers/ethernet/motorcomm/yt6801.rst
> 
> diff --git a/Documentation/networking/device_drivers/ethernet/index.rst b/Documentation/networking/device_drivers/ethernet/index.rst
> index 05d822b90..7a158af55 100644
> --- a/Documentation/networking/device_drivers/ethernet/index.rst
> +++ b/Documentation/networking/device_drivers/ethernet/index.rst
> @@ -46,6 +46,7 @@ Contents:
>      mellanox/mlx5/index
>      meta/fbnic
>      microsoft/netvsc
> +   motorcomm/yt6801
>      neterion/s2io
>      netronome/nfp
>      pensando/ionic
> diff --git a/Documentation/networking/device_drivers/ethernet/motorcomm/yt6801.rst b/Documentation/networking/device_drivers/ethernet/motorcomm/yt6801.rst
> new file mode 100644
> index 000000000..dd1e59c33
> --- /dev/null
> +++ b/Documentation/networking/device_drivers/ethernet/motorcomm/yt6801.rst
> @@ -0,0 +1,20 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +================================================================

> +Linux Base Driver for Motorcomm(R) Gigabit PCI Express Adapters
The title is great!

> +================================================================
> +

> +Motorcomm Gigabit Linux driver.
> +Copyright (c) 2021 - 2024 Motor-comm Co., Ltd.
I'm not sure if it's appropriate to write it this way. I don't object to 
them, but I think it's a bit strange to put them below the title.

Actually, this is a suitable place to write an introduction.

> +
> +

> +Contents
> +========
> +
> +- Support
Could this be all of the content? It appears to deviate slightly from 
the title.

> +
> +

> +Support
> +=======
> +If you got any problem, contact Motorcomm support team via support@motor-comm.com
> +and Cc: netdev.
I think this part of the content can be written in the code comments.

> diff --git a/MAINTAINERS b/MAINTAINERS
> index 4c5c2e2c1..1d7700e6b 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -16351,6 +16351,14 @@ F:	drivers/most/
>   F:	drivers/staging/most/
>   F:	include/linux/most.h
>   
> +MOTORCOMM ETHERNET DRIVER
> +M:	Frank <Frank.Sae@motor-comm.com>
> +L:	netdev@vger.kernel.org
> +S:	Maintained
> +W:	https://www.motor-comm.com/

> +F:	Documentation/networking/device_drivers/ethernet/motorcomm/*
I'm quite interested in the long-term planning of this directory. 
Because compared with the documents in other parallel directories 
(wangxun is not a good example), there is still a great deal of content 
that needs to be written. Of course, I'm not sure if there are any 
engineers in your team whose mother tongue is Chinese. If it's 
convenient, it would be even better if a Chinese document could be 
prepared as well.


Thanks,
Yanteng