doc: terminology cleanup in crashlog readme

- Replace SOS with Service VM
- 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 13:39:03 -07:00 committed by David Kinder
parent 6d61c2dfff
commit 8fe695c8b3
1 changed files with 21 additions and 20 deletions

View File

@ -5,10 +5,10 @@ Introduction
************ ************
``ACRN-Crashlog`` is a collective name for various tools (``acrnprobe``, ``ACRN-Crashlog`` is a collective name for various tools (``acrnprobe``,
``usercrash_s``, ``usercrash_c``, ``debugger``, and more) and a overall ``usercrash_s``, ``usercrash_c``, ``debugger``, and more) and an overall
control utility called ``crashlogctl``. Together these tools collect logs control utility called ``crashlogctl``. Together these tools collect logs
and information after each crash or event on an ACRN platform, including and information after each crash or event on an ACRN platform, including
the hypervisor, Service OS (SOS), and Android as a Guest (AaaG). the hypervisor, Service VM, and Android as a Guest (AaaG).
``ACRN-Crashlog`` provides a flexible way to configure which events are ``ACRN-Crashlog`` provides a flexible way to configure which events are
of interest, by using an XML configuration file. of interest, by using an XML configuration file.
@ -158,33 +158,34 @@ The source code structure:
└── include └── include
- ``acrnprobe``: to gather all the crash and event logs on the platform, and - ``acrnprobe``: to gather all the crash and event logs on the platform, and
probe on telemetrics-client. For the logs on hypervisor, it's collected with probe on telemetrics-client. For the hypervisor, the log is collected with
acrnlog. For the log on SOS, the userspace crash log is collected with ``acrnlog``. For the Service VM, the userspace crash log is collected with
usercrash, and the kernel crash log is collected with the inherent mechanism ``usercrash``, and the kernel crash log is collected with the inherent
like ``ipanic``, ``pstore`` and etc. For the log on AaaG, it's collected with mechanism
monitoring the change of related folders on the sos image, like like ``ipanic``, ``pstore``, etc. For the AaaG, the log is collected by
``/data/logs/``. ``acrnprobe`` also provides a flexible way to allow users to monitoring the change of related folders on the Service VM image, like
configure which crash or event they want to collect through the XML file ``/data/logs/``. ``acrnprobe`` also provides a flexible way to
easily. configure which crash or event to collect, by using an XML configuration file.
- ``common``: some utils for logs, command and string. - ``common``: some utils for logs, command and string.
- ``data``: configuration file, service files and shell script. - ``data``: configuration file, service files and shell script.
- ``usercrash``: to implement the tool which get the crash information for the - ``usercrash``: to implement the tool that gets the crash information for the
crashing process in userspace. crashing process in userspace.
Acrnprobe Acrnprobe
========= =========
The ``acrnprobe`` detects all critical events on the platform and collects The ``acrnprobe`` tool detects all critical events on the platform and collects
specific information for debug purpose. These information would be saved as specific information for debug purposes. The information is saved as
logs, and the log path would be delivered to telemetrics-client as a record if logs, and the log path is delivered to telemetrics-client as a record if
the telemetrics-client existed on the system. telemetrics-client exists on the system.
For more detail on acrnprobe, please refer :ref:`acrnprobe_doc`. For more details on ``acrnprobe``, see :ref:`acrnprobe_doc`.
Usercrash Usercrash
========= =========
The ``usercrash`` is a tool to get the crash info of the crashing process in The ``usercrash`` tool gets the crash information of the crashing process in
userspace. It works in Client/Server model. Server is autostarted, and client is userspace. It works in a client/server model. The server is autostarted, and
the client is
configured in ``core_pattern`` or ``coredump-wrapper``, which will be configured in ``core_pattern`` or ``coredump-wrapper``, which will be
triggered once crash occurs in userspace. triggered once a crash occurs in userspace.
For more detail on ``usercrash``, please refer :ref:`usercrash_doc`. For more details on ``usercrash``, see :ref:`usercrash_doc`.