From patchwork Fri Aug 22 14:21:45 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 118 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=1755872563; bh=zzxakl72BWRYUNLYShMwuh+iB9M380nsZqqmxDq2lMQ=; 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=KnEFxfTb8RWKKIhv39J5qaa4z9fk/vrm5WT01dBSsvJwH94oVhpcFXm1M5wtSk93m pzIbHTqFgsJaE/OnHI//IMeKaqUT8i64x9/E9Otm1y3nABiJD73tjSrFst51duA+Sf nNymV1cUOksWyDzwXDiBUZ+QRkdzCdTRmGxynj8QHesVs6v5f48scNYKP5qxn/Gllw Kqv1bSftebYyjoWkPVAIIQxslsSdMsRHtKrMCOlMQ+4S1mg9XtFl9oKkBLZQFVl6ne UFAxUqtm/ue0XYiiBgpkC2UJrLAPvYGlG2Rq8jtB+Zue4OekddIQXHReOs+M7XrT5/ fcVsyjBRo6QrA== Received: from localhost (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id 4CA1967726 for ; Fri, 22 Aug 2025 08:22:43 -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 2Qzo50k4Lri7 for ; Fri, 22 Aug 2025 08:22:43 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1755872561; bh=zzxakl72BWRYUNLYShMwuh+iB9M380nsZqqmxDq2lMQ=; 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=db9W9Rw3GBvendpf9UuSD15k2wd0WNOtaEGjwRT2mgVgsEETOL4D6RMSZBWlpukQq LGcSqvGyB5AtZV6sn+0CHv4Sli+83DanjNrsyV9RjfAD9NuCDwXvjAIb2rspoxRWYg 76hPk+ga23emmWKUvm7DWB+ILhnI+p0oNQxHVLBgEmzDcezmqT3/wD0ApF44Fcb2bZ mPnX7/cvEavuFCfHBRh/nkDfnKlLwis8SLR4+dEB7l2V57sgp/PHqYlKRK7k9WmpKG UaMkkbvwg9ucicu8dBXGIpx/h3V53EmOFWp891q0ZCaXezllrdw5RYBHPtQJA6EZUU OJeuGR43LArkg== Received: from mail.u-boot.org (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id AC8E7674C7 for ; Fri, 22 Aug 2025 08:22:41 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1755872558; bh=gD0Hg05UD6zPPnz9tQBeNsYzWZ3lqqFJXYI00r8NoNc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=SYUIea7AiTYwLG1Mzv++MSqqW5tYG87QUwJAJR3FM1KQeQl7XYSEI+i7i8C5hAxAn bYQDyLB4UxyBmL/zpgfXnOCPq7kSPnnpfhoXQMBTr4Z066Kurydv/USaSglwzL8YlN AkLEu8lz3piYzjthQ5xE+Sm7r4y24uh/1DtGa3zyxtwDS8nyGFFSqzwO1VpWSnfsI5 30JWc/g3WROfQkrrJ47nPB7if+GDWnyaS2lioOl7XyxQ0jb+cx81KAhdqmx3G30TEL yAa2Q/3xmQf7e+PADV/gdOlJHKkqf5/hcpsBo2Y9P4KRw3TPY3YpJpmeODSDj9pFOb pC+kxTjbWaQew== Received: from localhost (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id D2D895E45E; Fri, 22 Aug 2025 08:22:38 -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 JgMJC15LWdJf; Fri, 22 Aug 2025 08:22:38 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1755872551; bh=QLf/hCVLcGhCKh4y1fyfqlncy6qhK/9/DdWPzniE9nM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=SpBuEBgaA87OkG//c3XZVASK2X567bi3x3DQr6gydiI1Hp/dZ6rH8wAarIVNrInR4 31R+5+sdqYndovjFOl6+mwYytuALTJkDqM2ipubLVFVDLAr6OFRKCnb8dw1cP/3vWD jisPNbJ+YLHR8FtxAlGgJBnDXN+TeIMqPuHZFR93LY+NqhpLecH5C2sBGZzehburNu fr0giiwUW8SG4JEJnTPsFJTAxVqHiQekNMEjG0G6jDpOjyfZjNIHP8pyo6ymAHru+e 4pa3m37sEdCNOtLJLbCkKZuymLmZOxx4R5LhrqVBav6baIaSh3iY3tzhiRez+6p2wq bRBDF3HHlm0GA== Received: from u-boot.org (unknown [73.34.74.121]) by mail.u-boot.org (Postfix) with ESMTPSA id B379D6771D; Fri, 22 Aug 2025 08:22:31 -0600 (MDT) From: Simon Glass To: U-Boot Concept Date: Fri, 22 Aug 2025 08:21:45 -0600 Message-ID: <20250822142153.3404275-15-sjg@u-boot.org> X-Mailer: git-send-email 2.43.0 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 X-Message-ID-Hash: ZBHDQ5KBKVSQBFFR563XRQ5OPMMY6F3H 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: Simon Glass X-Mailman-Version: 3.3.10 Precedence: list Subject: [Concept] [PATCH 14/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 --- 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