diff options
| author | Gatis Paeglis <gatis.paeglis@qt.io> | 2016-06-14 13:44:20 +0200 |
|---|---|---|
| committer | Gatis Paeglis <gatis.paeglis@qt.io> | 2016-06-14 14:22:56 +0000 |
| commit | 5dc9d19ae3c4dfedf336413f7c9f304bca80e34e (patch) | |
| tree | 1f2626f08a0126a7d44cfbee95690216b9e57eff /src | |
| parent | e1aa33dfe777e3610cb40105e086f321605415ab (diff) | |
Move "Remote Configuration" section to API doc.
Later we should use qdoc's "include" feature to
reduce duplicated content.
Change-Id: I6ed70825eb351b8c8176e9ba9ec2c576e473e526
Reviewed-by: Gatis Paeglis <gatis.paeglis@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/imports/pluginmain.cpp | 29 | ||||
| -rw-r--r-- | src/lib/qotaclient.cpp | 31 |
2 files changed, 59 insertions, 1 deletions
diff --git a/src/imports/pluginmain.cpp b/src/imports/pluginmain.cpp index 0fe8a9b..c6ccb25 100644 --- a/src/imports/pluginmain.cpp +++ b/src/imports/pluginmain.cpp @@ -44,6 +44,35 @@ QT_BEGIN_NAMESPACE Using this API is safe and won't leave the system in an inconsistent state, even if the power fails half-way through. + + \note Remote Configuration + + A remote needs to be configured for a device to be able to locate a server + that is hosting an OTA update. A Tech Preview release does not provide Qt API + to configure remotes. To configure a remote, it is necessary to use the ostree + command line tool. Examples for remote configurations: + + No Security: + \badcode + ostree remote add --no-gpg-verify qt-os http://${SERVER_ADDRESS}:${PORT}/ostree-repo linux/qt + \endcode + + Using GPG Signing: + \badcode + ostree remote add --set=gpg-verify=true qt-os http://${SERVER_ADDRESS}:${PORT}/ostree-repo linux/qt + \endcode + + Using TLS Authentication: + \badcode + ostree remote add \ + --tls-client-cert-path /path/client.crt \ + --tls-client-key-path /path/client.key \ + --tls-ca-path /trusted/server.crt qt-os https://${SERVER_ADDRESS}:${PORT}/ostree-repo linux/qt + \endcode + + \c ${SERVER_ADDRESS} - the server where you have exported the OSTree repository. + + \c ${PORT} - port number. */ /*! diff --git a/src/lib/qotaclient.cpp b/src/lib/qotaclient.cpp index 53e4b9c..73a93a2 100644 --- a/src/lib/qotaclient.cpp +++ b/src/lib/qotaclient.cpp @@ -238,13 +238,42 @@ QString QOTAClientPrivate::revision(QueryTarget target) const \inmodule qtotaupdate \brief Main interface to the OTA functionality. - This class provides an API to execute OTA tasks. Offline operations include + QOTAClient provides an API to execute OTA tasks. Offline operations include querying the booted and rollback system version details and atomically performing the rollbacks. Online operations include fetching a new system version from a remote server and atomically performing system updates. Using this API is safe and won't leave the system in an inconsistent state, even if the power fails half-way through. + + \note Remote Configuration + + A remote needs to be configured for a device to be able to locate a server + that is hosting an OTA update. A Tech Preview release does not provide Qt API + to configure remotes. To configure a remote, it is necessary to use the ostree + command line tool. Examples for remote configurations: + + No Security: + \badcode + ostree remote add --no-gpg-verify qt-os http://${SERVER_ADDRESS}:${PORT}/ostree-repo linux/qt + \endcode + + Using GPG Signing: + \badcode + ostree remote add --set=gpg-verify=true qt-os http://${SERVER_ADDRESS}:${PORT}/ostree-repo linux/qt + \endcode + + Using TLS Authentication: + \badcode + ostree remote add \ + --tls-client-cert-path /path/client.crt \ + --tls-client-key-path /path/client.key \ + --tls-ca-path /trusted/server.crt qt-os https://${SERVER_ADDRESS}:${PORT}/ostree-repo linux/qt + \endcode + + \c ${SERVER_ADDRESS} - the server where you have exported the OSTree repository. + + \c ${PORT} - port number. */ /*! |