| Message ID | 20200420083628.38854-1-christian.storm@siemens.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series | doc: swupdate-* tool documentation fixes | expand |
On 20.04.20 10:36, Christian Storm wrote: > Signed-off-by: Christian Storm <christian.storm@siemens.com> > --- > doc/source/swupdate-client.rst | 38 +++++++++++++-------------- > doc/source/swupdate-hawkbitcfg.rst | 13 +++++---- > doc/source/swupdate-progress.rst | 12 ++++----- > doc/source/swupdate-sendtohawkbit.rst | 19 ++++++++------ > doc/source/swupdate-sysrestart.rst | 4 +-- > 5 files changed, 44 insertions(+), 42 deletions(-) > > diff --git a/doc/source/swupdate-client.rst b/doc/source/swupdate-client.rst > index 5eaf00b..a454979 100644 > --- a/doc/source/swupdate-client.rst > +++ b/doc/source/swupdate-client.rst > @@ -1,26 +1,26 @@ > -client > -====== > +swupdate-client > +=============== > > -client is a small tool that sends a SWU image to a running instance > -of SWUpdate. It can be used if the update package (SWU) is downloaded > -by another application external to SWUpdate. It is an example how to > -use the IPC to forward an image to SWUpdate. > +swupdate-client is a small tool that sends a SWU image to a running instance of > +SWUpdate. It can be used if the update package (SWU) is downloaded by another > +application external to SWUpdate. It is an example how to use the IPC to forward > +an image to SWUpdate. > > -SYNOPYS > -------- > +SYNOPSIS > +-------- > > -swupdate-client [OPTIONS] <image .swu to be installed>... > +swupdate-client [OPTIONS] <image.swu to be installed>... > > DESCRIPTION > ----------- > > - -h > - print help and exit > - -d > - ask the server to only perform a dryrun > - -q > - go quite, resets verbosity > - -v > - go verbose, essentially print upgrade status messages from server > - -p > - ask the server to run post-update commands if upgrade succeeds > +-h > + print help and exit > +-d > + ask the server to only perform a dry-run > +-q > + go quiet, resets verbosity > +-v > + go verbose, essentially print upgrade status messages from server > +-p > + ask the server to run post-update commands if upgrade succeeds > diff --git a/doc/source/swupdate-hawkbitcfg.rst b/doc/source/swupdate-hawkbitcfg.rst > index 2c13382..25f9552 100644 > --- a/doc/source/swupdate-hawkbitcfg.rst > +++ b/doc/source/swupdate-hawkbitcfg.rst > @@ -1,15 +1,14 @@ > -hawkbitcfg > -============= > +swupdate-hawkbitcfg > +=================== > > -sendtohawkbit is a small tool that tries to connect to a running instance > -of SWUpdate and configures Hawkbit's parameter. > +swupdate-hawkbitcfg is a small tool that tries to connect to a running instance > +of SWUpdate and configures hawkBit's parameter. > > -SYNOPYS > -------- > +SYNOPSIS > +-------- > > swupdate-hawkbitcfg [option] > > - > DESCRIPTION > ----------- > > diff --git a/doc/source/swupdate-progress.rst b/doc/source/swupdate-progress.rst > index 10178fa..2f21891 100644 > --- a/doc/source/swupdate-progress.rst > +++ b/doc/source/swupdate-progress.rst > @@ -1,11 +1,11 @@ > -progress > -======== > +swupdate-progress > +================= > > -progress that tries to connect to a running instance > +swupdate-progress tries to connect to a running instance > of SWUpdate to get the status of a running update. > > -SYNOPYS > -------- > +SYNOPSIS > +-------- > > swupdate-progress [option] > > @@ -13,7 +13,7 @@ DESCRIPTION > ----------- > > swupdate-progress is an example how to connect to SWUpdate via the progress interface. > -It shows on the stdout a simple bar with the procent indication of the current update > +It shows on stdout a simple bar with the percent indication of the current update > and reports the result of the update. It can optionally drive "psplash" or execute a script > after an update. > > diff --git a/doc/source/swupdate-sendtohawkbit.rst b/doc/source/swupdate-sendtohawkbit.rst > index ddb0824..02e00d1 100644 > --- a/doc/source/swupdate-sendtohawkbit.rst > +++ b/doc/source/swupdate-sendtohawkbit.rst > @@ -1,15 +1,18 @@ > swupdate-sendtohawkbit > ====================== > > -swupdate-sendtohawkbit is a small tool that tries to connect to a running instance > -of SWUpdate and uses it as proxy to send data to the Hawkbit Server. > -A typical use case is after a new software was installed but it is > -required the acknowledge by an application or by an operator to activate it. > -The tool can forward the result for the activation to the Hawkbit server. > +swupdate-sendtohawkbit is a small tool that tries to connect to a running > +instance of SWUpdate and uses it as proxy to send data to the hawkBit Server. > +A typical use case is acknowledgement for activation by an application or > +operator after a new software has been installed. The tool can forward the > +result for the activation to the hawkBit server. > > -DESCRIPTION > ------------ > +SYNOPSIS > +-------- > > swupdate-sendtohawkbit <action id> <status> <finished> <execution> <detail 1> <detail 2> .. > > -See Hawkbit API to get more info on the single fields. > +DESCRIPTION > +----------- > + > +See hawkBit API to get more information on the parameters. > diff --git a/doc/source/swupdate-sysrestart.rst b/doc/source/swupdate-sysrestart.rst > index 7e89211..87eae52 100644 > --- a/doc/source/swupdate-sysrestart.rst > +++ b/doc/source/swupdate-sysrestart.rst > @@ -4,8 +4,8 @@ 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 > -------- > +SYNOPSIS > +-------- > > swupdate-sysrestart [option] > > Acked-by : Stefano Babic <sbabic@denx.de> Best regards, Stefano Babic
diff --git a/doc/source/swupdate-client.rst b/doc/source/swupdate-client.rst index 5eaf00b..a454979 100644 --- a/doc/source/swupdate-client.rst +++ b/doc/source/swupdate-client.rst @@ -1,26 +1,26 @@ -client -====== +swupdate-client +=============== -client is a small tool that sends a SWU image to a running instance -of SWUpdate. It can be used if the update package (SWU) is downloaded -by another application external to SWUpdate. It is an example how to -use the IPC to forward an image to SWUpdate. +swupdate-client is a small tool that sends a SWU image to a running instance of +SWUpdate. It can be used if the update package (SWU) is downloaded by another +application external to SWUpdate. It is an example how to use the IPC to forward +an image to SWUpdate. -SYNOPYS -------- +SYNOPSIS +-------- -swupdate-client [OPTIONS] <image .swu to be installed>... +swupdate-client [OPTIONS] <image.swu to be installed>... DESCRIPTION ----------- - -h - print help and exit - -d - ask the server to only perform a dryrun - -q - go quite, resets verbosity - -v - go verbose, essentially print upgrade status messages from server - -p - ask the server to run post-update commands if upgrade succeeds +-h + print help and exit +-d + ask the server to only perform a dry-run +-q + go quiet, resets verbosity +-v + go verbose, essentially print upgrade status messages from server +-p + ask the server to run post-update commands if upgrade succeeds diff --git a/doc/source/swupdate-hawkbitcfg.rst b/doc/source/swupdate-hawkbitcfg.rst index 2c13382..25f9552 100644 --- a/doc/source/swupdate-hawkbitcfg.rst +++ b/doc/source/swupdate-hawkbitcfg.rst @@ -1,15 +1,14 @@ -hawkbitcfg -============= +swupdate-hawkbitcfg +=================== -sendtohawkbit is a small tool that tries to connect to a running instance -of SWUpdate and configures Hawkbit's parameter. +swupdate-hawkbitcfg is a small tool that tries to connect to a running instance +of SWUpdate and configures hawkBit's parameter. -SYNOPYS -------- +SYNOPSIS +-------- swupdate-hawkbitcfg [option] - DESCRIPTION ----------- diff --git a/doc/source/swupdate-progress.rst b/doc/source/swupdate-progress.rst index 10178fa..2f21891 100644 --- a/doc/source/swupdate-progress.rst +++ b/doc/source/swupdate-progress.rst @@ -1,11 +1,11 @@ -progress -======== +swupdate-progress +================= -progress that tries to connect to a running instance +swupdate-progress tries to connect to a running instance of SWUpdate to get the status of a running update. -SYNOPYS -------- +SYNOPSIS +-------- swupdate-progress [option] @@ -13,7 +13,7 @@ DESCRIPTION ----------- swupdate-progress is an example how to connect to SWUpdate via the progress interface. -It shows on the stdout a simple bar with the procent indication of the current update +It shows on stdout a simple bar with the percent indication of the current update and reports the result of the update. It can optionally drive "psplash" or execute a script after an update. diff --git a/doc/source/swupdate-sendtohawkbit.rst b/doc/source/swupdate-sendtohawkbit.rst index ddb0824..02e00d1 100644 --- a/doc/source/swupdate-sendtohawkbit.rst +++ b/doc/source/swupdate-sendtohawkbit.rst @@ -1,15 +1,18 @@ swupdate-sendtohawkbit ====================== -swupdate-sendtohawkbit is a small tool that tries to connect to a running instance -of SWUpdate and uses it as proxy to send data to the Hawkbit Server. -A typical use case is after a new software was installed but it is -required the acknowledge by an application or by an operator to activate it. -The tool can forward the result for the activation to the Hawkbit server. +swupdate-sendtohawkbit is a small tool that tries to connect to a running +instance of SWUpdate and uses it as proxy to send data to the hawkBit Server. +A typical use case is acknowledgement for activation by an application or +operator after a new software has been installed. The tool can forward the +result for the activation to the hawkBit server. -DESCRIPTION ------------ +SYNOPSIS +-------- swupdate-sendtohawkbit <action id> <status> <finished> <execution> <detail 1> <detail 2> .. -See Hawkbit API to get more info on the single fields. +DESCRIPTION +----------- + +See hawkBit API to get more information on the parameters. diff --git a/doc/source/swupdate-sysrestart.rst b/doc/source/swupdate-sysrestart.rst index 7e89211..87eae52 100644 --- a/doc/source/swupdate-sysrestart.rst +++ b/doc/source/swupdate-sysrestart.rst @@ -4,8 +4,8 @@ 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 -------- +SYNOPSIS +-------- swupdate-sysrestart [option]
Signed-off-by: Christian Storm <christian.storm@siemens.com> --- doc/source/swupdate-client.rst | 38 +++++++++++++-------------- doc/source/swupdate-hawkbitcfg.rst | 13 +++++---- doc/source/swupdate-progress.rst | 12 ++++----- doc/source/swupdate-sendtohawkbit.rst | 19 ++++++++------ doc/source/swupdate-sysrestart.rst | 4 +-- 5 files changed, 44 insertions(+), 42 deletions(-)