From patchwork Thu Sep 11 21:44:13 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 294 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=1757627114; bh=TnYfBX+7vHCe8r6M2rqZhPY5s2TJi+mZiTEh0seVOCQ=; 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=eMLpQOP2lqMuRdQ7sKJyo3x9LCpzdCz/IYV2u79kx98HT7x1SsFDrRwIQVZAGTveV ukMg1arpgmLOGYB5DChTvgy2okY0p0sVYHZYLEF2VTYQxXY9LzmT8OT2+Ek/Suz9s8 eDqWSsDknhQa2bjlm1NCgvcFvtSxikqWX4yUMWRXFD98PgvulKGqzE19RlbjjGIsni voCiwVRQ7Gh98JHIuKWky9qc2SaJPV/wBaJZMuSU6vXsLCe0RNYzOjIXktulhOB8Tc SZTIDYB+cu02ftBNYLeUvowrfBaymtiiK/3NYIXCud0xJQJhW4PG4zK01Rh6OBU32H SnLUqaMZ8fxQQ== Received: from localhost (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id 6600A67B0E for ; Thu, 11 Sep 2025 15:45:14 -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 yDazA1R0puYh for ; Thu, 11 Sep 2025 15:45:14 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1757627114; bh=TnYfBX+7vHCe8r6M2rqZhPY5s2TJi+mZiTEh0seVOCQ=; 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=eMLpQOP2lqMuRdQ7sKJyo3x9LCpzdCz/IYV2u79kx98HT7x1SsFDrRwIQVZAGTveV ukMg1arpgmLOGYB5DChTvgy2okY0p0sVYHZYLEF2VTYQxXY9LzmT8OT2+Ek/Suz9s8 eDqWSsDknhQa2bjlm1NCgvcFvtSxikqWX4yUMWRXFD98PgvulKGqzE19RlbjjGIsni voCiwVRQ7Gh98JHIuKWky9qc2SaJPV/wBaJZMuSU6vXsLCe0RNYzOjIXktulhOB8Tc SZTIDYB+cu02ftBNYLeUvowrfBaymtiiK/3NYIXCud0xJQJhW4PG4zK01Rh6OBU32H SnLUqaMZ8fxQQ== Received: from mail.u-boot.org (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id 556D167B06 for ; Thu, 11 Sep 2025 15:45:14 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1757627111; bh=YwF76ohU43KtVBkbyJBBQfQGeGQSXZ/qz79HPIGOW0k=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=QZlewZXeERrU2FyJ2xihR0bOhTQe/TCZypk4bBwUCaermgqfjVtE8+FAfTs0ap7zY diurlz/iCBt/KsCkGChOl1/eXZhKD/3Qq+P/520KgS11+KDTXbhwkaL55QYdP47j6c lmSAXrmU3qm47lVdQuHWrXJiEl8mNmagbn+Gmqgh2PysUdQIUQTajGXlqQxxAwTX2i wfjDzW1KQ9hqsPrFQUVkiO0L8S5b1tyH7ThypAziogdRubJwZonTFAhSYryO/tYWVE YijUUoWqHz9P4TfqNJpWPgTiQjo/8qU9vzhE4PK1yQ8cYA5fT2sNrOTV1hej+Klsfk 6ElArA1Ww1m7w== Received: from localhost (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id E42CC67B0F; Thu, 11 Sep 2025 15:45:11 -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 I3p6i6gcHZi7; Thu, 11 Sep 2025 15:45:11 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1757627108; bh=937r0L67A9NapoL465KzG6CSoMCG47lNNfeUpqCesRI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=uPp52I7rrRXS3vIA1CnMY6Ghgj7QiqwMEqPns/VLNzk2Sjipdkb6A5lYpYVbYKkPE C5klrpDPzgnXJtW94C251Ojz7bF4F6Qja5EKtuE3lTHhHn80OPdcw4k/zienuu+0Zm wg5GBL+jq7uYSlaKeLnECkf+TKwq4jS+RmtGv34IcqTBXZksf7Dtkpk1KklXqqZkTA TBxq02gB8Ef8L++SbvqE9AmKso/OQaZfaAsHpjK0wMOqE7mW38D/hQnkwYCCZGx2D5 B8JSn2DXq71YnYRXul7t52g6TrZEI3AxG7OCT6ZJQ2nnGRajahfwxe1XKjJVfnGkyd roU9bxy2vKZVA== Received: from u-boot.org (unknown [73.34.74.121]) by mail.u-boot.org (Postfix) with ESMTPSA id 8EE6367A59; Thu, 11 Sep 2025 15:45:08 -0600 (MDT) From: Simon Glass To: U-Boot Concept Date: Thu, 11 Sep 2025 15:44:13 -0600 Message-ID: <20250911214425.3687188-10-sjg@u-boot.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250911214425.3687188-1-sjg@u-boot.org> References: <20250911214425.3687188-1-sjg@u-boot.org> MIME-Version: 1.0 Message-ID-Hash: WHNUJ6VHS5XNDAHYWOBK5VVVUL5OLQFX X-Message-ID-Hash: WHNUJ6VHS5XNDAHYWOBK5VVVUL5OLQFX 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 09/14] doc: Fix a few nits in the ulib docs 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 TIdy up a few minor typos and grammar errors. Signed-off-by: Simon Glass --- doc/develop/ulib.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/develop/ulib.rst b/doc/develop/ulib.rst index d68ffcaa964..ccef5f36e3c 100644 --- a/doc/develop/ulib.rst +++ b/doc/develop/ulib.rst @@ -6,7 +6,7 @@ U-Boot Library (ulib) The U-Boot Library (ulib) allows U-Boot to be built as a shared or static library that can be used by external programs. This enables reuse of U-Boot functionality in test programs and other applications without needing to -build that functionality directly into U-Boot image. +build that functionality directly into a U-Boot image. Please read `License Implications`_ below. @@ -94,7 +94,7 @@ This is possible using the provided examples as a template. The ``examples/ulib` directory contains a standalone Makefile that can build programs against a pre-built U-Boot library. -The examples works as expected, but note that as soon as you want to call +The examples work as expected, but note that as soon as you want to call functions that are not in the main API headers, you may have problems with missing dependencies and header files. See below. @@ -104,11 +104,11 @@ Including U-Boot header files from outside ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ U-Boot has many header files, some of which are arch-specific. These are -typically including via:: +typically included via:: #include -and are located in the ```arch//include/asm/...`` directory within the +and are located in the ``arch//include/asm/...`` directory within the U-Boot source tree. You will need to ensure that this directory is present in the include path. @@ -204,7 +204,7 @@ out of memory or simple crashes during library init. Dependencies ------------ -When linking with the U-Boot library for sanbod, you may need these system +When linking with the U-Boot library for sandbox, you may need these system libraries: * ``pthread`` - POSIX threads @@ -341,7 +341,7 @@ The format rules are: * Lines starting with ``file:`` specify a header file * Indented lines (space or tab) define symbols from that header -* Use ``symbol=new_name`` for custom renaming, otherwise ``ub_`` a prefix is +* Use ``symbol=new_name`` for custom renaming, otherwise a ``ub_`` prefix is added by default. No space around ``=`` * Use ``#`` at the beginning of a line for a comment * Empty lines are allowed