From patchwork Tue Oct 17 14:06:57 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stefano Babic X-Patchwork-Id: 1850250 X-Patchwork-Delegate: sbabic@denx.de Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=googlegroups.com header.i=@googlegroups.com header.a=rsa-sha256 header.s=20230601 header.b=mSjADs+H; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=googlegroups.com (client-ip=2a00:1450:4864:20::238; helo=mail-lj1-x238.google.com; envelope-from=swupdate+bncbaabbb5kxkuqmgqettsszlq@googlegroups.com; receiver=patchwork.ozlabs.org) Received: from mail-lj1-x238.google.com (mail-lj1-x238.google.com [IPv6:2a00:1450:4864:20::238]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4S8wld0DNYz20cb for ; Wed, 18 Oct 2023 01:07:08 +1100 (AEDT) Received: by mail-lj1-x238.google.com with SMTP id 38308e7fff4ca-2c520e0a9a7sf22012631fa.3 for ; Tue, 17 Oct 2023 07:07:08 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1697551624; cv=pass; d=google.com; s=arc-20160816; b=sqmgS60kt8LlWK+gCDF7BS51XopHnQeMCMNYa9BIA3oYHC60ULhgBbo8R7o2RVWg6i +1/4CTAIY1FaAA6FiCGM1eOHWH6YqVNQamYD6HzW2V4IiSzjDq1TXgYdniAuNZajVcFu KneWCZm1SwWc6n2HoD5RC2nQhyxR+kIW65nEqcuXdV5IJhtphE0SfUPBfe8N/VMiahtK Q6eYOY/39Pjb1hh6iTc2gp+UjgBFqOhL1lU5/kJo+pm04fiTCbhWVGoHvgkJJ+lGZTy2 NNqrAsPba6hS52OfC1WZW0Ce5SDIIeSvb8Q/XxqfrTzBnGuTNRQwSh6AvTYI9hZsfGuf XHyw== 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:ui-outboundreport:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from:sender :dkim-signature; bh=7/B7wWd9eUBf+kMoJ0NJxP5NrFMRD2V+zXmC0OqXvSY=; fh=TiEWcqMcKpHk5s7uErzpntoONrNfOXwKpI5P8bIlggk=; b=GYJUYh2uwKw1BaVpwOPznUIddDduMD8XfVl7Y+93HWol2xBNJntsr8CFXoAV8JvvEv +BGqIg6LJLXSsGxohaQ79F/ZTzb4GaIMvzzDrveUi9IJ3lcocq8dfKXvnoiJvBcpVFmh GyyOcr3z++iLhEZIeRDqXuuCdb5jJtWQh5YSERbsWR47/NIUwvF1xA7WFnmHQPp4YDHV ubdZ5ozDQEhuZGP58SGSiXyd85wQIIAGdgmMO7AGOQU15EtbnzELF43lQlBRGsIbndu6 ZlWNuF/h6Dv12pS9SN9Mhdt++ZyqkTF5jLXZC/SbD6aaFpLe7sI38HQ4EDme2tR3fpAn SH6Q== ARC-Authentication-Results: i=2; gmr-mx.google.com; spf=pass (google.com: domain of stefano.babic@swupdate.org designates 217.72.192.73 as permitted sender) smtp.mailfrom=stefano.babic@swupdate.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20230601; t=1697551624; x=1698156424; darn=patchwork.ozlabs.org; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:x-original-authentication-results :x-original-sender:ui-outboundreport:mime-version:references :in-reply-to:message-id:date:subject:cc:to:from:sender:from:to:cc :subject:date:message-id:reply-to; bh=7/B7wWd9eUBf+kMoJ0NJxP5NrFMRD2V+zXmC0OqXvSY=; b=mSjADs+H8Js0t9FfTCqViZZQo2f5NczLLgxoXUZBVZZXEnFLSaaoRykWiTl0ziK84V XaQH+Mo2J/rJGbUGEI5py2ZHv1qCHO0boJhPuE85GZK9TFUi6xRvObMhUMbms+EH9FKe vEy2tTQQWBCyV6O3abRMx3RISCWwFR5kAv2/nFTw7Bx5eSNxGyefLkKQQynTNNCXNbPU ZjJrISZ7nNnD38gEIfsGJO8fjS4rdxiq17R3VVKmRjvodjuT9U1ZGQrt+W2miLZmSCba IfhUIEOOwTQv0cqeyvshhzB6o8j8ZCCCzAJIMwOXoBxhlHNEbLFB4MxfQgstFrIneyKP f1dA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1697551624; x=1698156424; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :x-spam-checked-in-group:list-id:mailing-list:precedence :x-original-authentication-results:x-original-sender :ui-outboundreport:mime-version:references:in-reply-to:message-id :date:subject:cc:to:from:x-beenthere:x-gm-message-state:sender:from :to:cc:subject:date:message-id:reply-to; bh=7/B7wWd9eUBf+kMoJ0NJxP5NrFMRD2V+zXmC0OqXvSY=; b=VWSvPXY5PbYKNKShf0YnPgwUgwXzPb2w+mwHIlxktNKDTUEoAVgI+yfE+JcAPX88EA 4O1S0q9HIalRVoBets1eR1cLFn/Cchi84alFQIVEahQDkBEheX78kddNJfMKXZ7YmERc BZbSYVVpsTWwGlw4w58Bk/A0vPOrMZpm5yLAXGxz0PICujS1wYT1DnmvJGryepjGhXBA PdIoXT6s7PSfjyf02AiS2lX9EbNVj2uDijMavrKC2/4Pw1m2ThalcMuXjAIx/ymv17bi +0G/V/lNe4eL9MjvtZyELgW2MzWCvHp1IKCDf6r2tXlKd/rDV8xg5iz+Rl2b02RcawhB MTtw== Sender: swupdate@googlegroups.com X-Gm-Message-State: AOJu0Yw3ksF/kaWn9N6BTkisSwpBIGvwFQCOnXVwFI63iK2I7zgq2NSp 3R3vMCZuWmabWuUfQT5zaFs= X-Google-Smtp-Source: AGHT+IHaU9g6mS5pY4mX8saAmOeac8507hIovXWr+LAqqQ8QSN2L0SyW5uPrh1iiLm+rd0wTtqABdA== X-Received: by 2002:a2e:b893:0:b0:2c5:924:e8b1 with SMTP id r19-20020a2eb893000000b002c50924e8b1mr1926970ljp.19.1697551624037; Tue, 17 Oct 2023 07:07:04 -0700 (PDT) X-BeenThere: swupdate@googlegroups.com Received: by 2002:a2e:8e32:0:b0:2bf:f55d:1df9 with SMTP id r18-20020a2e8e32000000b002bff55d1df9ls1708502ljk.1.-pod-prod-05-eu; Tue, 17 Oct 2023 07:07:02 -0700 (PDT) X-Received: by 2002:a2e:b893:0:b0:2c5:924:e8b1 with SMTP id r19-20020a2eb893000000b002c50924e8b1mr1926874ljp.19.1697551622188; Tue, 17 Oct 2023 07:07:02 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1697551622; cv=none; d=google.com; s=arc-20160816; b=LfBmrPJ5WshcSnl+U17igJJI5j1FxXNRIC1ix+Yje21uvKPBRJGY/5Hsr2IvpVV6g2 XuE+a5q3qtgmFQ7qVXGrro5PdnHx1gz6Tq3NFgCR1ln7Cob7toIPhPXrAByo1NtdEQf+ 9md2RE2KgS6xhW8fMbuF1NlJ5cLJ2rcb6AeviE47jCKRr64eT/LfOv0WBsEO7JEx/kQY QnV8N6ForsU9kkkizqlhSejuRMcO/a7F5XgmrwpBZoAk3WkHsunPJOF/v0tZHfApFe0w Urg1w6jvlmqsTGldaJZxDp8zIbOru4SwNExTlwRP07IbtwACi9fET6SvhBMU8vk3gljp Mhbg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=ui-outboundreport:content-transfer-encoding:mime-version:references :in-reply-to:message-id:date:subject:cc:to:from; bh=hmj+1bnnr8sfgFNiD6nz4sdl680C6F5npFanOGRsMDw=; fh=TiEWcqMcKpHk5s7uErzpntoONrNfOXwKpI5P8bIlggk=; b=t6O0GHXxZZZxO82X9kgikjteuKJ/3XGCh+FQsCKkAgFCSk4NRjrHRMH6Id/uU6uVE1 22Mk7GnwCAEkuyQLFabZVzcBA1IEDk+SVpP1EFKwXUjp6bxsjXv40+lvAC0xwjdnL0L4 euAKjIdPgp9b+IMdU7sZAuDJTqy8m7BvLr7UL/5owEUf97hkyApuGFjQNSvDxJmFAR8Z H1tSb/JFMRugqF6T2vl9qa3lqcU71I6Nv8at8hcriotNpAliHEAN0M+Zv+FE9db1f/2n HGKrVUnRmMbtgDSBWY7URpSxa5Df52YaHvmoIqbN7fMxv/s8wIKDWVQa64dI5k4HESv/ lx1g== ARC-Authentication-Results: i=1; gmr-mx.google.com; spf=pass (google.com: domain of stefano.babic@swupdate.org designates 217.72.192.73 as permitted sender) smtp.mailfrom=stefano.babic@swupdate.org Received: from mout.kundenserver.de (mout.kundenserver.de. [217.72.192.73]) by gmr-mx.google.com with ESMTPS id y15-20020a05651c154f00b002c17e2e5fb9si65344ljp.5.2023.10.17.07.07.02 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 17 Oct 2023 07:07:02 -0700 (PDT) Received-SPF: pass (google.com: domain of stefano.babic@swupdate.org designates 217.72.192.73 as permitted sender) client-ip=217.72.192.73; Received: from paperino.fritz.box ([88.217.136.221]) by mrelayeu.kundenserver.de (mreue108 [213.165.67.113]) with ESMTPSA (Nemesis) id 1MJmCV-1r8VG01WeX-00KBg6; Tue, 17 Oct 2023 16:07:01 +0200 From: Stefano Babic To: swupdate@googlegroups.com Cc: Stefano Babic Subject: [swupdate] [PATCH V2 11/11] doc: document the "reboot" attribute Date: Tue, 17 Oct 2023 16:06:57 +0200 Message-Id: <20231017140657.95860-12-stefano.babic@swupdate.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231017140657.95860-1-stefano.babic@swupdate.org> References: <20231017140657.95860-1-stefano.babic@swupdate.org> MIME-Version: 1.0 X-Provags-ID: V03:K1:vlViLnWPddfzRkb45UKz0LqmAb/cKILc0WIxKnJnfu/oIx69B0b QZYyLA/R4CuKx+nb7RLZPwhn7c3rI0ekSelohmbUv8s9OQemPUkL6I27P4XQ0oVCzpNAZln 1G2q3Oi7d3Mk1CtR7PlruIphdu6/runKiirufuv1+QLBJGLN1dPMtETaeSIknBkZ7pJuSFK 8LhPRkJl/A5qSou3lpyKw== X-Spam-Flag: NO UI-OutboundReport: notjunk:1;M01:P0:O2zw6nuIIKM=;w8cE4Od57ViMwIcuSVmyAGDAsBl 8T/i74GGtbeurWbo/KDj57tMEcc6IagNoNPJENC0z5tF2xvZfDxVD/+dk6aCcpeai077N8C4/ NHw9+e2g6SJrqDv2bXJXQMqvLtYXqXPKjIyxfUdpJW4WbH/LD6vizfh4A4yUx10ZCmL8R6Fzz JtofDbbFpeZTkpfRaRwuQpjO/imGR+HSdU4/Eba9Oj2+1Ry0ST+WrzZvQaPA8EdqCQqaE609L ZtPP6ErqTcLTHzaGRdm2wTK8D69NRmP6ZK51lJUFi9zKjJexUsO61W+6BWpo6Qs3nYSHMYWmW L5QDRFNOBv/t1WeSVrcPi+FDxsIUqkDzn/bUwFirZifYLV7xAK8zVz3ZHQJqW9kgY3z9+u5oe aDne4L3TSzi+Dq192w2qz3iZxfF/pMzUTciobS+mLcv6OOUrCZ7LPOmC9rSLTL1YVjREUp31k RLL4iNMRl5dXLWv0gcfL1mVkdzIOYf3ACD5MryzuDaLritmL7nmWYQHExuMuUI0NvC85FWEZg VLZXpRbM8wIy2qxbKlGgSqQ0zcDvuw3/POSaeFwCyzQnoitzj7/ythtCX/v+eMnYAjCU9mCZx NfFfHw7Qw3taaQ8Pbut8ayptIWoJD7PSUr/7YOn9P+lSEDLlsnKBBJN207g2uxvlZvruVz7dU Qsz0KQV6GGyw5b0bX6iGF+ptl6rXZNGS0AUhwq/DQvQWO9FGzcU+b0W9/XcJ5njGrBejoMQhv y4un1siKqz49Tkw3IGvP9hPUxzhzifGv9PkRcyPiUIvG0VWEWMgp+Nhn5FkfAHsLfNzEgfmMa 2Q6iEte1TIXAmGAulClf0PDf3kf/K3Hu4Voub+iq6rW2kT920uzoxAVOL2Lvj/Gd/jW+R6PFS lFd/pcMrT+DYZSBpeaHdPP/c9j/FjWdPLaB8= X-Original-Sender: stefano.babic@swupdate.org X-Original-Authentication-Results: gmr-mx.google.com; spf=pass (google.com: domain of stefano.babic@swupdate.org designates 217.72.192.73 as permitted sender) smtp.mailfrom=stefano.babic@swupdate.org 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: , Signed-off-by: Stefano Babic --- doc/source/sw-description.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/doc/source/sw-description.rst b/doc/source/sw-description.rst index 3b910295..79e80625 100644 --- a/doc/source/sw-description.rst +++ b/doc/source/sw-description.rst @@ -884,6 +884,33 @@ environment variable "ustate" (default) to `STATE_INSTALLED=1` or globally via the `-m` option to SWUpdate or per `sw-description` via the boolean switch "bootloader_state_marker". +reboot flag +----------- + +It is possible to signal that a reboot for a specific update is not required. +This information is evaluated by SWUpdate just to inform a backend about the +transaction result. If a postinstall script (icommand line parameter -p) is +passed at the startup to perform a reboot, it will be executed anyway because +SWUpdate cannot know the nature of this script. + +SWUpdate sends this information to the progress interface and it is duty of the +listeners to interprete the information. The attribute is a boolean: + +:: + + reboot = false; + +Attribute belongs to the general section, where also version belongs. It is +not required to activate the flag with `reboot = true` because it is the +default behavior, so just disabling makes sense. + +The tool `swupdate-progress` interprets the flag: if it was started with +reboot support (-r parameter), it checks if a "no-reboot" message is received +and disables to reboot the device for this specific update. When the transaction +completes, the reboot feature is activated again in case a new update will require to +reboot the device. This allows to have on the fly updates, where not the whole +software is updated and a reboot is not required. + bootloader ---------- @@ -1394,6 +1421,9 @@ There are 4 main sections inside sw-description: | description | string | | user-friendly description of the | | | | | swupdate archive (any string) | +-------------+----------+------------+---------------------------------------+ + | reboot | bool | | allows to disable reboot for the | + | | | | current running update | + +-------------+----------+------------+---------------------------------------+ | install-if\ | bool | images | flag | | -different | | files | if set, name and version are | | | | | compared with the entries in |