github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-23 14:07:42 +00:00
Code Issues Projects Releases Wiki Activity

doc: update acrnd/acrnctl option docs

Browse Source 
Document the acrnd -t, and acrnctl add -C options, noted as missing in
PR #3137

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2019-06-21 10:27:40 -07:00 committed by David Kinder
parent 217145e33b
commit 0dc8c179e6
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
tools/acrn-manager/README.rst
View File

@ -14,7 +14,7 @@ on ``acrn-dm``. The daemon for acrn-manager is `acrnd`_.
Usage Usage
***** =====
You can see the available ``acrnctl`` commands by running: You can see the available ``acrnctl`` commands by running:
@ -48,6 +48,11 @@ script that will launch a UOS, for example ``launch_UOS.sh``:
# acrnctl add launch_UOS.sh -U 1 # acrnctl add launch_UOS.sh -U 1
vm1-14:59:30 added vm1-14:59:30 added
If a ``-C`` option is also specified, the VM is launched in a runC
container::
# acrnctl add launch_UOS.sh -C
Note that the launch script must only launch one UOS instance. Note that the launch script must only launch one UOS instance.
The VM name is important. ``acrnctl`` searches VMs by their The VM name is important. ``acrnctl`` searches VMs by their
names so duplicate VM names are not allowed. If the names so duplicate VM names are not allowed. If the
@ -124,6 +129,24 @@ The ``acrnd`` daemon process provides a way for launching or resuming a UOS
should the UOS shut down, either planned or unexpected. A UOS can ask ``acrnd`` should the UOS shut down, either planned or unexpected. A UOS can ask ``acrnd``
to set up a timer to make sure the UOS is running, even if the SOS is to set up a timer to make sure the UOS is running, even if the SOS is
suspended or stopped. suspended or stopped.
Usage
=====
You can see the available ``acrnd`` commands by running:
.. code-block:: none
$ acrnd -h
acrnd - Deamon for ACRN VM Management
[Usage] acrnd [-t] [-d delay] [-h]
-h: print this message
-t: print messages to stdout
Normally, ``acrnd`` runs silently (messages are directed to
``/dev/null``). Use the ``-t`` option to direct messages to stdout,
useful for debugging.
The ``acrnd`` daemon stores pending UOS work to ``/usr/share/acrn/conf/timer_list`` The ``acrnd`` daemon stores pending UOS work to ``/usr/share/acrn/conf/timer_list``
and sets an RTC timer to wake up the SOS or bring the SOS back up again. and sets an RTC timer to wake up the SOS or bring the SOS back up again.
When ``acrnd`` daemon is restarted, it restores the previously saved timer When ``acrnd`` daemon is restarted, it restores the previously saved timer