From patchwork Tue Jul 16 16:42:45 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bin Meng X-Patchwork-Id: 1132863 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="VBsnL4xw"; dkim-atps=neutral Received: from lists.denx.de (dione.denx.de [81.169.180.215]) by ozlabs.org (Postfix) with ESMTP id 45p5mq55T8z9sN4 for ; Wed, 17 Jul 2019 02:43:07 +1000 (AEST) Received: by lists.denx.de (Postfix, from userid 105) id A93E6C21EC2; Tue, 16 Jul 2019 16:43:05 +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 4263FC21DC1; Tue, 16 Jul 2019 16:43:03 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id 79B66C21D83; Tue, 16 Jul 2019 16:43:02 +0000 (UTC) Received: from mail-pg1-f193.google.com (mail-pg1-f193.google.com [209.85.215.193]) by lists.denx.de (Postfix) with ESMTPS id C8996C21C6A for ; Tue, 16 Jul 2019 16:43:01 +0000 (UTC) Received: by mail-pg1-f193.google.com with SMTP id s1so3406885pgr.2 for ; Tue, 16 Jul 2019 09:43:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id; bh=jGJqiEwEwibBheUBTS7UUkPhEvkVJ59S15grwHvJebo=; b=VBsnL4xwmpYPL6s8X5t2R+D2tXhsQ2xOR2wmmhu/Hlj9aSnSpIigW/asaPyK94+sLS GKsSPqTBecStzRB4DPWtw3zHTBhthu5TsNHa7tTt2slU5jtUDiTX++197VX1jAftzWeu tihdFU8vzN8Kk237RJcEw+9CrCEX+WITP5gKcujKMzfAXxre9/jGrFHDwPX1d0j3/RF8 +F7drXve6Vj5kTrLTitz7TPhEqEh3OjL6Cu6azAmaKgeobelMLBvUpHiwErwsqiwzCO0 lvt+tS6dylo01milgSrVTaiVQoe3dg+/ftREs/IAj9yiQu/G+yC6mdyza3b9Ygc4LmO7 c3tA== 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; bh=jGJqiEwEwibBheUBTS7UUkPhEvkVJ59S15grwHvJebo=; b=aYgIle1DLbP6U8P6mky/Z7YInpKrdiREdkM+BAOaa9RhMWBnNQLmzHhWrqNIp2vA+g bmREWT0JrSbcqQOmGFGQV28fpyhb0oCfQIGIDbXNIg/ZDCeMExTggEz1FBnnEAlMkv5k 651QJs7Y7coLW4dw39gVC1DMYctQ/T1ydAj3LdgUFch0WHQGWK3L1x+HTeT74qkgzRvA M7zT6XWCpEJ94XzUZjtNzEk0WI2Nc6GbxXPS48F9ocUq2WIsXJy+8gB2kQ4/D1EJaR0V RGxKJGaB8jcISphSdWoMJqe85MlrcJXqXq5MBecUCi16K5Ax5nb2E6RqCw9+tyvb70bh 8DnA== X-Gm-Message-State: APjAAAV6TGFqVf5w0mee/5RabUALQRIQeNH9CMPSNbOeBPpYq5ZolZ4a duubheQP6lF3okkURlXMmkJWDKS+ X-Google-Smtp-Source: APXvYqxnstzcFzNBqLdtpoerYdXbZU5qY26U5Z6nCri39Ywjb3BMntnQxeleQzyQINqYpTWZzSCDRw== X-Received: by 2002:a63:5048:: with SMTP id q8mr34804685pgl.446.1563295380281; Tue, 16 Jul 2019 09:43:00 -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.42.59 (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 16 Jul 2019 09:42:59 -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:45 -0700 Message-Id: <1563295374-1504-1-git-send-email-bmeng.cn@gmail.com> X-Mailer: git-send-email 1.7.1 Subject: [U-Boot] [RFC PATCH 0/9] Initial layout for Sphinx HTML docs 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" At present there is Sphinx doc build system in U-Boot, however the contents are very limited, that only a few API descriptions for EFI, are included. This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. @Wolfgang, is it possible to host the Sphinx HTML docs on denx.de? This series is available at u-boot-x86/doc for testing. Bin Meng (9): doc: Move existing rst files into api sub-directory doc: Add top-level description about U-Boot documentation doc: Add driver-model to Sphinx TOC tree doc: driver-model: Convert README.txt to reST doc: driver-model: Convert MIGRATION.txt to reST doc: Add architecture specific info to Sphinx TOC tree doc: arch: Convert README.mips to reST doc: Add board to Sphinx TOC tree doc: board: Add Intel Crown Bay board doc doc/README.x86 | 37 -- doc/{ => api}/efi.rst | 3 + doc/api/index.rst | 10 + doc/{ => api}/linker_lists.rst | 3 + doc/{ => api}/serial.rst | 3 + doc/arch/index.rst | 8 + doc/{README.mips => arch/mips.rst} | 14 +- doc/board/index.rst | 8 + doc/board/intel/crownbay.rst | 49 ++ doc/board/intel/index.rst | 4 + doc/driver-model/{README.txt => design.rst} | 538 ++++++++++++---------- doc/driver-model/index.rst | 9 + doc/driver-model/{MIGRATION.txt => migration.rst} | 42 +- doc/index.rst | 69 ++- 14 files changed, 469 insertions(+), 328 deletions(-) rename doc/{ => api}/efi.rst (92%) create mode 100644 doc/api/index.rst rename doc/{ => api}/linker_lists.rst (99%) rename doc/{ => api}/serial.rst (80%) create mode 100644 doc/arch/index.rst rename doc/{README.mips => arch/mips.rst} (87%) create mode 100644 doc/board/index.rst create mode 100644 doc/board/intel/crownbay.rst create mode 100644 doc/board/intel/index.rst rename doc/driver-model/{README.txt => design.rst} (68%) create mode 100644 doc/driver-model/index.rst rename doc/driver-model/{MIGRATION.txt => migration.rst} (85%)