[PATCH v2 5/7] tty: Fix spacing between kernel-doc sections

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

There is a specified spacing for kernel-doc layout in
Documentation/doc-guide/kernel-doc.rst we should try to adhere to it as
much as possible.

Fix spacing between sections.

Signed-off-by: Tobin C. Harding <tobin@kernel.org>
---
drivers/tty/n_hdlc.c | 2 ++
drivers/tty/serial/serial-tegra.c | 2 --
drivers/tty/serial/uartlite.c | 5 +----
drivers/tty/tty_buffer.c | 1 +
drivers/tty/tty_port.c | 2 --
5 files changed, 4 insertions(+), 8 deletions(-)

diff --git a/drivers/tty/n_hdlc.c b/drivers/tty/n_hdlc.c
index 4b7aaf9ee09c..5b0c776a43a2 100644
--- a/drivers/tty/n_hdlc.c
+++ b/drivers/tty/n_hdlc.c
@@ -794,6 +794,7 @@ static int n_hdlc_tty_ioctl(struct tty_struct *tty, struct file *file,
*
* Determine which operations (read/write) will not block and return info
* to caller.
+ *
* Returns a bit mask containing info on which ops will not block.
*/
static __poll_t n_hdlc_tty_poll(struct tty_struct *tty, struct file *filp,
@@ -918,6 +919,7 @@ static void n_hdlc_buf_put(struct n_hdlc_buf_list *buf_list,
*
* Remove and return an HDLC buffer from the head of the specified HDLC buffer
* list.
+ *
* Returns a pointer to HDLC buffer if available, otherwise %NULL.
*/
static struct n_hdlc_buf *n_hdlc_buf_get(struct n_hdlc_buf_list *buf_list)
diff --git a/drivers/tty/serial/serial-tegra.c b/drivers/tty/serial/serial-tegra.c
index 872f3b2ed196..cb240a899127 100644
--- a/drivers/tty/serial/serial-tegra.c
+++ b/drivers/tty/serial/serial-tegra.c
@@ -74,7 +74,6 @@

/**
* tegra_uart_chip_data: SOC specific data.
- *
* @tx_fifo_full_status: Status flag available for checking tx fifo full.
* @allow_txfifo_reset_fifo_mode: allow_tx fifo reset with fifo mode or not.
* Tegra30 does not allow this.
@@ -220,7 +219,6 @@ static void tegra_uart_break_ctl(struct uart_port *u, int break_ctl)

/**
* tegra_uart_wait_cycle_time() - Wait for N UART clock periods
- *
* @tup: Tegra serial port data structure.
* @cycles: Number of clock periods to wait.
*
diff --git a/drivers/tty/serial/uartlite.c b/drivers/tty/serial/uartlite.c
index 94a91748da40..718d3bbd002d 100644
--- a/drivers/tty/serial/uartlite.c
+++ b/drivers/tty/serial/uartlite.c
@@ -605,7 +605,6 @@ static struct uart_driver ulite_uart_driver = {

/**
* ulite_assign() - register a uartlite device with the driver
- *
* @dev: pointer to device structure
* @id: requested id number. Pass -1 for automatic port assignment
* @base: base address of uartlite registers
@@ -687,7 +686,6 @@ static int ulite_assign(struct device *dev, int id, u32 base, int irq,

/**
* ulite_release() - register a uartlite device with the driver
- *
* @dev: pointer to device structure
*/
static int ulite_release(struct device *dev)
@@ -706,7 +704,6 @@ static int ulite_release(struct device *dev)

/**
* ulite_suspend() - Stop the device.
- *
* @dev: handle to the device structure.
* Return: 0 always.
*/
@@ -722,8 +719,8 @@ static int __maybe_unused ulite_suspend(struct device *dev)

/**
* ulite_resume() - Resume the device.
- *
* @dev: handle to the device structure.
+ *
* Return: 0 on success, errno otherwise.
*/
static int __maybe_unused ulite_resume(struct device *dev)
diff --git a/drivers/tty/tty_buffer.c b/drivers/tty/tty_buffer.c
index d50dbe06896b..5f05500ee4d0 100644
--- a/drivers/tty/tty_buffer.c
+++ b/drivers/tty/tty_buffer.c
@@ -148,6 +148,7 @@ void tty_buffer_free_all(struct tty_port *port)
* Allocate a new tty buffer to hold the desired number of characters.
* We round our buffers off in 256 character chunks to get better
* allocation behaviour.
+ *
* Return NULL if out of memory or the allocation would exceed the
* per device queue
*/
diff --git a/drivers/tty/tty_port.c b/drivers/tty/tty_port.c
index 60927a52ec9c..d4dfe29a6348 100644
--- a/drivers/tty/tty_port.c
+++ b/drivers/tty/tty_port.c
@@ -363,7 +363,6 @@ EXPORT_SYMBOL(tty_port_hangup);

/**
* tty_port_tty_hangup() - helper to hang up a tty
- *
* @port: tty port
* @check_clocal: hang only ttys with CLOCAL unset?
*/
@@ -379,7 +378,6 @@ EXPORT_SYMBOL_GPL(tty_port_tty_hangup);

/**
* tty_port_tty_wakeup() - helper to wake up a tty
- *
* @port: tty port
*/
void tty_port_tty_wakeup(struct tty_port *port)
--
2.17.1