[PATCH v2 0/7] drivers: tty: Fix kernel-docs comments

Tobin C. Harding
2018-10-18T22:38:08Z

Hi,

v2 with the author amended to use the correct _new_ email address
(thanks Geert and Greg) so that the SoB is correct.

Applies on top of tty-next tree.

From v1:

My first patch set using kernel.org email address. I've been so careful
with this one I'm expecting some epic fail :)

This set is an attempt to clean up the kernel docs comments under
drivers/tty/. I do not know what time in the kernel dev cycle would be
best for this set. If now is not the time please do not hesitate to say
so and stop reading here.

I included a couple of whitespace patches to kick off with, in hindsight
these might be nothing more than code churn (if so I can remove them).

I had a real hard time breaking these changes up into separate patches.
This was mainly because I was super conscious that this set is
borderline trivial yet large enough to be a P in the A to review. I
have reviewed these patches a bunch of times myself and am happy with
the result being as easy to review as I know how. If there was anything
more I could have done please say. Patch 3 and 7 are the two that are
most arduous to review.

Apart from the first two whitespace patches only comments are touched by
this set. The set builds cleanly but does _not_ checkpatch cleanly -
there is a limit to the code churn I was willing to risk posting :)

Extra thanks to anyone who reviews this. This set is super non-critical
so please only review at your leisure.

thanks,
Tobin.

v2:
- Check author of each patch, run when required:
`git commit --amend --author="Tobin C. Harding <tobin@kernel.org>"
- Fix introduced 'space before tab warnings' in patch 3 and 7.

Tobin C. Harding (7):
tty: Fix whitespace before tab warnings
tty: Remove trailing whitespace
tty: Partially fix kernel-docs layout
tty: Fix kernel-doc variable typos
tty: Fix spacing between kernel-doc sections
tty: Remove newline after function kernel-doc
tty: Fix section format

drivers/tty/amiserial.c | 62 +-
drivers/tty/cyclades.c | 2 +-
drivers/tty/ehv_bytechan.c | 2 +-
drivers/tty/hvc/hvc_console.c | 8 +-
drivers/tty/hvc/hvc_iucv.c | 14 +-
drivers/tty/hvc/hvc_xen.c | 2 +-
drivers/tty/hvc/hvcs.c | 4 +-
drivers/tty/ipwireless/tty.c | 2 +-
drivers/tty/isicom.c | 4 +-
drivers/tty/mips_ejtag_fdc.c | 4 +-
drivers/tty/moxa.c | 38 +-
drivers/tty/mxser.c | 14 +-
drivers/tty/n_gsm.c | 754 +++++++-------
drivers/tty/n_hdlc.c | 208 ++--
drivers/tty/n_r3964.c | 6 +-
drivers/tty/n_tracerouter.c | 18 +-
drivers/tty/n_tracesink.c | 24 +-
drivers/tty/n_tty.c | 688 ++++++-------
drivers/tty/pty.c | 126 ++-
drivers/tty/rocket.c | 78 +-
drivers/tty/serdev/core.c | 2 +-
drivers/tty/serial/21285.c | 2 +-
drivers/tty/serial/8250/8250_core.c | 72 +-
drivers/tty/serial/8250/8250_dw.c | 4 +-
drivers/tty/serial/8250/8250_port.c | 42 +-
drivers/tty/serial/amba-pl010.c | 2 +-
drivers/tty/serial/amba-pl011.c | 34 +-
drivers/tty/serial/cpm_uart/cpm_uart_core.c | 8 +-
drivers/tty/serial/earlycon.c | 26 +-
drivers/tty/serial/icom.c | 5 +-
drivers/tty/serial/ifx6x60.c | 387 ++++---
drivers/tty/serial/ioc3_serial.c | 73 +-
drivers/tty/serial/ioc4_serial.c | 85 +-
drivers/tty/serial/ip22zilog.c | 2 +-
drivers/tty/serial/jsm/jsm_neo.c | 2 +-
drivers/tty/serial/kgdb_nmi.c | 2 +-
drivers/tty/serial/max3100.c | 2 +-
drivers/tty/serial/max310x.c | 2 +-
drivers/tty/serial/men_z135_uart.c | 5 +-
drivers/tty/serial/mux.c | 62 +-
drivers/tty/serial/mxs-auart.c | 2 +-
drivers/tty/serial/pmac_zilog.c | 62 +-
drivers/tty/serial/pxa.c | 20 +-
drivers/tty/serial/sa1100.c | 2 +-
drivers/tty/serial/serial-tegra.c | 4 +-
drivers/tty/serial/serial_core.c | 198 ++--
drivers/tty/serial/serial_txx9.c | 23 +-
drivers/tty/serial/sn_console.c | 105 +-
drivers/tty/serial/sunsab.c | 16 +-
drivers/tty/serial/sunsu.c | 8 +-
drivers/tty/serial/sunzilog.c | 10 +-
drivers/tty/serial/uartlite.c | 15 +-
drivers/tty/serial/ucc_uart.c | 134 +--
drivers/tty/serial/vr41xx_siu.c | 2 +-
drivers/tty/serial/xilinx_uartps.c | 71 +-
drivers/tty/serial/zs.c | 12 +-
drivers/tty/synclink.c | 1016 +++++++++----------
drivers/tty/synclinkmp.c | 16 +-
drivers/tty/sysrq.c | 34 +-
drivers/tty/tty_audit.c | 39 +-
drivers/tty/tty_baudrate.c | 77 +-
drivers/tty/tty_buffer.c | 245 +++--
drivers/tty/tty_io.c | 847 ++++++++--------
drivers/tty/tty_ioctl.c | 222 ++--
drivers/tty/tty_jobctrl.c | 140 ++-
drivers/tty/tty_ldisc.c | 290 +++---
drivers/tty/tty_port.c | 124 ++-
drivers/tty/vt/consolemap.c | 84 +-
drivers/tty/vt/keyboard.c | 165 +--
drivers/tty/vt/selection.c | 40 +-
drivers/tty/vt/vt.c | 138 ++-
drivers/tty/vt/vt_ioctl.c | 70 +-
72 files changed, 3452 insertions(+), 3656 deletions(-)

--
2.17.1