diff mbox series

Fix documentation after renaming tools binaries

Message ID 20191101124744.12421-1-sbabic@denx.de
State Accepted
Headers show
Series Fix documentation after renaming tools binaries | expand

Commit Message

Stefano Babic Nov. 1, 2019, 12:47 p.m. UTC
Tools binaries change name and documentation must be fixed.

Signed-off-by: Stefano Babic <sbabic@denx.de>
---
 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 mbox series

Patch

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] <image .swu to be installed>...
+swupdate-client [OPTIONS] <image .swu to be installed>...
 
 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 <polling time>
+swupdate-hawkbitcfg <polling time>
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 <action id> <status> <finished> <execution> <detail 1> <detail 2> ..
+swupdate-sendtohawkbit <action id> <status> <finished> <execution> <detail 1> <detail 2> ..
 
 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>
+        path to progress IPC socket