From patchwork Thu Jul 18 07:33: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: 1133563 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="H4XInK97"; dkim-atps=neutral Received: from lists.denx.de (dione.denx.de [81.169.180.215]) by ozlabs.org (Postfix) with ESMTP id 45q5WH5KDzz9s00 for ; Thu, 18 Jul 2019 17:34:51 +1000 (AEST) Received: by lists.denx.de (Postfix, from userid 105) id 63C77C21F38; Thu, 18 Jul 2019 07:34:49 +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 B0080C21D74; Thu, 18 Jul 2019 07:34:47 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id 1BFA7C21E0D; Thu, 18 Jul 2019 07:34:46 +0000 (UTC) Received: from mail-pf1-f195.google.com (mail-pf1-f195.google.com [209.85.210.195]) by lists.denx.de (Postfix) with ESMTPS id 6AE7EC21D74 for ; Thu, 18 Jul 2019 07:34:45 +0000 (UTC) Received: by mail-pf1-f195.google.com with SMTP id u14so12208540pfn.2 for ; Thu, 18 Jul 2019 00:34:45 -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=moOwzrBPIHtHyykl+8mwbLYlhHYE2OMOk3f1ls93T0A=; b=H4XInK97QCzBDMT303Gm+geh0TChb2KEBihdvCieGHhrUOc43F0CFUw9rvMWWW7TFY jotjLnnuGgodCNm8tuvQYwQS/6ztVf4zLVwIg4jPM4kOlvaVr+FuvGzhz8X0ORHEJTmJ 042+h1gpqh6WBuXekxfUCAke2TCjsM1gWRr6mSxuYBQ+scR/iERJg/txQ9/8cuJqWH9k gjtY7j4rYJQZzmMvD7ZF+S1p0NK3/ijSBnhV5c8TpvWbRNBFcC4klwt8Wny/vViKUGOC /8EVPEhXE18rIgEasVkhsPZ2zs/owVy3FGOOC8pxnJnHLirAVIq6WtT+y3zHIIefYlvN 28lw== 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=moOwzrBPIHtHyykl+8mwbLYlhHYE2OMOk3f1ls93T0A=; b=jc0GFxyR+v9KTBJWA0EpJTSiXRY9La86efEpgib8v8r2biURpWl2VDcA4gO9L6sgAC xMiPHyzyF81xOZf8en37fxLhb/a/hsl8kHlrXyrzpGLAAcmBxaCBl0jg2RLii+I35CdW 1oLswOo/n9isQQF0ujINwHDHcUtOvLOYeXOpt2u9oOT0ZpPYP4NTW7JXxRoYK0+9WvwG D9HY7Eekrb9grMK1I/pG7m7djXJ1cj3zQBS66oTzeB7xPeTGp0UlbQH3uFiDD4+3kKR+ 4klz0hCMzf8HpvXhDUGpuRXkqb6YO7rv6cKgo6EP7TGKdzrN3kVOGoPD99BMnXWIW73H FXBw== X-Gm-Message-State: APjAAAUlUhBIWJQ+OQ5NVAIVTwS4RrVFmwHDx2xF9UvkwF8YpmfQt6vV jz4qYbQLSGoPNHDhb3HCrCjOsZ2/ X-Google-Smtp-Source: APXvYqwSAlw28nDBtsWDZVdcDkDZqeDJYasFaoRvGFMNwUIYLLChasU36vrxLAa2QJ9ta9UmZ6m2Ag== X-Received: by 2002:a17:90a:db08:: with SMTP id g8mr47793193pjv.39.1563435283691; Thu, 18 Jul 2019 00:34:43 -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.42 (version=TLS1 cipher=AES128-SHA bits=128/128); Thu, 18 Jul 2019 00:34:43 -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:47 -0700 Message-Id: <1563435275-22326-3-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 02/50] 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 Reviewed-by: Heinrich Schuchardt --- doc/index.rst | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 1946d09..3500e68 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`