From patchwork Wed Dec 30 16:55:22 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Heinrich Schuchardt X-Patchwork-Id: 1421424 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=pass (sender SPF authorized) smtp.mailfrom=lists.denx.de (client-ip=2a01:238:438b:c500:173d:9f52:ddab:ee01; helo=phobos.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=gmx.de Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.a=rsa-sha256 header.s=badeba3b8450 header.b=DXcUCBFU; dkim-atps=neutral Received: from phobos.denx.de (phobos.denx.de [IPv6:2a01:238:438b:c500:173d:9f52:ddab:ee01]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4D5cqH5hpfz9sTK for ; Thu, 31 Dec 2020 03:55:39 +1100 (AEDT) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id DC3CC82540; Wed, 30 Dec 2020 17:55:36 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=fail (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.b="DXcUCBFU"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id EA4B8824DE; Wed, 30 Dec 2020 17:55:35 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H2, SPF_HELO_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from mout.gmx.net (mout.gmx.net [212.227.17.22]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id F2970824DE for ; Wed, 30 Dec 2020 17:55:32 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=xypron.glpk@gmx.de DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1609347328; bh=+xomHWBFS8lXfrEJB8uYp/ZoO0pLvwjZoGlmp2BtQF4=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date; b=DXcUCBFUgwSyMf/wcx4EcV8Aq11f74hjePWNywCrvEGC4qYvERx4v3FutQtnqavEF fyT8dUhSWNXvSwuf/6m3IoJx4sN93/DqFyCm1HmEIO3+0AiXAeJnjgtlB1/2r5z/kc 4gZHIH4I/CAvbHVX45kZw4O+9Codw3OWZYl08Mco= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Received: from mcbin.fritz.box ([62.143.246.89]) by mail.gmx.com (mrgmx105 [212.227.17.174]) with ESMTPSA (Nemesis) id 1N8GQy-1jzL3v32fI-014Eh9; Wed, 30 Dec 2020 17:55:27 +0100 From: Heinrich Schuchardt To: Tom Rini Cc: Igor Opaniuk , Sam Protsenko , Lokesh Vutla , u-boot@lists.denx.de, Heinrich Schuchardt Subject: [PATCH 1/1] doc: android/boot-image: invalid C declaration Date: Wed, 30 Dec 2020 17:55:22 +0100 Message-Id: <20201230165522.107618-1-xypron.glpk@gmx.de> X-Mailer: git-send-email 2.29.2 MIME-Version: 1.0 X-Provags-ID: V03:K1:ew49EB7WaSILwsh354eUwmZ4ynciCZWVMck0p3RU2Lwazx4VRmS mB+LpBiQXxbnyClpBl4YWsuYf3mHXVacnYBn0/OA/qMKSPvIRC3jMFxUuYXCzvhH3Wae2+Q +aYrxcJcRaFYy/mf8TqbOJMF2pjq3GvJzk4vGMd72dXf0mmNYBSkJVkwvsfeu1dVHyx3ldJ OixnMfYqJECvxBcDjRNhg== X-UI-Out-Filterresults: notjunk:1;V03:K0:YvJozDUakZ8=:7gzwU5RWxM9mCkF5Y/lAFD wzI5gD6jOMxxI/cK4VKVNqAJGFpxNPjjavoR/8egsNGHaysMmJNuyEhRh2GiKlL1WdyrAd/eV CetM52BqBmn9cxnM+dJSbEch1kzBxx95oGJ9dJQs0gUdUwf+rTIbZlfibaSGWYcJ8JFfqfH8c PXWyTvet0/+5F0nRevwQ6riy1h8kZ2JeOp1pHVxxIOfREQH0MbPSPKx8GGFPw+u40Kvn5OrPe HMSR6V87eW4HK3nUlwIN1FSP7b6iKc8P7QmzPyT6qcUDrfAwawxLEf5JtrC1cpFVbKx31RVS+ 4imqdPMjTzE2DkYeu5aXZmU55fEnxiGkFc7NxefzdGMlyPSv/ft+jc3hI4NaxNRUeMaTG8TFR lORLjRXmCuzpg9Ngx2nH3BhlyxBchw0NcJpsPAF1jB7OWOPpDxICLJf5GuaTrpStExZF9VwXW 3k3B0z5/4gh3BjE26zr08u+KBKNKF9rQnzoYbT+MVhRbTQCTjUpCFWpjenT+4lZLK/45yONwP n7yOxWdWPSRCtRejwOiJBHNi4QPxK6DxIZagG4k0J4WLg64KHJaIV3GHnbkXXzFjZNw328P19 EceJKZHG7/+Jl+XM3tYoXo+pfdF5a4ZG0cOMo8OI7Yubh1Po0DHw56VtNPAmeYTdmJRyeap4a ist8WbO5GU8vCut2Zn6jk78jPtfZDUxiLOWna+lF+mVGRdO5BT9OuWYYYyIvVtUOxanq5aCvo 7JfgadPQ+ilZAJNNVi866d2EVXC/hi4w/c9PJNSk8FPoG0J7cQO5pvECP824MntxuQRPK5l/J n/DV5evZYXsS1nbPhU3WwUqtChu+KjUlutf9F/SWL/KDP8xxMATfAzw1kF1dPZf2ZjDHKiOFY dzXVboJZRVJCjsEVHEYQ== X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.102.3 at phobos.denx.de X-Virus-Status: Clean make htmldocs results in an error: doc/android/boot-image.rst:33: WARNING: Unparseable C cross-reference: 'struct andr_img_hdr' Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6] Follow the style prescribed in https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#highlights-and-cross-references Add missing definite article. Signed-off-by: Heinrich Schuchardt --- doc/android/boot-image.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) -- 2.29.2 diff --git a/doc/android/boot-image.rst b/doc/android/boot-image.rst index 195da688f4..8648ab721b 100644 --- a/doc/android/boot-image.rst +++ b/doc/android/boot-image.rst @@ -30,9 +30,10 @@ next image headers: v2, v1 and v0 formats are backward compatible. -Android Boot Image format is represented by :c:type:`struct andr_img_hdr` in -U-Boot, and can be seen in ``include/android_image.h``. U-Boot supports booting -Android Boot Image and also has associated command +The Android Boot Image format is represented by +:c:type:`struct andr_img_hdr ` in U-Boot, and can be seen in +``include/android_image.h``. U-Boot supports booting Android Boot Image and also +has associated command Booting -------