From patchwork Thu Jan 16 16:12:05 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: 'Darko Komljenovic' via swupdate X-Patchwork-Id: 1224323 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=googlegroups.com (client-ip=2a00:1450:4864:20::53e; helo=mail-ed1-x53e.google.com; envelope-from=swupdate+bncbc6ynavgsakrbgmxqlyqkgqehirm6ji@googlegroups.com; receiver=) Authentication-Results: ozlabs.org; dmarc=pass (p=none dis=none) header.from=googlegroups.com Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=googlegroups.com header.i=@googlegroups.com header.a=rsa-sha256 header.s=20161025 header.b=fjS7tRf+; dkim-atps=neutral Received: from mail-ed1-x53e.google.com (mail-ed1-x53e.google.com [IPv6:2a00:1450:4864:20::53e]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 47z8PS6ckJz9sP3 for ; Fri, 17 Jan 2020 03:13:16 +1100 (AEDT) Received: by mail-ed1-x53e.google.com with SMTP id c24sf14232536edy.9 for ; Thu, 16 Jan 2020 08:13:16 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1579191194; cv=pass; d=google.com; s=arc-20160816; b=uEkJcTLpgpXmiHWfKTNkKA5FLU/BK9Gvauco/Wykx/WHRwYG4mHIBun9XN7By0+Vln VdQvoXXCEl7VFIdzDnWUXGNDG0MpFNArManrAcLmEl9YzTx63I6oxaalSY+FoWUegA6B 6ih8B2rPSn+mK+mUi9irwx78vUAp41+64j/zM7cRSqC0BuY6KmQ1atjRyDf24Bqes190 AFOfQyes9pjg/qdLY5myYVlTY4KbY5Yo0kUoxtrxel/yaYr4SFZsFriAdq8TbDItVm0B SgH3LFioRL+ymwBmsBL7jt7UDwryhuare8jVmYVEipJdlSA3/S27+Qgkn9Ed/3TdBVLe Zeag== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:reply-to:mime-version:references :in-reply-to:message-id:date:subject:cc:to:from:dkim-signature; bh=Gmu7igR3OAvqdXkjB1ZnLVAOO66n6KJPPS8ZVnxkpIk=; b=zjyXL33euydxbHuN4fZCQnf1iyY/vc5U2Ea9J1IzUB9fFH6TaHhVUgeMN27RtykTH1 A2eCF8kHiWq7/44iAMgMizw5Anv0cNq8gaHhsnajLh6Z2Bbrptt7uy1QdgsLc6ch7oAi UlRVgN4EX2Z/XDSBXStT3ZRKJ+I7p8jsehb296wHC4AMUyWxe+wOkbyeSheN0jS2UHxm 5Lptwbj0mCyRwk+rFQEw7nGuJ+XhOch0qnsFeIxZnURGNZqCIM+w7UzPcF080Zd34pkO ghdi6eLwO/VAy9zi9vCSZBl3D9M/gTvLDlMgjUfNy2IWcFMfpD8WWsi+Rb3YpwuY8G4t VVtg== ARC-Authentication-Results: i=2; gmr-mx.google.com; dkim=pass header.i=@de.bosch.com header.s=key2-intmail header.b=ivkKwOU4; spf=pass (google.com: domain of mark.jonas@de.bosch.com designates 139.15.230.186 as permitted sender) smtp.mailfrom=Mark.Jonas@de.bosch.com; dmarc=pass (p=REJECT sp=NONE dis=NONE) header.from=de.bosch.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:x-original-sender:x-original-authentication-results :reply-to:precedence:mailing-list:list-id:list-post:list-help :list-archive:list-subscribe:list-unsubscribe; bh=Gmu7igR3OAvqdXkjB1ZnLVAOO66n6KJPPS8ZVnxkpIk=; b=fjS7tRf+Rz10mlElqHo3C+i303vGfKhHOcWIDfnKQ9UOKOOydDx8vGUONa0PZJcm7S /z52QnTeFuluUZ3xlzyVG98vvyrYbyCjFlq4FdfCdNyvmfqCO7Ost80Bx0mrn4LGO4bh 29XfECe1Uf2nxN3JA867gYubr60aMxHwPs/59x/I46qE1SqA/f0zEG7OwVDbiS2jQfY+ x/WK5+z+mEgh66IbF6x3xy0wYGWDjLZ9IsdZSncserYlkeEioZsrmy9jY6oHcUwjOpGw KNw3xTM8OSzTx5YvhgQexIxnX4ayeNCny7Q2AC/YIwSicH3/lmtK6xwGPg+5qcVTlwWY Q3zA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:x-original-sender :x-original-authentication-results:reply-to:precedence:mailing-list :list-id:x-spam-checked-in-group:list-post:list-help:list-archive :list-subscribe:list-unsubscribe; bh=Gmu7igR3OAvqdXkjB1ZnLVAOO66n6KJPPS8ZVnxkpIk=; b=TnOl+M5DK0Z+HZ0ZBQYHb01Ab4WxOEll56ZBnG0jFc4YYaa1w62OaD/sZW8o9ctu29 B+YEFu7yvoMK01TAiR06dMlOP6WxmJ9HRmMWBVAbuRCSW1slapuZ86lsW4/4jbfBD0Il FyRljFPagKW248XQqgwFFIoh4F16ijD1TbsbyqfICumtuTixQv+f8v+NV3qA3yUVgAsQ T8nQT09yVoEihPFS6bCOkQgK+4cqdyOOasPPzQrmWsjRmdvFopLJEKQTIq3LPtuWIC6E A5AGknuePQU/hrHHAVOBD77sxHmFtE0y+Bt5zUTAFAdpiSzNaAtvhla1akpoz+0G1I5P J5Ig== X-Gm-Message-State: APjAAAVg2nelEzd63m1fu1GmXc61gQTwKD2qESiWv6X5qc4PN7WdVxKG p4qR6F/Pn78O/8y7g+ETbAE= X-Google-Smtp-Source: APXvYqyCOjYP8nSZ8kxFoCw4XzUFkzH4rE/5gbuQMKz5N6aHlYn/F9U/1obkwHu6ey5BRi94QIDvWw== X-Received: by 2002:a50:fd15:: with SMTP id i21mr37489309eds.91.1579191194055; Thu, 16 Jan 2020 08:13:14 -0800 (PST) X-BeenThere: swupdate@googlegroups.com Received: by 2002:a50:fd15:: with SMTP id i21ls5307446eds.9.gmail; Thu, 16 Jan 2020 08:13:13 -0800 (PST) X-Received: by 2002:aa7:d64f:: with SMTP id v15mr37196546edr.71.1579191193435; Thu, 16 Jan 2020 08:13:13 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1579191193; cv=none; d=google.com; s=arc-20160816; b=cX8hZ2LzN/KW4RS1Kmplxys2rBxKcqAUh31zKug5FN7hKUm2yxjibKZlxHhNW83WAL 711TGDzfPHuDtnjLzgWn9UAP2vtx/Nk0NmW+uAXe0AAP3gCsj7myzO2iNjUrHCMm+Ew3 PK0XPx3sk/1NJr+IjPk1u0QIpEMXXdY1UGdV4wjT69c8TqczfLC0VIZ52iAyO/O674s5 vAyxCiUnwckCAMnAVK4eqyfzTk5Qaa2HXUVbJjSPDEPyW2Ea43KqHXk4ry2OnqRTfzsV gSsf3Ny0Ms7bSKNk6nWRrgoVzAviT2nro/cRAGE17qFkyrtvskel5+Iq2CST1F6lWCAd Ia3w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=L9oALokXi+EqwkbggHtdAC67b9DBwtaxyxPZyZWOZkE=; b=MxENnVA8iEyZJIWxWYSNCcuFcti+36Cy6Rz17a8gf6w1GCH1wtyrCiXwRt9d9ghsmT DH7L73gUgOi/6F5dqHKooBi8GJO4vVYLx9GQEuRxXQ72AenNtt0/rj0tiPO46LKOlQg0 LX+0uJMMIs0OCYlmDPRo0oTLaob52+Hofu3fCrsaJznzY2dxes40HWILbgmv9SdeOkjy Gzm1Pb5KHac1eg9JjGhDZ7hVGGaYjv1N6HTDxXCtEsRFK02lhCLlWsyYSCjaykFxQayp TgbkzTY4HPjWv9GZtaFdAAwFkt6rgchPIErBS9hqAsdwF/hWObUS0GDRtPTSK6dQDyW1 ippA== ARC-Authentication-Results: i=1; gmr-mx.google.com; dkim=pass header.i=@de.bosch.com header.s=key2-intmail header.b=ivkKwOU4; spf=pass (google.com: domain of mark.jonas@de.bosch.com designates 139.15.230.186 as permitted sender) smtp.mailfrom=Mark.Jonas@de.bosch.com; dmarc=pass (p=REJECT sp=NONE dis=NONE) header.from=de.bosch.com Received: from de-out1.bosch-org.com (de-out1.bosch-org.com. [139.15.230.186]) by gmr-mx.google.com with ESMTPS id d29si1012869edj.0.2020.01.16.08.13.13 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 16 Jan 2020 08:13:13 -0800 (PST) Received-SPF: pass (google.com: domain of mark.jonas@de.bosch.com designates 139.15.230.186 as permitted sender) client-ip=139.15.230.186; Received: from si0vm1948.rbesz01.com (unknown [139.15.230.188]) by fe0vms0186.rbdmz01.com (Postfix) with ESMTPS id 47z8PP1Bmrz1XLFjd; Thu, 16 Jan 2020 17:13:13 +0100 (CET) Received: from si0vm2082.rbesz01.com (unknown [10.58.172.176]) by si0vm1948.rbesz01.com (Postfix) with ESMTPS id 47z8PP13MSz1Tr; Thu, 16 Jan 2020 17:13:13 +0100 (CET) X-AuditID: 0a3aad16-083ff70000004782-50-5e208b98e13e Received: from si0vm1949.rbesz01.com ( [10.58.173.29]) (using TLS with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by si0vm2082.rbesz01.com (SMG Outbound) with SMTP id DA.DB.18306.89B802E5; Thu, 16 Jan 2020 17:13:12 +0100 (CET) Received: from SI-HUB2000.de.bosch.com (si-hub2000.de.bosch.com [10.4.103.108]) by si0vm1949.rbesz01.com (Postfix) with ESMTPS id 47z8PN6KgGz6CjZNg; Thu, 16 Jan 2020 17:13:12 +0100 (CET) Received: from ninja.grb-fir.grb.de.bosch.com (10.19.187.97) by SI-HUB2000.de.bosch.com (10.4.103.108) with Microsoft SMTP Server id 15.1.1847.3; Thu, 16 Jan 2020 17:13:12 +0100 X-Patchwork-Original-From: "'Mark Jonas' via swupdate" From: 'Darko Komljenovic' via swupdate To: , CC: , , Mark Jonas Subject: [swupdate] [PATCH 3/3] doc: handlers: trim trailing whitespaces Date: Thu, 16 Jan 2020 17:12:05 +0100 Message-ID: <20200116161205.12973-4-mark.jonas@de.bosch.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200116161205.12973-1-mark.jonas@de.bosch.com> References: <20200116161205.12973-1-mark.jonas@de.bosch.com> MIME-Version: 1.0 X-Brightmail-Tracker: H4sIAAAAAAAAA21SXUwTaRTtN23ptOnoMLRwtwroIFER+XONRNGY+KJxk5VXA0grQzsKlHQK EbIJTVylgJCiYrEEVJCwK7uAUE1rasUm/oAaRVGE6LqN1RhEdtfqZl2NcYaC7YNvZ+455577 nQwupmplGpwtMzOmMm0JHaWQKDb+Hr+2tWFZQUaPf2N27egP2Xb3f9Kt2PYOx03Jdk/zSNQu bLcip4gpYSsZU/qWQoVhwPlcWj6sOTDVFRBb0B+qeiTHgfweeoemJQKmSDsGgT8N9UjBYy+C 675mWejjAgK//4xUUEWRKTB50yUWsIrMhInZD5iAxeReuDjqnNPEkJth1vN0bquETAbro79l AibIHPDPeqWh5EToHRie2yPn9fZTQSx0RQ7cOWlBIX00jJwMSEL7Aa6+eiW2ocWOCMoRQZ1G 2Dmk5tiMytKsjOysNJOO4aozMtP2GksHUaizWBfqHi32IQxHPrQex2g1ofLEF1CLdMaiKoOW M+wxVZQwHK0hambq8qmYr2OuQlfKchxrLPMhwMW0ihhp5X1EkbaqmjEZQzYfWoJL6DhCj/+Y R5F6rZnZzzDljGmB3YTjNBDy+mUFVLSJ0TMHitkS8wJNxxNIJBJRsZFMZCyGy31oHa7ks911 /AqCK9eWcqx+3v5dyE4tTMPWUbRBE0ewVt5DCqyhouxrqmYpsbM9oYBSRxBh5zSaRDiiY4gG 4WYl/wOG84CwCBVFzw/Dpqxu3kM+VkKH6z2C1q4hDIJjbzFwHqqNgvuXHDJw/zIsg5mDLXII Dv6shM+PDxIw3j9DwMi7lkUw/rFhMbR9aFKB1dOgBu/hRjVcmXgdBy232gGCjmcAtr6ppeDo /ycePh/3J8D4r1OJcHbMvRzc3tM0PAlak3jiTRJ0tjQlQ+e5ppXQ1xdYDc4X4ynwwDqZyt9S lz7Nl4nxZdq2JQhlmrXmb5Q5Pw2/TmNBubpgr+2TpS1YTPVIf1rR6K907a+RVza+vczUM5/+ t/uXXPMMdKfan5Fpt3duGVImOx9SN84P7N6XPptV1cYUOgcLyUCNiOpq1q3S/+s99npih2iN asWRs6zh0jrjVnPuqXuuo8zd2oTYxhvX7/5V3f/ufd7LE0fzkzptaR2/ra+iJZxBm5kiNnHa L2cIpC0aBAAA X-Original-Sender: mark.jonas@de.bosch.com X-Original-Authentication-Results: gmr-mx.google.com; dkim=pass header.i=@de.bosch.com header.s=key2-intmail header.b=ivkKwOU4; spf=pass (google.com: domain of mark.jonas@de.bosch.com designates 139.15.230.186 as permitted sender) smtp.mailfrom=Mark.Jonas@de.bosch.com; dmarc=pass (p=REJECT sp=NONE dis=NONE) header.from=de.bosch.com X-Original-From: Mark Jonas Reply-To: Mark Jonas Precedence: list Mailing-list: list swupdate@googlegroups.com; contact swupdate+owners@googlegroups.com List-ID: X-Spam-Checked-In-Group: swupdate@googlegroups.com X-Google-Group-Id: 605343134186 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , From: Kevin Zhang Signed-off-by: Kevin Zhang Signed-off-by: Mark Jonas Reviewed-by: Stefano Babic --- doc/source/handlers.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/source/handlers.rst b/doc/source/handlers.rst index e7182ba..5234a69 100644 --- a/doc/source/handlers.rst +++ b/doc/source/handlers.rst @@ -227,7 +227,7 @@ In analogy to C handlers, the prototype for a Lua handler is where ``image`` is a Lua table (with attributes according to :ref:`sw-description's attribute reference `) -that describes a single artifact to be processed by the handler. +that describes a single artifact to be processed by the handler. Note that dashes in the attributes' names are replaced with underscores for the Lua domain to make them idiomatic, e.g., @@ -275,7 +275,7 @@ a different type of artifact than the Lua handler is registered for, the ``image`` table's values must satisfy the called C handler's expectations: Consider the above Lua handler being registered for "images" (``swupdate.HANDLER_MASK.IMAGE_HANDLER``) -via the ``swupdate.register_handler()`` call shown above. As per the +via the ``swupdate.register_handler()`` call shown above. As per the :ref:`sw-description's attribute reference `, the "images" artifact type doesn't have the ``path`` attribute but the "file" artifact type does. So, for calling the ``rawfile`` @@ -328,10 +328,10 @@ Using the ``image:read()`` method, an artifact's contents may be on preexisting C handlers for the purpose intended. -Just as C handlers, a Lua handler must consume the artifact -described in its ``image`` parameter so that SWUpdate can +Just as C handlers, a Lua handler must consume the artifact +described in its ``image`` parameter so that SWUpdate can continue with the next artifact in the stream after the Lua handler -returns. Chaining handlers, calling ``image:copy2file()``, or using +returns. Chaining handlers, calling ``image:copy2file()``, or using ``image:read()`` satisfies this requirement. @@ -381,7 +381,7 @@ format: :: - + INIT: The external installer is informed about the size of the image to be @@ -631,9 +631,9 @@ of the two SSBL administration. +-------------+----------+----------------------------------------------------+ | Name | Type | Description | +=============+==========+====================================================+ - | device | string | MTD device where the SSBL Admin Header is stored | + | device | string | MTD device where the SSBL Admin Header is stored | +-------------+----------+----------------------------------------------------+ - | offset | hex | Offset of SSBL header inside the MTD device | + | offset | hex | Offset of SSBL header inside the MTD device | +-------------+----------+----------------------------------------------------+ | imageoffset | hex | Offset of the image to be loaded by a bootloader | | | | when this SSBL is set. |