Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ug: Minor fixes in aklite CLI documentation #753

Merged
merged 1 commit into from
Sep 13, 2024
Merged

ug: Minor fixes in aklite CLI documentation #753

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions source/user-guide/custom-sota-client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,18 +106,18 @@
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 @@

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 @@

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
Loading