From 8fe695c8b305039c741faf3e02521695dc058cfc Mon Sep 17 00:00:00 2001 From: Amy Reyes Date: Mon, 25 Oct 2021 13:39:03 -0700 Subject: [PATCH] doc: terminology cleanup in crashlog readme - Replace SOS with Service VM - Clean up some of the grammar Signed-off-by: Amy Reyes --- misc/debug_tools/acrn_crashlog/README.rst | 41 ++++++++++++----------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/misc/debug_tools/acrn_crashlog/README.rst b/misc/debug_tools/acrn_crashlog/README.rst index 50f618e8b..2e139fdaa 100644 --- a/misc/debug_tools/acrn_crashlog/README.rst +++ b/misc/debug_tools/acrn_crashlog/README.rst @@ -5,10 +5,10 @@ Introduction ************ ``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 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 of interest, by using an XML configuration file. @@ -158,33 +158,34 @@ The source code structure: └── include - ``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 - acrnlog. For the log on SOS, the userspace crash log is collected with - usercrash, and the kernel crash log is collected with the inherent mechanism - like ``ipanic``, ``pstore`` and etc. For the log on AaaG, it's collected with - monitoring the change of related folders on the sos image, like - ``/data/logs/``. ``acrnprobe`` also provides a flexible way to allow users to - configure which crash or event they want to collect through the XML file - easily. + probe on telemetrics-client. For the hypervisor, the 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 + like ``ipanic``, ``pstore``, etc. For the AaaG, the log is collected by + monitoring the change of related folders on the Service VM image, like + ``/data/logs/``. ``acrnprobe`` also provides a flexible way to + configure which crash or event to collect, by using an XML configuration file. - ``common``: some utils for logs, command and string. - ``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. Acrnprobe ========= -The ``acrnprobe`` detects all critical events on the platform and collects -specific information for debug purpose. These information would be saved as -logs, and the log path would be delivered to telemetrics-client as a record if -the telemetrics-client existed on the system. -For more detail on acrnprobe, please refer :ref:`acrnprobe_doc`. +The ``acrnprobe`` tool detects all critical events on the platform and collects +specific information for debug purposes. The information is saved as +logs, and the log path is delivered to telemetrics-client as a record if +telemetrics-client exists on the system. +For more details on ``acrnprobe``, see :ref:`acrnprobe_doc`. Usercrash ========= -The ``usercrash`` is a tool to get the crash info of the crashing process in -userspace. It works in Client/Server model. Server is autostarted, and client is +The ``usercrash`` tool gets the crash information of the crashing process in +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 -triggered once crash occurs in userspace. -For more detail on ``usercrash``, please refer :ref:`usercrash_doc`. +triggered once a crash occurs in userspace. +For more details on ``usercrash``, see :ref:`usercrash_doc`.