mbox series

[0/8] tty: split and cleanup headers

Message ID 20210723103147.18250-1-jslaby@suse.cz
Headers show
Series tty: split and cleanup headers | expand

Message

Jiri Slaby July 23, 2021, 10:31 a.m. UTC 
I started writing up kernel-doc documentation of the TTY layer. It
turned out that linux/tty.h is a header containing many structures and
even function definitions. With added kernel-doc documentation for
tty_port, tty_buffer, and other main structures, tty.h grew into a very
large file.

This series moves many declarations/definitions from tty.h to places
where they fit better. For that purpose, we also create two brave new
headers to move there tty_port and tty_buffer structs.

That way, the combination of documentation and code in the headers
remains on maintainable level.

Note: this series is independent (either can be applied first) on the
other series I posted and are not applied yet.

Jiri Slaby (8):
  tty: move tty_driver related prototypes to tty_driver.h
  tty: include kref.h in tty_driver.h
  tty: move ldisc prototypes to tty_ldisc.h
  tty: include list & lockdep from tty_ldisc.h
  tty: move tty_ldisc_receive_buf to tty_flip.h
  tty: move tty_buffer definitions to new tty_buffer.h
  tty: move tty_port to new tty_port.h
  tty: tty_flip.h needs only tty_buffer and tty_port

 include/linux/tty.h        | 275 +------------------------------------
 include/linux/tty_buffer.h |  59 ++++++++
 include/linux/tty_driver.h |  18 +++
 include/linux/tty_flip.h   |   8 +-
 include/linux/tty_ldisc.h  |  17 +++
 include/linux/tty_port.h   | 208 ++++++++++++++++++++++++++++
 6 files changed, 311 insertions(+), 274 deletions(-)
 create mode 100644 include/linux/tty_buffer.h
 create mode 100644 include/linux/tty_port.h

Comments

Greg Kroah-Hartman July 27, 2021, 10:16 a.m. UTC | #1 
On Fri, Jul 23, 2021 at 12:31:39PM +0200, Jiri Slaby wrote:
> I started writing up kernel-doc documentation of the TTY layer. It

> turned out that linux/tty.h is a header containing many structures and

> even function definitions. With added kernel-doc documentation for

> tty_port, tty_buffer, and other main structures, tty.h grew into a very

> large file.

> 

> This series moves many declarations/definitions from tty.h to places

> where they fit better. For that purpose, we also create two brave new

> headers to move there tty_port and tty_buffer structs.

> 

> That way, the combination of documentation and code in the headers

> remains on maintainable level.


Thanks for the cleanups, much appreciated, now applied.

greg k-h