[PATCH] staging: r8188eu: Provide a TODO file for this driver

[PATCH] staging: r8188eu: Provide a TODO file for this driver

[Fabio M. De Francesco]

Provide a TODO file that lists the tasks that should be carried out in
order to move this driver off drivers/staging.

Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
---

Thanks to Phillip Potter <phil@philpotter.co.uk> for for providing the first draft.

 drivers/staging/r8188eu/TODO | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 drivers/staging/r8188eu/TODO

diff --git a/drivers/staging/r8188eu/TODO b/drivers/staging/r8188eu/TODO
new file mode 100644
index 000000000000..4bccca69abac
--- /dev/null
+++ b/drivers/staging/r8188eu/TODO
@@ -0,0 +1,16 @@
+To-do list:
+
+* Correct the coding style according to Linux guidelines; please read the document
+at https://www.kernel.org/doc/html/latest/process/coding-style.html.
+* Remove unnecessary debugging/printing macros; for those that are still needed
+use the proper kernel API (pr_debug(), dev_dbg(), netdev_dbg()).
+* Remove dead code such as unusued functions, variables, fields, etc..
+* Use in-kernel API and remove unnecessary wrappers where possible.
+* Remove the HAL layer and migrate its functionality into the relevant parts of
+the driver.
+* Switch to use LIB80211 (This work is currently in development by Larry Finger).
+* Switch to use MAC80211 (This work is currently in development by Larry Finger).
+
+Please send any patches to Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
+Larry Finger <Larry.Finger@lwfinger.net>, Phillip Potter <phil@philpotter.co.uk>
+and CC linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org.
-- 
2.32.0

Re: [PATCH] staging: r8188eu: Provide a TODO file for this driver

[Fabio Aiuto]

Hello Fabio,

On Thu, Aug 26, 2021 at 03:49:59AM +0200, Fabio M. De Francesco wrote:
> Provide a TODO file that lists the tasks that should be carried out in
> order to move this driver off drivers/staging.
> 
> Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
> ---
> 
> Thanks to Phillip Potter <phil@philpotter.co.uk> for for providing the first draft.
> 
>  drivers/staging/r8188eu/TODO | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>  create mode 100644 drivers/staging/r8188eu/TODO
> 
> diff --git a/drivers/staging/r8188eu/TODO b/drivers/staging/r8188eu/TODO
> new file mode 100644
> index 000000000000..4bccca69abac
> --- /dev/null
> +++ b/drivers/staging/r8188eu/TODO
> @@ -0,0 +1,16 @@
> +To-do list:
> +
> +* Correct the coding style according to Linux guidelines; please read the document
> +at https://www.kernel.org/doc/html/latest/process/coding-style.html.
> +* Remove unnecessary debugging/printing macros; for those that are still needed
> +use the proper kernel API (pr_debug(), dev_dbg(), netdev_dbg()).
> +* Remove dead code such as unusued functions, variables, fields, etc..
> +* Use in-kernel API and remove unnecessary wrappers where possible.
> +* Remove the HAL layer and migrate its functionality into the relevant parts of
> +the driver.
> +* Switch to use LIB80211 (This work is currently in development by Larry Finger).
> +* Switch to use MAC80211 (This work is currently in development by Larry Finger).

Maybe I'm wrong but I think Larry is working on cfg80211 not exactly with
lib80211 or mac80211. So I'd remove the clauses on parentheses.

> +
> +Please send any patches to Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
> +Larry Finger <Larry.Finger@lwfinger.net>, Phillip Potter <phil@philpotter.co.uk>
> +and CC linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org.
> -- 
> 2.32.0
> 
> 

thank you,

fabio

Re: [PATCH] staging: r8188eu: Provide a TODO file for this driver

[Greg KH]

On Thu, Aug 26, 2021 at 03:49:59AM +0200, Fabio M. De Francesco wrote:
> Provide a TODO file that lists the tasks that should be carried out in
> order to move this driver off drivers/staging.
> 
> Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
> ---
> 
> Thanks to Phillip Potter <phil@philpotter.co.uk> for for providing the first draft.
> 
>  drivers/staging/r8188eu/TODO | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>  create mode 100644 drivers/staging/r8188eu/TODO
> 
> diff --git a/drivers/staging/r8188eu/TODO b/drivers/staging/r8188eu/TODO
> new file mode 100644
> index 000000000000..4bccca69abac
> --- /dev/null
> +++ b/drivers/staging/r8188eu/TODO
> @@ -0,0 +1,16 @@
> +To-do list:
> +
> +* Correct the coding style according to Linux guidelines; please read the document
> +at https://www.kernel.org/doc/html/latest/process/coding-style.html.

Indent and properly wrap your lines at the right width please.

> +* Remove unnecessary debugging/printing macros; for those that are still needed
> +use the proper kernel API (pr_debug(), dev_dbg(), netdev_dbg()).
> +* Remove dead code such as unusued functions, variables, fields, etc..
> +* Use in-kernel API and remove unnecessary wrappers where possible.
> +* Remove the HAL layer and migrate its functionality into the relevant parts of
> +the driver.
> +* Switch to use LIB80211 (This work is currently in development by Larry Finger).
> +* Switch to use MAC80211 (This work is currently in development by Larry Finger).

No need to say "is being done by XXX" anywhere, as that stops people
from helping out on this instantly.

> +Please send any patches to Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
> +Larry Finger <Larry.Finger@lwfinger.net>, Phillip Potter <phil@philpotter.co.uk>
> +and CC linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org.

As the MAINTAINERS file lists this properly, no need for this paragraph.
That can also be removed from any remaining TODO files that have it in
it that also have correct MAINTAINERS entries.

thanks,

greg k-h

Re: [PATCH] staging: r8188eu: Provide a TODO file for this driver

[Larry Finger]

On 8/26/21 5:19 AM, Fabio Aiuto wrote:
> Maybe I'm wrong but I think Larry is working on cfg80211 not exactly with
> lib80211 or mac80211. So I'd remove the clauses on parentheses.
> 
That is correct. I am not changing it to work with mac80211 - merely cfg80211. 
Making it work with mac80211 would be a worthy goal, but not mine.

Larry