diff mbox series

[[PATCH] doc: fix wording and the progress program name

Message ID 20210413074150.15600-1-maciej.pijanowski@3mdeb.com
State Accepted
Headers show
Series [[PATCH] doc: fix wording and the progress program name | expand

Commit Message

Maciej Pijanowski April 13, 2021, 7:41 a.m. UTC
Signed-off-by: Maciej Pijanowski <maciej.pijanowski@3mdeb.com>
---
 doc/source/progress.rst     | 2 +-
 doc/source/swupdate-ipc.rst | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Stefano Babic April 13, 2021, 9:41 a.m. UTC | #1
Hi Maciej,

On 13.04.21 09:41, Maciej Pijanowski wrote:
> Signed-off-by: Maciej Pijanowski <maciej.pijanowski@3mdeb.com>
> ---
>   doc/source/progress.rst     | 2 +-
>   doc/source/swupdate-ipc.rst | 6 +++---
>   2 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/source/progress.rst b/doc/source/progress.rst
> index 7604aac82024..465f931dbe64 100644
> --- a/doc/source/progress.rst
> +++ b/doc/source/progress.rst
> @@ -57,6 +57,6 @@ The single fields have the following meaning:
>           - *info* additional information about installation.
>   
>   
> -As an example for a progress client, ``tools/progress.c`` prints the status
> +As an example for a progress client, ``tools/swupdate-progress.c`` prints the status
>   on the console and drives "psplash" to draw a progress bar on a display.
>   
> diff --git a/doc/source/swupdate-ipc.rst b/doc/source/swupdate-ipc.rst
> index a862103ce579..8ce19b50b075 100644
> --- a/doc/source/swupdate-ipc.rst
> +++ b/doc/source/swupdate-ipc.rst
> @@ -60,9 +60,9 @@ will be ignored until a new REQ_INSTALL will be received.
>   
>   It is recommended to use the client library to communicate with SWUpdate. On the lower
>   level with direct socket communication, it cannot be guaranteed that the structures
> -will remain compatible in future. The client library was affected by this issue, too, and it is
> -changed to accept an opaque interface that will survive to API changes. Compatibility
> -layers could be added on bedarf in future due to API changes.
> +will remain compatible in the future. The client library was affected by this issue, too, and it is
> +changed to accept an opaque interface that will survive API changes. Compatibility
> +layers could be added on-demand in the future due to API changes.
>   

Applied to -master, thanks !

Best regards,
Stefano Babic
diff mbox series

Patch

diff --git a/doc/source/progress.rst b/doc/source/progress.rst
index 7604aac82024..465f931dbe64 100644
--- a/doc/source/progress.rst
+++ b/doc/source/progress.rst
@@ -57,6 +57,6 @@  The single fields have the following meaning:
         - *info* additional information about installation.
 
 
-As an example for a progress client, ``tools/progress.c`` prints the status
+As an example for a progress client, ``tools/swupdate-progress.c`` prints the status
 on the console and drives "psplash" to draw a progress bar on a display.
 
diff --git a/doc/source/swupdate-ipc.rst b/doc/source/swupdate-ipc.rst
index a862103ce579..8ce19b50b075 100644
--- a/doc/source/swupdate-ipc.rst
+++ b/doc/source/swupdate-ipc.rst
@@ -60,9 +60,9 @@  will be ignored until a new REQ_INSTALL will be received.
 
 It is recommended to use the client library to communicate with SWUpdate. On the lower
 level with direct socket communication, it cannot be guaranteed that the structures
-will remain compatible in future. The client library was affected by this issue, too, and it is
-changed to accept an opaque interface that will survive to API changes. Compatibility
-layers could be added on bedarf in future due to API changes.
+will remain compatible in the future. The client library was affected by this issue, too, and it is
+changed to accept an opaque interface that will survive API changes. Compatibility
+layers could be added on-demand in the future due to API changes.
 
 
 Client Library