diff mbox series

[Concept,14/16] doc: Move console docs to rST

Message ID	20250822142153.3404275-15-sjg@u-boot.org
State	New
Headers	From: Simon Glass <sjg@u-boot.org> To: U-Boot Concept <concept@u-boot.org> Date: Fri, 22 Aug 2025 08:21:45 -0600 Message-ID: <20250822142153.3404275-15-sjg@u-boot.org> In-Reply-To: <20250822142153.3404275-1-sjg@u-boot.org> References: <20250822142153.3404275-1-sjg@u-boot.org> MIME-Version: 1.0 Message-ID-Hash: ZBHDQ5KBKVSQBFFR563XRQ5OPMMY6F3H CC: Simon Glass <sjg@chromium.org> Precedence: list Subject: [Concept] [PATCH 14/16] doc: Move console docs to rST Archived-At: <https://lists.u-boot.org/archives/list/concept@u-boot.org/message/ZBHDQ5KBKVSQBFFR563XRQ5OPMMY6F3H/> Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit
Series	Introduce a pager for the console \| [Concept,00/16] Introduce a pager for the console [Concept,01/16] console: Add the basic pager implementation [Concept,02/16] console: Add tests for the basic functionality [Concept,03/16] console: Provide a way to output without the pager [Concept,04/16] console: Rename console-put functions to prepare for pager [Concept,05/16] console: Plumb in the pager [Concept,06/16] console: test: Allow tests to bypass the pager [Concept,07/16] console: Support paging with single characters [Concept,08/16] console: Add a few more paging tests [Concept,09/16] console: Reset the pager when entering a new command [Concept,10/16] console: Implement an environment var to control the pager [Concept,11/16] console: Get the pager lines from the vidconsole [Concept,12/16] efi: Enable the console pager for the app [Concept,13/16] doc: Remove obsolete text in README.console [Concept,14/16] doc: Move console docs to rST [Concept,15/16] doc: Tidy up the console docs a little [Concept,16/16] pager: doc: Add mention of the pager feature

Commit Message

Simon Glass Aug. 22, 2025, 2:21 p.m. UTC

  From: Simon Glass <sjg@chromium.org>

Move the console readme into the main documentation, with as few changes
as possible.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 doc/{README.console => usage/console.rst} | 13 ++++++-------
 doc/usage/index.rst                       |  1 +
 2 files changed, 7 insertions(+), 7 deletions(-)
 rename doc/{README.console => usage/console.rst} (87%)

diff mbox series

Patch

diff --git a/doc/README.console b/doc/usage/console.rst
similarity index 87%
rename from doc/README.console
rename to doc/usage/console.rst
index debef45760d..f624cc58038 100644
--- a/doc/README.console
+++ b/doc/usage/console.rst
@@ -1,11 +1,10 @@ 
-SPDX-License-Identifier: GPL-2.0+
-/*
- * (C) Copyright 2000
- * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
- */
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
+..  (C) Copyright 2000
 
+=======================
 U-Boot console handling
-========================
+=======================
 
 HOW THE CONSOLE WORKS?
 ----------------------
@@ -57,4 +56,4 @@  You can use the following functions to access the console:
     fgetc	(like getc but redirected to a file)
 
 Remember that all FILE-related functions CANNOT be used before
-U-Boot relocation (done in 'board_init_r' in arch/*/lib/board.c).
+U-Boot relocation (done in 'board_init_r' in `arch/*/lib/board.c`).
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 20465b8bff6..585aa3f9784 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -6,6 +6,7 @@  Use U-Boot
 
    spl_boot
    blkmap
+   console
    dfu
    environment
    fdt_overlays