From patchwork Fri Nov 1 12:47:44 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stefano Babic X-Patchwork-Id: 1187992 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::53a; helo=mail-ed1-x53a.google.com; envelope-from=swupdate+bncbcxploxj6ikrb3wt6dwqkgqeio2gumi@googlegroups.com; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=denx.de Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=googlegroups.com header.i=@googlegroups.com header.b="bAzhbp60"; dkim-atps=neutral Received: from mail-ed1-x53a.google.com (mail-ed1-x53a.google.com [IPv6:2a00:1450:4864:20::53a]) (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 474MTw5BGbz9sRH for ; Fri, 1 Nov 2019 23:49:55 +1100 (AEDT) Received: by mail-ed1-x53a.google.com with SMTP id j21sf6371533edv.20 for ; Fri, 01 Nov 2019 05:49:54 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1572612590; cv=pass; d=google.com; s=arc-20160816; b=pE4DL+NzkuN+j4bk1kAsPRTaltKRKBm2zO37hRCpemzU+WWjO/BvWHnNBcevWT5XXq 1Mwa0sjhFk7kZPTU7iTJklNqBzXCXU/F73EOOKW05VzqMPafpZDAgJvhaPPZblj+QAPc 6rTGyjt8f/0f6ef3aJpIEDfhB0euAgCVzZGlChbisHCMEKiatfJEL/hG/KFiNSU9tqAy PKs5ley9dbhNbgzbQduzR/pYyZD6AhhycGsN9QEUNMtyf6wZhnpnH9bqGNJB2i4grYHW J13WaaQB2NVDsX22qro5pbCmzkNOY1siXLQB9XySjnSqWdoR2zZZ8722kqwKoYBpzepx uF6w== 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:message-id:date:subject:cc:to:from :mime-version:sender:dkim-signature; bh=S3Y8TKBgVT2MdayvR2Ao1kvYcr8Pwy5wpCShN9q1+O0=; b=FqLrXwrfnm3jVYQ7e6S3QJ56WtJO5AEnF/PqCXgNVYg4l88G8SZEsJIri+uIJXhZ3+ zsMvHUsEP2IUr6cUF2ypMnmhf9jleTPdhV9SMYHoaDMx8po0qf7cbrkfgKsgCWi7QCuC XXgjvsh59ooWZD8ispxosowcg8rkQv7JLd3GHe8WqSN7pcF4GbB+hYipg+M75aNrfKfy wpDQcHhGyHrI1B+pB15bf01Q82fOtNpcUPBIK6C1tXPIPSkTU5dMaBfLpG9mo5t7bbk8 uOZwoFLlJAbVyBt86dppAD0t3zq3ie//RWaF9wz8yFpKRYDbDZ8RXTqULX0Ov5ey+qQy U5SA== ARC-Authentication-Results: i=2; gmr-mx.google.com; spf=neutral (google.com: 212.18.0.9 is neither permitted nor denied by best guess record for domain of sbabic@denx.de) smtp.mailfrom=sbabic@denx.de DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20161025; h=sender:mime-version:from:to:cc:subject:date:message-id :x-original-sender:x-original-authentication-results:precedence :mailing-list:list-id:list-post:list-help:list-archive :list-subscribe:list-unsubscribe; bh=S3Y8TKBgVT2MdayvR2Ao1kvYcr8Pwy5wpCShN9q1+O0=; b=bAzhbp60XgiXqOs4jTpODNNVmvIGws4Eb9f0nHMKCxHt9HklYhD8FZng6S25E4I/Fo oUQeh9XisdyROfpJ4sBLNKtQXCvjKwnBR6kXaDafyB+aYVS1CXX0yo1Qk0MsSmw5lWDB EflFyyoeGXwbr0aHmvcG03DbKkBZ+2UtKjBUupTpIhqzGuCuIRaKSi2fUlR+O4/gWWin jYX15kvDL41txuQRsZj5UlGhqmcOLWvtfIlqV5FWnQIL23wd5XeZie4aRUBneufmySgu gvFI5jcqBF//8ymQAskZOx0YeHIgRzNBJA0tDZaDhafYik2RLENBkhjNYIUsrPSmYVR2 oDGA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=sender:x-gm-message-state:mime-version:from:to:cc:subject:date :message-id:x-original-sender:x-original-authentication-results :precedence:mailing-list:list-id:x-spam-checked-in-group:list-post :list-help:list-archive:list-subscribe:list-unsubscribe; bh=S3Y8TKBgVT2MdayvR2Ao1kvYcr8Pwy5wpCShN9q1+O0=; b=Li2P5s8EBTCbgD9MpxfNaKMiYQlHoAJNSOLq1FvXaf1zox+Rc3pg2LTELy2u9AsRfW yaqoOpfhAdjE8JXwNGXnwISy8XJ2LZXWFvPxTaHy4bgmejQIafUzhO60B1r6suwxLfMT UxWPzehEBbYKRh2yrJK7i+T4D806YtXgkpwDp0qbEl7n35deJE08YJD6q8M/zio3QSih QEL4FG94fyR1qfNpsNMzviu/WvwtHpZ+cQjoF/VkMT4x2SSLUozrzS9644tJfC/ofRSj Zuww0fyxQPJ5z70prNxl/UH/ZGrOCTGocFoc/xBUXJ3UgZG/Qc5Sq6ILMdNpi3G0ibVD ad/Q== Sender: swupdate@googlegroups.com X-Gm-Message-State: APjAAAUkML73WrJYgX2V8UM0ka5DBoTXPgdLCGYs/cyrkp2MrLkzwE7r cx+CudQM8ycqXRKiUo7ObYU= X-Google-Smtp-Source: APXvYqxoWWHhKtBKyxCwcDY9xnhKORZuoBGtonqmMS910pcTpPMXj45aBYRuhREP0+18NBgckUtPrQ== X-Received: by 2002:a50:9930:: with SMTP id k45mr12336657edb.134.1572612590570; Fri, 01 Nov 2019 05:49:50 -0700 (PDT) MIME-Version: 1.0 X-BeenThere: swupdate@googlegroups.com Received: by 2002:a05:6402:64b:: with SMTP id u11ls999687edx.16.gmail; Fri, 01 Nov 2019 05:49:49 -0700 (PDT) X-Received: by 2002:aa7:c645:: with SMTP id z5mr12496120edr.204.1572612589963; Fri, 01 Nov 2019 05:49:49 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1572612589; cv=none; d=google.com; s=arc-20160816; b=u6cB1qB8GsXforD0T14tIxKa/f/wehdcGykMrzQBmZPcXXHcputKmILq9T2l9L7BtA QjlnB/RaDbsRgTWSWI6vunQwHK11CtlZURynfoanq81WsPbVWcYlD2TAe5I2PLZnt3O7 NkW2Trzo7NArJbIN74hjr7DS5SRb8nm7jvY22L+TyCo8KF1+V1nl+rVO+JppF8LTKycT ImfNQR1thQw84wM14JbX7YeZXA8T60I2fiOcl0tH50WSKxDnx+RvPV+0zBeV3936CeOD 52RAeY262ndwLiN6ooRTNjKMUiQraDbI6Y1W3UeS/m4GdYiz6DaRHmfG6HSevJ4W0M7K 2P5Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=message-id:date:subject:cc:to:from; bh=cgH4YY2keXeTxvsELEFNtrg6+N6g0WnjgMgnO83B5zM=; b=H/9WuoK9GI2lC4fDxOR/dbeo3SdWfQOxNIWSyaeJnNZGBE3eOLnqXll8Lhqi2uld/L WxHoldbC19SNZwpr2CYHAAkTsHSVPFT8Tq9qgsF2YGAxpuduOWcDaV5rH0mRmV9NhYS+ sXm9GQ58NpIYhHxJsiwp6+qx7t1ybX8azLe2cpBuICCzxDdnX/lKLQ2TDiW58FqjBHC5 MTZw/g1Pt//DeZe9J1jju8xvJWS3SFjTZxAJU/W1YjTzx53LktanemOQEJsGGtnRsCra g9U+bJ0Dyp3MYTDvpdRT6/DAQyaTooFSK3rWvpfe2vvm/m0T+R4vT5EJg9RbqBFzjkLR penQ== ARC-Authentication-Results: i=1; gmr-mx.google.com; spf=neutral (google.com: 212.18.0.9 is neither permitted nor denied by best guess record for domain of sbabic@denx.de) smtp.mailfrom=sbabic@denx.de Received: from mail-out.m-online.net (mail-out.m-online.net. [212.18.0.9]) by gmr-mx.google.com with ESMTPS id z18si428203edd.5.2019.11.01.05.49.49 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 01 Nov 2019 05:49:49 -0700 (PDT) Received-SPF: neutral (google.com: 212.18.0.9 is neither permitted nor denied by best guess record for domain of sbabic@denx.de) client-ip=212.18.0.9; Received: from frontend01.mail.m-online.net (unknown [192.168.8.182]) by mail-out.m-online.net (Postfix) with ESMTP id 474MTn48Bzz1qwLm; Fri, 1 Nov 2019 13:49:49 +0100 (CET) Received: from localhost (dynscan1.mnet-online.de [192.168.6.70]) by mail.m-online.net (Postfix) with ESMTP id 474MTn3x0Cz1qqkJ; Fri, 1 Nov 2019 13:49:49 +0100 (CET) X-Virus-Scanned: amavisd-new at mnet-online.de Received: from mail.mnet-online.de ([192.168.8.182]) by localhost (dynscan1.mail.m-online.net [192.168.6.70]) (amavisd-new, port 10024) with ESMTP id MDI9IN3nUxv6; Fri, 1 Nov 2019 13:49:48 +0100 (CET) Received: from babic.homelinux.org (host-88-217-136-221.customer.m-online.net [88.217.136.221]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.mnet-online.de (Postfix) with ESMTPS; Fri, 1 Nov 2019 13:49:48 +0100 (CET) Received: from localhost (mail.babic.homelinux.org [127.0.0.1]) by babic.homelinux.org (Postfix) with ESMTP id 255DE45405F3; Fri, 1 Nov 2019 13:49:48 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at babic.homelinux.org Received: from babic.homelinux.org ([IPv6:::1]) by localhost (mail.babic.homelinux.org [IPv6:::1]) (amavisd-new, port 10024) with ESMTP id BUYeJ0zSrpcM; Fri, 1 Nov 2019 13:49:45 +0100 (CET) Received: from localhost.localdomain (papero.fritz.box [192.168.178.132]) by babic.homelinux.org (Postfix) with ESMTP id 7110D4540311; Fri, 1 Nov 2019 13:49:45 +0100 (CET) From: Stefano Babic To: swupdate@googlegroups.com Cc: Stefano Babic Subject: [swupdate] [PATCH] Fix documentation after renaming tools binaries Date: Fri, 1 Nov 2019 13:47:44 +0100 Message-Id: <20191101124744.12421-1-sbabic@denx.de> X-Mailer: git-send-email 2.17.1 X-Original-Sender: sbabic@denx.de X-Original-Authentication-Results: gmr-mx.google.com; spf=neutral (google.com: 212.18.0.9 is neither permitted nor denied by best guess record for domain of sbabic@denx.de) smtp.mailfrom=sbabic@denx.de 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: , Tools binaries change name and documentation must be fixed. Signed-off-by: Stefano Babic --- doc/source/index.rst | 9 +++++---- .../{client.rst => swupdate-client.rst} | 2 +- ...hawkbitcfg.rst => swupdate-hawkbitcfg.rst} | 2 +- ...ate_progress.rst => swupdate-progress.rst} | 2 +- ...hawkbit.rst => swupdate-sendtohawkbit.cfg} | 2 +- doc/source/swupdate-sysrestart.rst | 20 +++++++++++++++++++ 6 files changed, 29 insertions(+), 8 deletions(-) rename doc/source/{client.rst => swupdate-client.rst} (91%) rename doc/source/{hawkbitcfg.rst => swupdate-hawkbitcfg.rst} (86%) rename doc/source/{swupdate_progress.rst => swupdate-progress.rst} (92%) rename doc/source/{sendtohawkbit.rst => swupdate-sendtohawkbit.cfg} (83%) create mode 100644 doc/source/swupdate-sysrestart.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 655a742..eb653db 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -52,10 +52,11 @@ Utilities and tools .. toctree:: :maxdepth: 2 - client.rst - hawkbitcfg.rst - sendtohawkbit.rst - swupdate_progress.rst + swupdate-client.rst + swupdate-hawkbitcfg.rst + swupdate-sendtohawkbit.rst + swupdate-progress.rst + swupdate-sysrestart.rst ############################################ Help and support diff --git a/doc/source/client.rst b/doc/source/swupdate-client.rst similarity index 91% rename from doc/source/client.rst rename to doc/source/swupdate-client.rst index 40ec4d3..5eaf00b 100644 --- a/doc/source/client.rst +++ b/doc/source/swupdate-client.rst @@ -9,7 +9,7 @@ use the IPC to forward an image to SWUpdate. SYNOPYS ------- -client [OPTIONS] ... +swupdate-client [OPTIONS] ... DESCRIPTION ----------- diff --git a/doc/source/hawkbitcfg.rst b/doc/source/swupdate-hawkbitcfg.rst similarity index 86% rename from doc/source/hawkbitcfg.rst rename to doc/source/swupdate-hawkbitcfg.rst index 27f7e78..70b8ea5 100644 --- a/doc/source/hawkbitcfg.rst +++ b/doc/source/swupdate-hawkbitcfg.rst @@ -8,4 +8,4 @@ is supported. DESCRIPTION ----------- -hawkbitcfg +swupdate-hawkbitcfg diff --git a/doc/source/swupdate_progress.rst b/doc/source/swupdate-progress.rst similarity index 92% rename from doc/source/swupdate_progress.rst rename to doc/source/swupdate-progress.rst index ff1bb56..e230df8 100644 --- a/doc/source/swupdate_progress.rst +++ b/doc/source/swupdate-progress.rst @@ -7,7 +7,7 @@ of SWUpdate to get the status of a running update. SYNOPYS ------- -progress [option] +swupdate-progress [option] DESCRIPTION ----------- diff --git a/doc/source/sendtohawkbit.rst b/doc/source/swupdate-sendtohawkbit.cfg similarity index 83% rename from doc/source/sendtohawkbit.rst rename to doc/source/swupdate-sendtohawkbit.cfg index 569fc4b..1cee228 100644 --- a/doc/source/sendtohawkbit.rst +++ b/doc/source/swupdate-sendtohawkbit.cfg @@ -10,6 +10,6 @@ The tool can forward the result for the activation to the Hawkbit server. DESCRIPTION ----------- -sendtohawkbit .. +swupdate-sendtohawkbit .. See Hawkbit API to get more info on the single fields. diff --git a/doc/source/swupdate-sysrestart.rst b/doc/source/swupdate-sysrestart.rst new file mode 100644 index 0000000..9dee08f --- /dev/null +++ b/doc/source/swupdate-sysrestart.rst @@ -0,0 +1,20 @@ +swupdate-sysrestart +=================== + +swupdate-sysrestart is a restart controller. It checks the update status +and in case of success, it reboots all devices that were updated. + +SYNOPYS +------- + +swupdate-progress [option] + +DESCRIPTION +----------- + +-r + optionally reboot the target after a successful update +-w + waits for a SWUpdate connection instead of exit with error +-s + path to progress IPC socket