linux-kernel - [PATCH 00/23] tty: documentation revamp

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 26 Nov 2021 09:15:48 +0100
From:   Jiri Slaby <jslaby@...e.cz>
To:     gregkh@...uxfoundation.org
Cc:     linux-serial@...r.kernel.org, linux-kernel@...r.kernel.org,
        Jiri Slaby <jslaby@...e.cz>
Subject: [PATCH 00/23] tty: documentation revamp

This series adds/updates:
1) kernel-doc documentation for most exported functions, and
2) adds a chapter to Documentation/tty to glue it all together.

I think it's a good base for further improvements. It deduplicates
and unify multiple documentation files.

Jiri Slaby (23):
  tty: finish kernel-doc of tty_struct members
  tty: add kernel-doc for tty_port
  tty: add kernel-doc for tty_driver
  tty: add kernel-doc for tty_operations
  tty: add kernel-doc for tty_port_operations
  tty: add kernel-doc for tty_ldisc_ops
  tty: combine tty_operations triple docs into kernel-doc
  tty: combine tty_ldisc_ops docs into kernel-doc
  tty: reformat tty_struct::flags into kernel-doc
  tty: reformat TTY_DRIVER_ flags into kernel-doc
  tty: reformat kernel-doc in tty_port.c
  tty: reformat kernel-doc in tty_io.c
  tty: reformat kernel-doc in tty_ldisc.c
  tty: reformat kernel-doc in tty_buffer.c
  tty: fix kernel-doc in n_tty.c
  tty: reformat kernel-doc in n_tty.c
  tty: add kernel-doc for more tty_driver functions
  tty: add kernel-doc for more tty_port functions
  tty: move tty_ldisc docs to new Documentation/tty/
  tty: make tty_ldisc docs up-to-date
  tty: more kernel-doc for tty_ldisc
  tty: add kernel-doc for tty_standard_install
  Documentation: add TTY chapter

 Documentation/driver-api/serial/index.rst |   1 -
 Documentation/driver-api/serial/tty.rst   | 328 --------
 Documentation/index.rst                   |   1 +
 Documentation/tty/index.rst               |  63 ++
 Documentation/tty/n_tty.rst               |  22 +
 Documentation/tty/tty_buffer.rst          |  46 ++
 Documentation/tty/tty_driver.rst          | 128 ++++
 Documentation/tty/tty_internals.rst       |  31 +
 Documentation/tty/tty_ldisc.rst           |  85 +++
 Documentation/tty/tty_port.rst            |  70 ++
 Documentation/tty/tty_struct.rst          |  81 ++
 drivers/tty/n_tty.c                       | 688 ++++++++---------
 drivers/tty/tty_buffer.c                  | 251 +++---
 drivers/tty/tty_io.c                      | 889 +++++++++++-----------
 drivers/tty/tty_ldisc.c                   | 292 ++++---
 drivers/tty/tty_port.c                    | 223 ++++--
 include/linux/tty.h                       | 153 +++-
 include/linux/tty_driver.h                | 572 ++++++++------
 include/linux/tty_ldisc.h                 | 278 +++----
 include/linux/tty_port.h                  | 131 ++--
 20 files changed, 2408 insertions(+), 1925 deletions(-)
 delete mode 100644 Documentation/driver-api/serial/tty.rst
 create mode 100644 Documentation/tty/index.rst
 create mode 100644 Documentation/tty/n_tty.rst
 create mode 100644 Documentation/tty/tty_buffer.rst
 create mode 100644 Documentation/tty/tty_driver.rst
 create mode 100644 Documentation/tty/tty_internals.rst
 create mode 100644 Documentation/tty/tty_ldisc.rst
 create mode 100644 Documentation/tty/tty_port.rst
 create mode 100644 Documentation/tty/tty_struct.rst

-- 
2.34.0