From patchwork Thu Jul 18 07:33:46 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bin Meng X-Patchwork-Id: 1133566 X-Patchwork-Delegate: trini@ti.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=lists.denx.de (client-ip=81.169.180.215; helo=lists.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="KfZ/KinY"; dkim-atps=neutral Received: from lists.denx.de (dione.denx.de [81.169.180.215]) by ozlabs.org (Postfix) with ESMTP id 45q5YV4tZZz9s00 for ; Thu, 18 Jul 2019 17:36:46 +1000 (AEST) Received: by lists.denx.de (Postfix, from userid 105) id 62A5CC22003; Thu, 18 Jul 2019 07:35:46 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on lists.denx.de X-Spam-Level: X-Spam-Status: No, score=-0.0 required=5.0 tests=FREEMAIL_FROM, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, T_DKIM_INVALID autolearn=unavailable autolearn_force=no version=3.4.0 Received: from lists.denx.de (localhost [IPv6:::1]) by lists.denx.de (Postfix) with ESMTP id 41CEDC21F5B; Thu, 18 Jul 2019 07:34:55 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id 41472C21F0F; Thu, 18 Jul 2019 07:34:52 +0000 (UTC) Received: from mail-pf1-f180.google.com (mail-pf1-f180.google.com [209.85.210.180]) by lists.denx.de (Postfix) with ESMTPS id A2777C21F19 for ; Thu, 18 Jul 2019 07:34:48 +0000 (UTC) Received: by mail-pf1-f180.google.com with SMTP id r7so12197084pfl.3 for ; Thu, 18 Jul 2019 00:34:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id:in-reply-to:references; bh=sANcIjqeaDG+73P6w+nxOvu5Sl/97kdF3s3jocOhuuU=; b=KfZ/KinYslIjiToTQEHqTRXbd2Tohu1BjVKFavUyVXM89zKwf2mjIsiVmMTNsFZX8s /I0AKA7so6Axxj8CP59CgJQeqaQj7A3D6Er7SKG+YWjNSk8qmg/0bunFFaBKIJ1PTVzb dzg8EAsjInU/0/5KSTg4uZ9YkSIyGsx7AeppkJte1MqgnLNrMR0ZjuFMqHbE2GWJNcDC zR0PVKonZCm9LECW57+hdeWYetxci3Hdm5kO1CcrvjgPjUa0GNYN9uac8tK0I+Mxv5A/ 6eIOT5zRWeUCbsqcVjW0L0XqTK6lWZG/HQwkk2EuaFHDbCDX8crYD0bYLzaVGiqDBzFM 81Ng== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=sANcIjqeaDG+73P6w+nxOvu5Sl/97kdF3s3jocOhuuU=; b=CNfiym4pKbpIsR1O8kx6pYOZU5TasNIwrQE138poHztJAQJw51APdJQ0uB9Ah7Asg6 yUEX4GW5DrUIPBsyOQvr9PYRx3pXCDR/QZFxh2oaIlaTBbcRhSNpcpbVos7g5Kj7cvhG f/uspxzZ0vhcrKGIcFxSmQRuZ4yEJj9EKGkv+Vs2UFbcwHrF6uM3Nqswd9oAS0kW4r3/ UxmzCi/lZx9WD4FMpwA1rr/PJXEJ4B+K9UrHjqXF2NUFyzDHyVuvNdEjzEGHkxuRfPEf EdJ5GN5L7ZDJL7y7e61jzt0kSsFvrdkpDJiwhoabeVegX0xi12fNHqJz2r2GtA+VZ0sS qdDw== X-Gm-Message-State: APjAAAUsLBDHkjFC3eWibkOaOhb/8QmoPMki0wynJf3fqqr77YOdLnqa TvhiJZyp8235FCbThIXzUXo= X-Google-Smtp-Source: APXvYqxffk1RipHlYWYbVM92anZJIVgie+1KKQRc5a12NEZJwZRb4ghyXHNrgQQCFhV6ju1nw0ty0Q== X-Received: by 2002:a17:90a:db42:: with SMTP id u2mr49632024pjx.48.1563435282684; Thu, 18 Jul 2019 00:34:42 -0700 (PDT) Received: from localhost.localdomain (unknown-224-80.windriver.com. [147.11.224.80]) by smtp.gmail.com with ESMTPSA id q1sm39859821pfn.178.2019.07.18.00.34.41 (version=TLS1 cipher=AES128-SHA bits=128/128); Thu, 18 Jul 2019 00:34:42 -0700 (PDT) From: Bin Meng To: Tom Rini , Simon Glass , Wolfgang Denk , Heinrich Schuchardt , Mario Six , U-Boot Mailing List Date: Thu, 18 Jul 2019 00:33:46 -0700 Message-Id: <1563435275-22326-2-git-send-email-bmeng.cn@gmail.com> X-Mailer: git-send-email 1.7.1 In-Reply-To: <1563435275-22326-1-git-send-email-bmeng.cn@gmail.com> References: <1563435275-22326-1-git-send-email-bmeng.cn@gmail.com> Subject: [U-Boot] [PATCH 01/50] doc: Move existing rst files into api sub-directory X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.18 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng Reviewed-by: Heinrich Schuchardt --- doc/{ => api}/efi.rst | 0 doc/api/index.rst | 11 +++++++++++ doc/{ => api}/linker_lists.rst | 0 doc/{ => api}/serial.rst | 0 doc/index.rst | 14 +++++++++++--- 5 files changed, 22 insertions(+), 3 deletions(-) rename doc/{ => api}/efi.rst (100%) create mode 100644 doc/api/index.rst rename doc/{ => api}/linker_lists.rst (100%) rename doc/{ => api}/serial.rst (100%) diff --git a/doc/efi.rst b/doc/api/efi.rst similarity index 100% rename from doc/efi.rst rename to doc/api/efi.rst diff --git a/doc/api/index.rst b/doc/api/index.rst new file mode 100644 index 0000000..d484c06 --- /dev/null +++ b/doc/api/index.rst @@ -0,0 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +U-Boot API documentation +======================== + +.. toctree:: + :maxdepth: 2 + + efi + linker_lists + serial diff --git a/doc/linker_lists.rst b/doc/api/linker_lists.rst similarity index 100% rename from doc/linker_lists.rst rename to doc/api/linker_lists.rst diff --git a/doc/serial.rst b/doc/api/serial.rst similarity index 100% rename from doc/serial.rst rename to doc/api/serial.rst diff --git a/doc/index.rst b/doc/index.rst index 0353c10..1946d09 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,8 +4,16 @@ U-Boot Developer Manual ####################### +U-Boot API documentation +------------------------ + +These books get into the details of how specific U-Boot subsystems work +from the point of view of a U-Boot developer. Much of the information here +is taken directly from the U-Boot source, with supplemental material added +as needed (or at least as we managed to add it - probably *not* all that is +needed). + .. toctree:: + :maxdepth: 2 - efi - linker_lists - serial + api/index