From patchwork Tue Jul 16 16:42:47 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bin Meng X-Patchwork-Id: 1132867 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="YWTgahi1"; dkim-atps=neutral Received: from lists.denx.de (dione.denx.de [81.169.180.215]) by ozlabs.org (Postfix) with ESMTP id 45p5rB5PWKz9sN4 for ; Wed, 17 Jul 2019 02:46:02 +1000 (AEST) Received: by lists.denx.de (Postfix, from userid 105) id 6B66FC21E50; Tue, 16 Jul 2019 16:43:33 +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, 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 96AA2C21EE0; Tue, 16 Jul 2019 16:43:14 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id 45749C21E42; Tue, 16 Jul 2019 16:43:07 +0000 (UTC) Received: from mail-pg1-f195.google.com (mail-pg1-f195.google.com [209.85.215.195]) by lists.denx.de (Postfix) with ESMTPS id 3AB2FC21E49 for ; Tue, 16 Jul 2019 16:43:04 +0000 (UTC) Received: by mail-pg1-f195.google.com with SMTP id n9so3493428pgc.1 for ; Tue, 16 Jul 2019 09:43:04 -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=Q+NMgnyUAfg4puVNP8Hjcc8kDJbJtDvTiIVRgetzF8I=; b=YWTgahi16rmmLOnfGXTTFeDDb3DOFLIuOULvxINnOGScVK8bWzSrINFAkTGa9AmwTR lcnwe8ULzlV0voi8ncUZ7fE5m/NnOq9b0Nkf9prDEezgrJ8zeA1zicusAafnEPJQhTFS jo7Zyu7t7Oq14LUqk+/i/Nz2ZXSbY8A+VVN8KwA0W+nQpokcqLjngGHC8oErgcbiezFK Ksusx3MmTifKyZiFBfvR+P3/e8sONH1u3lc8bACTQOFJsU2ozVTAElR9hn+Scw9T5v/w msqXZiwyoiE6yUjUU5nNRsHg4Qfw+tT80VB33AGmS5QhDZ+d609R0/I+cSEF21/cHkBe JyxA== 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=Q+NMgnyUAfg4puVNP8Hjcc8kDJbJtDvTiIVRgetzF8I=; b=ukXo+kpFLhayicDbl24xF7Es5XvkXOT90Jvr6GEWpEgCM8rlSc7kvnm4W7sw5MjFZD XMVd6tacpCJkDmmSvvZznzUhr7Giqn5zZww9jSh1+SvhIi4LNlM9MXbZZv4yJKXjnU3s eJLI/t4c85ZPaHTQW/tSBY5MCYgtD1q9GhmYYkrlmOhknaRu53MAAsSkg0JyIi7iFyzU mbBKJi67f67tKnScd5uONjBAYVR1pjUtrxss3GD8F3kyx5jbvgwt3/Tj9MrUENQ+5fSi RJgsiuLNBQa5CYv7ZYi1x+2pA1Kz/a+GJO74FAtObU7PekqG9Z1XM63+E9QbGPXeiwGz Eq3Q== X-Gm-Message-State: APjAAAWStTTt9jTbV4GW8X1NX4UA3LgLVl0Fgw22y5Vkqpd0/Iza5kb/ FxVFD+YY33okhVWiHW6YqWU= X-Google-Smtp-Source: APXvYqwJcY74W/rrpMQLO0EvNnZK++9tc0sAWp0NCujmSYxq5o52exqWBYaiRJRREi4BsMk7o1DIUw== X-Received: by 2002:a63:7e1d:: with SMTP id z29mr35080191pgc.346.1563295382846; Tue, 16 Jul 2019 09:43:02 -0700 (PDT) Received: from localhost.localdomain (unknown-224-80.windriver.com. [147.11.224.80]) by smtp.gmail.com with ESMTPSA id h12sm26017441pje.12.2019.07.16.09.43.01 (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 16 Jul 2019 09:43:02 -0700 (PDT) From: Bin Meng To: Tom Rini , Simon Glass , Wolfgang Denk , Heinrich Schuchardt , Mario Six , U-Boot Mailing List Date: Tue, 16 Jul 2019 09:42:47 -0700 Message-Id: <1563295374-1504-3-git-send-email-bmeng.cn@gmail.com> X-Mailer: git-send-email 1.7.1 In-Reply-To: <1563295374-1504-1-git-send-email-bmeng.cn@gmail.com> References: <1563295374-1504-1-git-send-email-bmeng.cn@gmail.com> Subject: [U-Boot] [RFC PATCH 2/9] doc: Add top-level description about U-Boot documentation 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" This updates the index.rst to add top-level description about U-Boot documentation. Words are taken from Linux kernel docs and modified for U-Boot. Signed-off-by: Bin Meng --- doc/index.rst | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 1946d09..cfcf1dd 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,8 +1,19 @@ .. SPDX-License-Identifier: GPL-2.0+ -####################### -U-Boot Developer Manual -####################### +.. _u-boot_doc: + +The U-Boot documentation +======================== + +This is the top level of the U-Boot's documentation tree. U-Boot +documentation, like the U-Boot itself, is very much a work in progress; +that is especially true as we work to integrate our many scattered +documents into a coherent whole. Please note that improvements to the +documentation are welcome; join the U-Boot list at http://lists.denx.de +if you want to help out. + +.. toctree:: + :maxdepth: 2 U-Boot API documentation ------------------------ @@ -17,3 +28,8 @@ needed). :maxdepth: 2 api/index + +Indices and tables +================== + +* :ref:`genindex`