[PATCH] doc: update references to code examples

[Diego Rondini]

Fix references to removed files and clarify that tools/swupdate-ipc.c
uses direct socket access while tools/swupdate-client.c uses the client
library.

Signed-off-by: Diego Rondini <diego....@kynetics.com>
---
doc/source/swupdate-ipc-interface.rst | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/doc/source/swupdate-ipc-interface.rst b/doc/source/swupdate-ipc-interface.rst
index debf3040..904a4e4f 100644
--- a/doc/source/swupdate-ipc-interface.rst
+++ b/doc/source/swupdate-ipc-interface.rst
@@ -35,8 +35,9 @@ is determined by
- ``/tmp/sockinstctrl``,

in this order, and taken over from systemd or created by SWUpdate.
-This socket should, however, not be used directly but instead by the Client
-Library explained below.
+An example using the direct socket approach is in `tools/swupdate-ipc.c`.
+The recommended approach though is to use the
+:ref:`Client Library <client_library>`.

The exchanged packets are described in network_ipc.h

@@ -75,6 +76,8 @@ changed to accept an opaque interface that will survive API changes. Compatibili
layers could be added on-demand in the future due to API changes.


+.. _client_library:
+
Client Library
==============

@@ -104,7 +107,7 @@ how upgrade is going on. It can be omitted if only the result is required.
The terminated call-back is called when SWUpdate has finished with the result
of the upgrade.

-Example about using this library is in the examples/client directory.
+An example using this library is in `tools/swupdate-client.c`.

The `req` structure is casted to void to ensure API compatibility. A user
should instantiate it as `struct swupdate_request`. This contains fields that can control
@@ -274,8 +277,6 @@ provided as ISO 8601 date and time string. (2021-10-14T13:42:37.000+00)
}
}

-An example application can be found under tools/swupdate-gethawkbitstatus.c
-
API to the integrated Webserver
===============================

--
2.54.0

[Stefano Babic]

Hi Diego,

Applied to -master, thanks !

Best regards,
Stefano Babic

--
_______________________________________________________________________
Nabla Software Engineering GmbH
Hirschstr. 111A | 86156 Augsburg | Tel: +49 821 45592596
Geschäftsführer : Stefano Babic | HRB 40522 Augsburg
E-Mail: sba...@nabladev.com