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

From: Fabio M. De Francesco
Date: Thu Aug 26 2021 - 09:03:51 EST

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@xxxxxxxxx>

v1->v2: According to reviews by Fabio Aiuto <fabioaiuto83@xxxxxxxxx> and Greg K-H
<gregkh@xxxxxxxxxxxxxxxxxxx>, remove "[] is currently in development...",
indent and properly wrap the lines, remove the unnecessary last paragraph.

Thanks to Phillip Potter <phil@xxxxxxxxxxxxxxxx> for for providing the first draft.

drivers/staging/r8188eu/TODO | 12 ++++++++++++
1 file changed, 12 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..d2f21b35fbcb
--- /dev/null
+++ b/drivers/staging/r8188eu/TODO
@@ -0,0 +1,12 @@
+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.
+* Switch to use MAC80211.