[45/45] Documentation: add console.rst

Message ID	20240118075756.10541-46-jirislaby@kernel.org
State	Superseded
Headers	show Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4C77C358A0; Thu, 18 Jan 2024 07:59:40 +0000 (UTC) From: "Jiri Slaby (SUSE)" <jirislaby@kernel.org> To: gregkh@linuxfoundation.org Cc: linux-serial@vger.kernel.org, linux-kernel@vger.kernel.org, "Jiri Slaby (SUSE)" <jirislaby@kernel.org>, Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org Subject: [PATCH 45/45] Documentation: add console.rst Date: Thu, 18 Jan 2024 08:57:56 +0100 Message-ID: <20240118075756.10541-46-jirislaby@kernel.org> In-Reply-To: <20240118075756.10541-1-jirislaby@kernel.org> References: <20240118075756.10541-1-jirislaby@kernel.org> Precedence: bulk MIME-Version: 1.0 Content-Transfer-Encoding: 8bit
Series	tty: vt: cleanup and documentation \| expand [00/45] tty: vt: cleanup and documentation [01/45] vgacon: inline vc_scrolldelta_helper() into vgacon_scrolldelta() [02/45] fbcon: make display_desc a static array in fbcon_startup() [03/45] tty: vt: fix 20 vs 0x20 typo in EScsiignore [04/45] tty: vt: expect valid vc when in tty ops [05/45] tty: vt: pass proper pointers from tioclinux() [06/45] tty: vt: push console lock from tioclinux() down to 2 functions [07/45] tty: vt: pass vc_resize_user as a parameter [08/45] tty: vt: make vc_is_sel()'s vc const [09/45] tty: vt: define an enum for CSI+m codes [10/45] tty: vt: use case ranges for CSI+m fg/bg colors [11/45] tty: vt: define an enum for CSI+J codes [12/45] tty: vt: reflow csi_J() [13/45] tty: vt: define an enum for CSI+K codes [14/45] tty: vt: reflow csi_K() [15/45] tty: vt: pass vpar as unsigned to csi_J() and csi_K() [16/45] tty: vt: define an enum for ascii characters [17/45] tty: vt: remove extern from functions in selection.h [18/45] tty: vt: make consw::con_debug_() return void [19/45] tty: vt: make init parameter of consw::con_init() a bool [20/45] tty: vt: sanitize arguments of consw::con_clear() [21/45] tty: vt: remove checks for count in consw::con_clear() implementations [22/45] tty: vt: add con_putc() helper [23/45] tty: vt: eliminate unneeded consw::con_putc() implementations [24/45] tty: vt: sanitize consw::con_putc() parameters [25/45] tty: vt: sanitize consw::con_putcs() parameters [26/45] consoles: use if instead of switch-case in consw::con_cursor() [27/45] fbdev/core: simplify cursor_state setting in fbcon_ops::cursor() [28/45] tty: vt: remove CM_ constants [29/45] tty: vt: make consw::con_switch() return a bool [30/45] tty: vt: stop using -1 for blank mode in consw::con_blank() [31/45] tty: vt: use VESA blanking constants [32/45] tty: vt: use enum for VESA blanking modes [33/45] tty: vt: make types around consw::con_blank() bool [34/45] tty: vt: make font of consw::con_font_set() const [35/45] tty: vt: make consw::con_font_default()'s name const [36/45] tty: vt: change consw::con_set_origin() return type [37/45] fbcon: remove consw::con_screen_pos() [38/45] tty: vt: remove consw::con_screen_pos() [39/45] tty: vt: make types of screenpos() more consistent [40/45] fbcon: remove fbcon_getxy() [41/45] tty: vt: remove consw::con_getxy() [42/45] tty: vt: remove unused consw::con_flush_scrollback() [43/45] tty: vt: document the rest of struct consw [44/45] tty: vt: fix up kernel-doc [45/45] Documentation: add console.rst

Message ID

20240118075756.10541-46-jirislaby@kernel.org

State

Superseded

Headers

From: "Jiri Slaby (SUSE)" <jirislaby@kernel.org>
To: gregkh@linuxfoundation.org
Cc: linux-serial@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	"Jiri Slaby (SUSE)" <jirislaby@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: [PATCH 45/45] Documentation: add console.rst
Date: Thu, 18 Jan 2024 08:57:56 +0100
Message-ID: <20240118075756.10541-46-jirislaby@kernel.org>
In-Reply-To: <20240118075756.10541-1-jirislaby@kernel.org>
References: <20240118075756.10541-1-jirislaby@kernel.org>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

Series

tty: vt: cleanup and documentation | expand

Commit Message

Jiri Slaby Jan. 18, 2024, 7:57 a.m. UTC

Now, that the console kernel-doc is in better shape, include it in the
tty/ docs.

It's not supernice, but it is what it is. At least for the beginning.

Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
 Documentation/driver-api/tty/console.rst | 45 ++++++++++++++++++++++++
 Documentation/driver-api/tty/index.rst   |  1 +
 2 files changed, 46 insertions(+)
 create mode 100644 Documentation/driver-api/tty/console.rst

diff --git a/Documentation/driver-api/tty/console.rst b/Documentation/driver-api/tty/console.rst
new file mode 100644
index 000000000000..4348e36cd33b
--- /dev/null
+++ b/Documentation/driver-api/tty/console.rst
@@ -0,0 +1,45 @@ 
+.. SPDX-License-Identifier: GPL-2.0
+
+=======
+Console
+=======
+
+.. contents:: :local:
+
+Struct Console
+==============
+
+.. kernel-doc:: include/linux/console.h
+   :identifiers: console cons_flags
+
+Internals
+---------
+
+.. kernel-doc:: include/linux/console.h
+   :identifiers: nbcon_state nbcon_prio nbcon_context nbcon_write_context
+
+Struct Consw
+============
+
+.. kernel-doc:: include/linux/console.h
+   :identifiers: consw
+
+Console functions
+=================
+
+.. kernel-doc:: include/linux/console.h
+   :identifiers: console_srcu_read_flags console_srcu_write_flags
+        console_is_registered for_each_console_srcu for_each_console
+
+.. kernel-doc:: drivers/tty/vt/selection.c
+   :export:
+.. kernel-doc:: drivers/tty/vt/vt.c
+   :export:
+
+Internals
+---------
+
+.. kernel-doc:: drivers/tty/vt/selection.c
+   :internal:
+.. kernel-doc:: drivers/tty/vt/vt.c
+   :internal:
diff --git a/Documentation/driver-api/tty/index.rst b/Documentation/driver-api/tty/index.rst
index b490da11f257..c1ffe3d1ec46 100644
--- a/Documentation/driver-api/tty/index.rst
+++ b/Documentation/driver-api/tty/index.rst
@@ -38,6 +38,7 @@  In-detail description of the named TTY structures is in separate documents:
    tty_buffer
    tty_ioctl
    tty_internals
+   console
 
 Writing TTY Driver
 ==================

[45/45] Documentation: add console.rst

Commit Message

Patch