From patchwork Tue Jan 21 07:55:52 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: 1226285 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::137; helo=mail-lf1-x137.google.com; envelope-from=swupdate+bncbc6ynavgsakrbng5tlyqkgqetnd7oei@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=cq0FLkpB; dkim-atps=neutral Received: from mail-lf1-x137.google.com (mail-lf1-x137.google.com [IPv6:2a00:1450:4864:20::137]) (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 48218806XQz9sR0 for ; Tue, 21 Jan 2020 18:56:39 +1100 (AEDT) Received: by mail-lf1-x137.google.com with SMTP id y23sf288605lfh.7 for ; Mon, 20 Jan 2020 23:56:39 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1579593397; cv=pass; d=google.com; s=arc-20160816; b=v/wgD5TX6tXXWDIpf3eNEuZ+HwjHQhGUNNSuLeQh8MzBEAQiF6ixNdMG1odQisePK/ NeKyDA1n96C1qV1vgeyZx1VbeKz7qkfROI9FXlcBKr5lUAuCtnVchTZi2ecr6ocdFqKS knobS7m0BVEAB6kwpX4iMM3PKCu3ImZxHoZ7xY/c4CLhIHLWSu+LddEAxSgAgp3WzMN8 vx3Rjk/3sQSyjO5ccrBbzIsoyzVPHODHKbd3R+A3hs1OOBHW/Ae6i/JbwiVFC8NpMubU PvD2ZJNG1hbd/1uRvjDtOfLxYMiNukkK7Q9JijlVNtT/Fd9uzdcEy1BCWWLoew+Oco2p 7aLQ== 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=1kSp/7/eNeu/KTiVajZK2e3tH+0qG6XBqJt5aU/BJjk=; b=DK6FX/Rwl3LcEm0RdVtyvFxnwHqgjC0Q1nsW+EHLVoT7jcbvExHgB3kY/MXFEQcE0q HaDla6xu9oqCwb8VIBq6rFm16Oxiqc87PWROApsb8fHn6D6iq/RGYvJ9h8uqBFgU8u/o XO2ohfM1IGntWYlYW71MJFG9sBLDaSBfHtDcvCyA2iJl8LZvYF0zme0VGYwSy/1P24Cu DmiLUcyPW/Cn8FnlZkFZZMZJ5BIVB/9zLizuQE2n2aH5czHYgdvx/znPIIk9h4yGgwz4 nhUHJIxuoOnZFEQ4Aun2KbiN3Iou7+2ir85R9eMv0dAYXDxJKRb/s1BLH8q1TgBdX7Gt FLAA== ARC-Authentication-Results: i=2; gmr-mx.google.com; dkim=pass header.i=@de.bosch.com header.s=key2-intmail header.b=ymu70nzP; 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=1kSp/7/eNeu/KTiVajZK2e3tH+0qG6XBqJt5aU/BJjk=; b=cq0FLkpBJDE5XB7e31yVfCOwB/2cT85iQ7SLLIHOXOsdYn0jG2LwaGlpECcjK0TziN U5dxq+ItrcI0cffy1/FoLA4ZETsfDxomiq2xCai6mQPbF581vrObpc/pDf+I7DRMfCVZ 2sakF1FQOQPM0NNKA8TadpumiMEFTa+owE3WbC6nY1iQCIZq1qj3ap5l9HuhX/nmCmBB WZJ3F+ZFg3fU2mVCQ8oCjrRrdlZsDYI5vGb8ZZNImjaD0SZR8e85MRpGjBdnAJ4ExiyD HPNkiA55iJmeuac1YmmYZQxvYriwnS9nRVQk664eD6HrvofiWsFBfKtFO8K/b/SLipIN We2Q== 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=1kSp/7/eNeu/KTiVajZK2e3tH+0qG6XBqJt5aU/BJjk=; b=Q+ob5GFdirkdXbqZvrXS0wWdm07GmQhgU542R+E9Zf9YbAsHWjJW/IjTUpV7yUK1jT ROrkd32iSEY9U4nTuxpI4AOdGSFNXuC/izuqA9X+951j6zuFRr30R+i3/E6+3BKE7NF5 de3bRT8vwkvNG6zlhXVlkVwK2RS/ibNp/WGI4ZqCiYFOvFqZxdoxINY6lVZgeci098iH CP1Y68oWGGitQZpoVz0tzlHONuIHlvVNodow6rMK78xwH0pvkQ1OksHqQy8mxUrfjjrz pAQqkvBu2ZEOAxIkylNIVuebJay5SzzvWRCQx5YAD4n97yPWQMDzg0gdvom5TbWELad4 W0EA== X-Gm-Message-State: APjAAAUgtqGpZxJC02nh21loJhdilyKTd7azEvvDSkxMk2JNIv8iDk3V BRLK+tIxVn8lSotom3BDYzU= X-Google-Smtp-Source: APXvYqyrWFr80OQlEgqtZJyvQjsc7uvo1dYeouSe5EygdIMkExIWP7JKILgdydijZ+wLS4F84UzCFQ== X-Received: by 2002:a19:3f16:: with SMTP id m22mr2013169lfa.116.1579593396826; Mon, 20 Jan 2020 23:56:36 -0800 (PST) X-BeenThere: swupdate@googlegroups.com Received: by 2002:ac2:518f:: with SMTP id u15ls3320820lfi.3.gmail; Mon, 20 Jan 2020 23:56:36 -0800 (PST) X-Received: by 2002:a19:9d5:: with SMTP id 204mr1891157lfj.120.1579593396177; Mon, 20 Jan 2020 23:56:36 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1579593396; cv=none; d=google.com; s=arc-20160816; b=ESKA5hw0mn8H68Cqt715esoIItawvd3G1OWooPYrQaKj9Uhnrafq48sFmaMVjlCvNz 5/KG2cdgyprFkI6pLLk1hRFHXsQBz0tHSKVYH5jUCjBrMn7+qkomPlfu93cGgRt/GKhC /g8c6C0hQqwo8LFgxP4kkftn68Ora5F7iQ+3ebtiWUpKDpE6Z1Pp1uPoLWvvVzUo5u6T F1rr9ocO7f3teyeSYPYsxm+TRRPxoTWYdPRBQ/oDHHOgQCPffCpEo0vbDpLZncre0H6n W7HlAxW9M8xgLfs45rJD9Ok8oEMFIdWTqRJizpO23NxgTGShicKA5+HyWfegLoPC8cqN XyXw== 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=Fe8hrUfr2fvmesinyz6vsYHvHVhH7bLv3af+L/4aMow=; b=meACng8njT3k0meeEP4nqa5qRKzdQncTocBHdtYFd7y5izR3s1SKxxcM9coJoCMQIS 6MyT6+e/UeUcDiEZJqsWpCmb4BQGdLYEjfzC3SyKZIAkvc5qd1EGj+yN2eTwWr1IH+6n jDw3419BaQgKO41glSS5Wdkn0gRrQDjoMFKCwNsbx26UnPhFR9PzZY8HYbDLLWN/VHEg TjtVrSGa1FwH0yYQZ3Yxu5UZQiJGr1jMFrb9lP9CwIJbpzOC5iAJmnUSsUmxQS0982vU NPURwV1XoUS23VStYmtSTg/j6yx7tu+OANmdtrpj3oQCn2svTczq5CnhFqVcGYljjxXa VYEQ== ARC-Authentication-Results: i=1; gmr-mx.google.com; dkim=pass header.i=@de.bosch.com header.s=key2-intmail header.b=ymu70nzP; 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 h8si1558447ljj.3.2020.01.20.23.56.35 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 20 Jan 2020 23:56:35 -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 fe0vms0187.rbdmz01.com (Postfix) with ESMTPS id 4821831W6Wz1XLDR9; Tue, 21 Jan 2020 08:56:35 +0100 (CET) Received: from si0vm2082.rbesz01.com (unknown [10.58.172.176]) by si0vm1948.rbesz01.com (Postfix) with ESMTPS id 4821831Drsz3rS; Tue, 21 Jan 2020 08:56:35 +0100 (CET) X-AuditID: 0a3aad16-083ff70000004782-a0-5e26aeb2d76c 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 66.88.18306.2BEA62E5; Tue, 21 Jan 2020 08:56:35 +0100 (CET) Received: from FE-HUB2000.de.bosch.com (unknown [10.4.103.109]) by si0vm1949.rbesz01.com (Postfix) with ESMTPS id 4821826kv3z6CjZNn; Tue, 21 Jan 2020 08:56:34 +0100 (CET) Received: from ninja.grb-fir.grb.de.bosch.com (10.19.187.97) by FE-HUB2000.de.bosch.com (10.4.103.109) with Microsoft SMTP Server id 15.1.1847.3; Tue, 21 Jan 2020 08:56:34 +0100 X-Patchwork-Original-From: "'Mark Jonas' via swupdate" From: 'Darko Komljenovic' via swupdate To: , CC: , , , Mark Jonas Subject: [swupdate] [PATCH v3 3/4] doc: handlers: trim trailing whitespaces Date: Tue, 21 Jan 2020 08:55:52 +0100 Message-ID: <20200121075553.6677-4-mark.jonas@de.bosch.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200121075553.6677-1-mark.jonas@de.bosch.com> References: <20200121075553.6677-1-mark.jonas@de.bosch.com> MIME-Version: 1.0 X-Brightmail-Tracker: H4sIAAAAAAAAA21Sa0wTWRjlTkt7qR0cBkY+i0iYXVwligU1EjXKP40x0WBiwkaBKQy0SgE7 BUVNrC9eRiIqQccsi7pEF7Wy4pKWZalUTQTUiJYgBjUqvipitEokPuKUgu0P/517zne+c+/J xTK6VKnBhnwzb8rn8liFSq5adD56TrN1Rrr2PSSXda1KrrV/Ck4hVtSJ1+Ur2qo7FWuI31VL svk8QzFvmrs0U6U/9LxPWfhGs/X0tasKCyplKlEIBmo+NLfYiEqkwjRVS4C71RLsO1gRDPe3 Id/hXwQPK3uVXouCiof+6zaZF0dQidA3PEp4sYzaAfXiLgljHE6lQPXbsQQ5FQcfOuzIi0lq MVhOjAT7kmPgbNPlsTUh1BJwOI/KvZiWZqpGvih982HQeWxQ7lsP0PHypewgmiwGSGKAVI+I RsQIBm2xMUmbnJRg0vHCNm1iQlaB8SLyVTbFhhq6cpyIwMiJFmCCZcjYuhnpdKiuILtEzwn6 DFNRHi+wGnLnUMUGOvwHLRTpjAZBMBTkOxFgGRtB1u+OS6fJbK5kG28q8NmcKArL2UgyF69e T1O5nJnfxPOFvGlCXYwxC6T2vBQYZuJz+a05hjzzhMxGkygoKIieEqgExhI4xInmYbWUzXhX kEIhZxQMueP2qT47PcH6rV1ooSaS3FcheSivqi/K/5GqmUa6yySBCRD8TjfqRxix4eTrc9KM Wvp//jwgLd6KwsZJvympQfJQ99RQZ/uI4OipZgI8Pe8JuLSvTAF3WkUl2M9cVsLQnpoQ8Fzc q4Zv9/aQ4LowRELnh5pQcH3ePxmOj1ZFQHnbfgbaSw8w4Oh7HQk13X8AeMRHAAet96eBeOFd NHw78ng6uP6+HwN/9dhjwd5ez8KAp/wXOFlTFQcnG6t+A6t1cBZceuaKh7vl/bOla1TMBbej V+uWyiSkMrfMHivTzJl/UuY463+dxoJOu5uMnKge1i1dwzFHnm1fnrLs/6a01Wl3awdjWhwz bzQ+Xf5046R1xSXDGS/4Y6ce/TpyuPu/F5vhxs6VN28lRK28+mdqozhwbiCtxaa7zRizNpRl tve5Qht6w//5+qADCWdeVa/rLhrtWZtzLe5A76hRlvBkUtSVIMveDDV2pHoyWbmg5xLjZSaB +w5NZL9AGQQAAA== 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=ymu70nzP; 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 Acked-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 a55292b..e4b1619 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. |