OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: terminology cleanup in acrnlog readme 

- Replace SOS with Service VM
- Update file paths to acrnlog directory
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
This commit is contained in:
Amy Reyes 2021-10-25 10:38:02 -07:00 committed by David Kinder
parent dde617fa49
commit fc064cfa79
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
misc/debug_tools/acrn_log/README.rst
View File

@ -6,11 +6,11 @@ Acrnlog
Description Description
*********** ***********
``acrnlog`` is a userland tool used to capture a ACRN hypervisor log. It runs as an ``acrnlog`` is a userland tool used to capture an ACRN hypervisor log. It runs
SOS service at boot, capturing two kinds of logs: as a Service VM service at boot, capturing two kinds of logs:
- log of the currently running hypervisor - log of the currently running hypervisor
- log of last running hypervisor if it crashed and the logs remain. - log of the last running hypervisor if it crashed and the logs remain
Log files are saved in ``/tmp/acrnlog/``, so the log files would be lost Log files are saved in ``/tmp/acrnlog/``, so the log files would be lost
after a system reset. after a system reset.
@ -51,8 +51,8 @@ steps:
# acrnlog -n 8 -s 4 & # acrnlog -n 8 -s 4 &
You can use ``loglevel`` command in the hypervisor shell (not the Service You can use the ``loglevel`` command in the hypervisor shell (not the Service
OS shell) to query and change the hypervisor log level. VM shell) to query and change the hypervisor log level.
The ``mem_loglevel`` parameter controls the log to be saved using The ``mem_loglevel`` parameter controls the log to be saved using
``acrnlog``, while the ``console_loglevel`` parameter controls the log ``acrnlog``, while the ``console_loglevel`` parameter controls the log
@ -71,7 +71,7 @@ can use these commands:
Permanent Log File Changes Permanent Log File Changes
========================== ==========================
You can also permanently change the log file settings by You can permanently change the log file settings by
editing ``/usr/lib/systemd/system/acrnlog.service`` and use the ``-n`` editing ``/usr/lib/systemd/system/acrnlog.service`` and use the ``-n``
and ``-s`` options on the ``ExecStart`` cmd, and restart the service. and ``-s`` options on the ``ExecStart`` cmd, and restart the service.
For example, ``acrnlog.service`` could have these parameters added: For example, ``acrnlog.service`` could have these parameters added:
@ -90,15 +90,15 @@ and then restart the service with:
Build and Install Build and Install
***************** *****************
Source code for the ``acrnlog`` tools is in the ``tools/acrnlog`` Source code for the ``acrnlog`` tool is in the ``misc/debug_tools/acrn_log``
folder. Build and install the tools from source using: directory. To build and install the tool from source, run these commands:
.. code-block:: none .. code-block:: none
# make # make
# make install # make install
and if you changed the ``acrnlog.service`` file, install it using: and if you changed the ``acrnlog.service`` file, install it:
.. code-block:: none .. code-block:: none