From patchwork Mon Aug 25 16:27:18 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 136 Return-Path: X-Original-To: u-boot-concept@u-boot.org Delivered-To: u-boot-concept@u-boot.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1756139282; bh=0VXXA3ynHAbVrJBnk98DMhpqn/MUWpVuQZGx7/rQkVw=; h=From:To:Date:In-Reply-To:References:CC:Subject:List-Id: List-Archive:List-Help:List-Owner:List-Post:List-Subscribe: List-Unsubscribe:From; b=W8DtFaICvySBxKu04BN3bISmmz2oGjz/CwaO2UF2l8/cNsBvgPgAhwwcVAfqnHRer 0gKhA/+VYPoQR0byND/U6+Zzg5thCQpuGbiIx1ZXLZCcHd5QTHVtTjrpUNs4zlpknn APOIhTL5Lj2qK5WhnUxB+t/3tSkQkh4tv8cpYstbgQoKQ+STOsmDm6gGbdWpdSjvVf C8DsP0p4aUrtMIa6dbl0x+HMII9NmNDcQmkR9gbFE17oiJD1bKsk8iRJb6DftUgczq w+lcl++vVx8jtFmkGTMxSHQMNoQJRgq2nl2aa+kydTXVsNs73lZiHitaSZEgqJHEOs VBfhrMOGYBxtg== Received: from localhost (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id A0E5167706 for ; Mon, 25 Aug 2025 10:28:02 -0600 (MDT) X-Virus-Scanned: Debian amavis at Received: from mail.u-boot.org ([127.0.0.1]) by localhost (mail.u-boot.org [127.0.0.1]) (amavis, port 10024) with ESMTP id Gn77z5eUWmqT for ; Mon, 25 Aug 2025 10:28:02 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1756139281; bh=0VXXA3ynHAbVrJBnk98DMhpqn/MUWpVuQZGx7/rQkVw=; h=From:To:Date:In-Reply-To:References:CC:Subject:List-Id: List-Archive:List-Help:List-Owner:List-Post:List-Subscribe: List-Unsubscribe:From; b=r6DRziry0XyCCwhPYqLhuBdgotQKIcYOGQ+iww/+COF70rsTeiA38bWSM3d7xPSbN N67o2EyP7zLPK9KNI16m7EWrS873Z4JGM5xkn1WD82S3T82DOfvro4D5/2uHcpJ4GS iwHyqECHUtNuIGFEjoPRuJFW7e2SlwVQPU9XOxElKs7kds6tni+FRvwwHtk7QFbnxl ssJGi2TmFrF7CoewzTBYH7KPRMcAeQuhMy3GkEWHYhV5CuUsGjKn4Ulry76LyPWlhm ptx35E4Ok24+OinXSA+G3oG3zzKy+2rPBnI0Qx109zlGFQv1HvJ5fohWF3MKzJ29b+ mx+fWKn5TcBeA== Received: from mail.u-boot.org (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id 58AF06779C for ; Mon, 25 Aug 2025 10:28:01 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1756139279; bh=L5rCqxColhOY5vVxpbnWU5w7UObZ0ZJqJhjK1zaeqmk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=W8qoCe2ogeqNkZrXGjMUmhIcTkBQH6WpcIyt6krXO6MXmEWTfFmj/f1oLYUNUqueP 18wmvMp4u7imdFLRS0NLrPCavWEDGgA6EMfrQ8ftv5monFDdQ7OFgojcinKpRLVJKB LW77H4IbVFvgqfCHnmEE2135AjuuslLGVX5gm7+wg3UUA/6nGSFyeAKyjpGmdShB6W uZMNIuYPbfS2ob5Ow1yWscKYlZvPvisgL/81fFCsO48ExhEmL//s3i8tzLN7sO6Xik 91bMBz9BBKh/76G66XJb+jkcjIySVpDQyAGnYpM3gXs3BDRfsba0NubXoJs+tveCxL LqyuNb3Eql+hA== Received: from localhost (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id D29566779C; Mon, 25 Aug 2025 10:27:59 -0600 (MDT) X-Virus-Scanned: Debian amavis at Received: from mail.u-boot.org ([127.0.0.1]) by localhost (mail.u-boot.org [127.0.0.1]) (amavis, port 10026) with ESMTP id mLTG4m8Jfi26; Mon, 25 Aug 2025 10:27:59 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1756139275; bh=+n9d58T2je91PQQW1jAacu/6gIdRhzhWH7TQcASHGFs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=r6Q4IcFPSdJlf2gtPte7q7xMviwxi6HCMeNL+O9h3tDLpriIp5IvF/Da8ye5+Wau9 2jQR2dNc8Cjjb3lNpPlXmYVqS8XrFc6vYiqNOEV6djcE6/4gSU6YzPc+lujOMkyZfP xX9gZcl2nLPJCdcLlq6Kmg+E5Rtsne2dxbOG/ONDfQYZzdkRGqGSnSjCgZXq7ZTZ6p mA+spd9xGZBaNaXBTM/I17jRvRwCLoQ5Sa63vDczVkQ934LoqUjzmRiBNULiuFitZd iVO5Tw0ALKOSCSTokv7evhsPHoLpRV7jGkDRLTSXXYuZLo3aPfEtWBLyWxa35dV5ng ou4mCoco+jJGg== Received: from u-boot.org (unknown [73.34.74.121]) by mail.u-boot.org (Postfix) with ESMTPSA id A0CD56779F; Mon, 25 Aug 2025 10:27:55 -0600 (MDT) From: Simon Glass To: U-Boot Concept Date: Mon, 25 Aug 2025 10:27:18 -0600 Message-ID: <20250825162727.3185381-16-sjg@u-boot.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250825162727.3185381-1-sjg@u-boot.org> References: <20250825162727.3185381-1-sjg@u-boot.org> MIME-Version: 1.0 Message-ID-Hash: BWPDHU3L2E6BAF7ZXAFYT45B4H4KX3KE X-Message-ID-Hash: BWPDHU3L2E6BAF7ZXAFYT45B4H4KX3KE X-MailFrom: sjg@u-boot.org X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Heinrich Schuchardt , Simon Glass X-Mailman-Version: 3.3.10 Precedence: list Subject: [Concept] [PATCH v2 15/16] doc: Move console docs to rST List-Id: Discussion and patches related to U-Boot Concept Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Simon Glass Move the console readme into the main documentation, with as few changes as possible. Signed-off-by: Simon Glass --- (no changes since v1) 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 --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