diff options
| author | Jiri Slaby <jslaby@suse.cz> | 2022-04-11 13:01:38 +0200 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2022-04-14 18:24:23 +0200 |
| commit | b96cd8b05ead8939b972192c4f4ac2fc2dffceb7 (patch) | |
| tree | b554644a530ad0fffc2201a759c2ffaf951244bc /Documentation/tty/tty_buffer.rst | |
| parent | ce522ba9ef7e2d9fb22a39eb3371c0c64e2a433e (diff) | |
| download | linux-b96cd8b05ead8939b972192c4f4ac2fc2dffceb7.tar.gz | |
Documentation: move tty to driver-api
Based on discussion starting as 87mthw2o93.fsf@meer.lwn.net, let's move the tty documentation to driver-api. It's more appropriate there. Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Jiri Slaby <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220411110143.10019-2-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/tty/tty_buffer.rst')
| -rw-r--r-- | Documentation/tty/tty_buffer.rst | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/Documentation/tty/tty_buffer.rst b/Documentation/tty/tty_buffer.rst deleted file mode 100644 index a39d4781e0d2..000000000000 --- a/Documentation/tty/tty_buffer.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. SPDX-License-Identifier: GPL-2.0 - -========== -TTY Buffer -========== - -.. contents:: :local: - -Here, we document functions for taking care of tty buffer and their flipping. -Drivers are supposed to fill the buffer by one of those functions below and -then flip the buffer, so that the data are passed to :doc:`line discipline -<tty_ldisc>` for further processing. - -Flip Buffer Management -====================== - -.. kernel-doc:: drivers/tty/tty_buffer.c - :identifiers: tty_prepare_flip_string tty_insert_flip_string_fixed_flag - tty_insert_flip_string_flags __tty_insert_flip_char - tty_flip_buffer_push tty_ldisc_receive_buf - ----- - -Other Functions -=============== - -.. kernel-doc:: drivers/tty/tty_buffer.c - :identifiers: tty_buffer_space_avail tty_buffer_set_limit - ----- - -Buffer Locking -============== - -These are used only in special circumstances. Avoid them. - -.. kernel-doc:: drivers/tty/tty_buffer.c - :identifiers: tty_buffer_lock_exclusive tty_buffer_unlock_exclusive - ----- - -Internal Functions -================== - -.. kernel-doc:: drivers/tty/tty_buffer.c - :internal: |