Skip to content

Commit

Permalink
ug: Minor fixes in aklite CLI documentation
Browse files Browse the repository at this point in the history 
Signed-off-by: Andre Detsch <[email protected]>
  • Loading branch information
@detsch
detsch committed Sep 12, 2024
1 parent 4e459db commit 9baa24c
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions source/user-guide/custom-sota-client.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,18 +106,18 @@ In addition to the default daemon mode, users can run it as a CLI utility and pe
Command Line Interface - CLI (Aktualizr-lite Manual Mode)
---------------------------------------------------------

The `aktualizr-lite` executable can be invoked to perform individual operations allowing more control over the update flow.
The ``aktualizr-lite`` executable can be invoked to perform individual operations allowing more control over the update flow.

.. warning:: The Command Line Interface is on beta stage,
.. warning:: The Command Line Interface is in beta stage,
and is subject to change over the next releases.

.. note:: In order to use the run individual `aktualizr-lite` commands,
the `aktualizr-lite` service needs to be stopped with ``sudo systemctl stop aktualizr-lite``
the ``aktualizr-lite`` service needs to be stopped with ``sudo systemctl stop aktualizr-lite``
and/or disabled with ``sudo systemctl disable aktualizr-lite``.

.. note:: If lmp-device-register is used,
the `--start-daemon 0` is recommended
in order to avoid starting aktualizr-lite daemon automatically.
Using ``--start-daemon 0`` is recommended
in order to avoid starting the aktualizr-lite daemon automatically.

.. prompt::

Expand Down Expand Up @@ -151,8 +151,8 @@ To view the current status of the device::

sudo aktualizr-lite status

Fetch TUF Metadata and List Updates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Fetch :term:`TUF` Metadata and List Updates

Check warning on line 154 in source/user-guide/custom-sota-client.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.expand-acronyms] 'TUF' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.

Raw Output:
{"message": "[Fio-docs.expand-acronyms] 'TUF' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/user-guide/custom-sota-client.rst", "range": {"start": {"line": 154, "column": 14}}}, "severity": "WARNING"}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``check`` command will refresh the Targets metadata from the OTA server,
and present you with a list of available Targets::
Expand All @@ -178,7 +178,7 @@ This includes both OSTree and Docker app Targets::

sudo aktualizr-lite update

To update to a specific build number or target name,
To update to a specific build number or Target name,
the ``--update-name`` option can be used::

sudo aktualizr-lite update --update-name <build_number_or_name>
Expand Down

0 comments on commit 9baa24c

Please sign in to comment.