LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Jiri Slaby <jslaby@suse.cz>
To: gregkh@linuxfoundation.org
Cc: linux-serial@vger.kernel.org, linux-kernel@vger.kernel.org,
	Jiri Slaby <jslaby@suse.cz>
Subject: [PATCH 00/23] tty: documentation revamp
Date: Fri, 26 Nov 2021 09:15:48 +0100	[thread overview]
Message-ID: <20211126081611.11001-1-jslaby@suse.cz> (raw)

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


             reply	other threads:[~2021-11-26  8:18 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-26  8:15 Jiri Slaby [this message]
2021-11-26  8:15 ` [PATCH 01/23] tty: finish kernel-doc of tty_struct members Jiri Slaby
2021-11-26  8:15 ` [PATCH 02/23] tty: add kernel-doc for tty_port Jiri Slaby
2021-11-26  8:15 ` [PATCH 03/23] tty: add kernel-doc for tty_driver Jiri Slaby
2021-11-26  8:15 ` [PATCH 04/23] tty: add kernel-doc for tty_operations Jiri Slaby
2021-11-26  8:15 ` [PATCH 05/23] tty: add kernel-doc for tty_port_operations Jiri Slaby
2021-11-26  8:15 ` [PATCH 06/23] tty: add kernel-doc for tty_ldisc_ops Jiri Slaby
2021-11-26  8:15 ` [PATCH 07/23] tty: combine tty_operations triple docs into kernel-doc Jiri Slaby
2021-11-26  8:15 ` [PATCH 08/23] tty: combine tty_ldisc_ops " Jiri Slaby
2021-11-26  8:15 ` [PATCH 09/23] tty: reformat tty_struct::flags " Jiri Slaby
2021-11-26  8:15 ` [PATCH 10/23] tty: reformat TTY_DRIVER_ flags " Jiri Slaby
2021-11-26  8:15 ` [PATCH 11/23] tty: reformat kernel-doc in tty_port.c Jiri Slaby
2021-11-26  8:16 ` [PATCH 12/23] tty: reformat kernel-doc in tty_io.c Jiri Slaby
2021-11-26  8:16 ` [PATCH 13/23] tty: reformat kernel-doc in tty_ldisc.c Jiri Slaby
2021-11-26  8:16 ` [PATCH 14/23] tty: reformat kernel-doc in tty_buffer.c Jiri Slaby
2021-11-26  8:16 ` [PATCH 15/23] tty: fix kernel-doc in n_tty.c Jiri Slaby
2021-11-26  8:16 ` [PATCH 16/23] tty: reformat " Jiri Slaby
2021-11-26  8:16 ` [PATCH 17/23] tty: add kernel-doc for more tty_driver functions Jiri Slaby
2021-11-26  8:16 ` [PATCH 18/23] tty: add kernel-doc for more tty_port functions Jiri Slaby
2021-11-26  8:16 ` [PATCH 19/23] tty: move tty_ldisc docs to new Documentation/tty/ Jiri Slaby
2021-11-26  8:16 ` [PATCH 20/23] tty: make tty_ldisc docs up-to-date Jiri Slaby
2021-11-26  8:16 ` [PATCH 21/23] tty: more kernel-doc for tty_ldisc Jiri Slaby
2021-11-26  8:16 ` [PATCH 22/23] tty: add kernel-doc for tty_standard_install Jiri Slaby
2021-11-26  8:16 ` [PATCH 23/23] Documentation: add TTY chapter Jiri Slaby
2021-11-26 15:28 ` [PATCH 00/23] tty: documentation revamp Greg KH

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211126081611.11001-1-jslaby@suse.cz \
    --to=jslaby@suse.cz \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-serial@vger.kernel.org \
    --subject='Re: [PATCH 00/23] tty: documentation revamp' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).