From fc064cfa794eafb01355b361014126546a7099c5 Mon Sep 17 00:00:00 2001 From: Amy Reyes Date: Mon, 25 Oct 2021 10:38:02 -0700 Subject: [PATCH] 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 --- misc/debug_tools/acrn_log/README.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/misc/debug_tools/acrn_log/README.rst b/misc/debug_tools/acrn_log/README.rst index 75e090771..7d3b5f259 100644 --- a/misc/debug_tools/acrn_log/README.rst +++ b/misc/debug_tools/acrn_log/README.rst @@ -6,11 +6,11 @@ Acrnlog Description *********** -``acrnlog`` is a userland tool used to capture a ACRN hypervisor log. It runs as an -SOS service at boot, capturing two kinds of logs: +``acrnlog`` is a userland tool used to capture an ACRN hypervisor log. It runs +as a Service VM service at boot, capturing two kinds of logs: - 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 after a system reset. @@ -51,8 +51,8 @@ steps: # acrnlog -n 8 -s 4 & -You can use ``loglevel`` command in the hypervisor shell (not the Service -OS shell) to query and change the hypervisor log level. +You can use the ``loglevel`` command in the hypervisor shell (not the Service +VM shell) to query and change the hypervisor log level. The ``mem_loglevel`` parameter controls the log to be saved using ``acrnlog``, while the ``console_loglevel`` parameter controls the log @@ -71,7 +71,7 @@ can use these commands: 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`` and ``-s`` options on the ``ExecStart`` cmd, and restart the service. For example, ``acrnlog.service`` could have these parameters added: @@ -90,15 +90,15 @@ and then restart the service with: Build and Install ***************** -Source code for the ``acrnlog`` tools is in the ``tools/acrnlog`` -folder. Build and install the tools from source using: +Source code for the ``acrnlog`` tool is in the ``misc/debug_tools/acrn_log`` +directory. To build and install the tool from source, run these commands: .. code-block:: none # make # 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