Re: [PATCH v4 1/8] usb: Add MA-USB Host kernel module

[Alan Stern]

On Fri, 27 Mar 2020 vladimir.stankovic@xxxxxxxxxxxxxxx wrote:

> Added utility macros, kernel device creation and cleanup, functions for
> handling log formatting and a placeholder module for MA-USB Host device
> driver.
> 
> Signed-off-by: Vladimir Stankovic <vladimir.stankovic@xxxxxxxxxxxxxxx>

> index 235ab38ed478..12aac44196d7 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -10226,6 +10226,13 @@ W:	https://linuxtv.org
>  S:	Maintained
>  F:	drivers/media/radio/radio-maxiradio*
>  
> +MA USB HOST DRIVER

It would be an excellent idea to change this title to:

MA (MEDIA-AGNOSTIC) USB HOST DRIVER

Otherwise to me it looks like the Massachusetts USB HOST DRIVER, since
MA is the 2-letter abbreviation for the state where I live.  A
two-letter acronym is just too generic; you mustn't expect people to
understand it.

> +M:	Vladimir Stankovic <vladimir.stankovic@xxxxxxxxxxxxxxx>
> +L:	mausb-host-devel@xxxxxxxxxxxxxxx
> +W:	https://www.displaylink.com
> +S:	Maintained
> +F:	drivers/usb/mausb_host/*
> +

> --- /dev/null
> +++ b/drivers/usb/mausb_host/Kconfig
> @@ -0,0 +1,14 @@
> +# SPDX-License-Identifier: GPL-2.0
> +#
> +# Kernel configuration file for MA-USB Host driver.
> +#
> +# Copyright (c) 2019 - 2020 DisplayLink (UK) Ltd.
> +#
> +
> +config HOST_MAUSB
> +	tristate "MA-USB Host Driver"
> +	depends on USB=y
> +	default n

No need for this line; n is always the default setting unless you
specify otherwise.

> +	help
> +		This is a MA-USB Host driver which enables host communication
> +		via MA-USB protocol stack.

And I insist that you insert "Media Agnostic" in here somewhere, either 
in the "tristate" line or in the help.  Without this, people trying to 
configure their kernels will have no idea whether or not they should 
enable the setting because they won't know what MA-USB is.

It also wouldn't hurt to mention in the help text that if the driver is
built as a module, the name of the module will be "mausb_host".

Alan Stern