mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2026-04-04 11:24:03 +00:00
doc: update release_2.4 with master content
Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Tracked-On: #5692
This commit is contained in:
committed by
David Kinder
parent
3991c48284
commit
234d4c753f
@@ -15,7 +15,7 @@ of interest, by using an XML configuration file.
|
||||
Building
|
||||
********
|
||||
|
||||
Build dependencies
|
||||
Build Dependencies
|
||||
==================
|
||||
|
||||
The ``ACRN-Crashlog`` tool depends on the following libraries
|
||||
@@ -171,7 +171,7 @@ The source code structure:
|
||||
- ``usercrash``: to implement the tool which get the crash information for the
|
||||
crashing process in userspace.
|
||||
|
||||
acrnprobe
|
||||
Acrnprobe
|
||||
=========
|
||||
|
||||
The ``acrnprobe`` detects all critical events on the platform and collects
|
||||
@@ -180,7 +180,7 @@ 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`.
|
||||
|
||||
usercrash
|
||||
Usercrash
|
||||
=========
|
||||
|
||||
The ``usercrash`` is a tool to get the crash info of the crashing process in
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.. _acrnprobe_doc:
|
||||
|
||||
acrnprobe
|
||||
Acrnprobe
|
||||
#########
|
||||
|
||||
Description
|
||||
@@ -143,7 +143,7 @@ Diagram
|
||||
+-----------------------------------------------------------------------------+
|
||||
|
||||
|
||||
Source files
|
||||
Source Files
|
||||
************
|
||||
|
||||
- main.c
|
||||
@@ -176,7 +176,7 @@ Source files
|
||||
- loop.c
|
||||
This file provides interfaces to read from image.
|
||||
|
||||
Configuration files
|
||||
Configuration Files
|
||||
*******************
|
||||
|
||||
* ``/usr/share/defaults/telemetrics/acrnprobe.xml``
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.. _acrnprobe-conf:
|
||||
|
||||
acrnprobe Configuration
|
||||
Acrnprobe Configuration
|
||||
#######################
|
||||
|
||||
Description
|
||||
@@ -62,13 +62,13 @@ Layout
|
||||
As for the definition of ``sender``, ``trigger``, ``crash`` and ``info``
|
||||
please refer to :ref:`acrnprobe_doc`.
|
||||
|
||||
Properties of group members
|
||||
Properties of Group Members
|
||||
***************************
|
||||
|
||||
``acrnprobe`` defined different groups in configuration file, which are
|
||||
``senders``, ``triggers``, ``crashes`` and ``infos``.
|
||||
|
||||
Common properties
|
||||
Common Properties
|
||||
=================
|
||||
|
||||
- ``id``:
|
||||
@@ -76,7 +76,7 @@ Common properties
|
||||
- ``enable``:
|
||||
This group member will be ignored if the value is NOT ``true``.
|
||||
|
||||
Other properties
|
||||
Other Properties
|
||||
================
|
||||
|
||||
- ``inherit``:
|
||||
@@ -87,14 +87,14 @@ Other properties
|
||||
- ``expression``:
|
||||
See `Crash`_.
|
||||
|
||||
Crash tree in acrnprobe
|
||||
Crash Tree in Acrnprobe
|
||||
***********************
|
||||
|
||||
There could be a parent/child relationship between crashes. Refer to the
|
||||
diagrams below, crash B and D are the children of crash A, because crash B and
|
||||
D inherit from crash A, and crash C is the child of crash B.
|
||||
|
||||
Build crash tree in configuration
|
||||
Build Crash Tree in Configuration
|
||||
=================================
|
||||
|
||||
.. graphviz:: images/crash-config.dot
|
||||
@@ -102,7 +102,7 @@ Build crash tree in configuration
|
||||
:align: center
|
||||
:caption: Build crash tree in configuration
|
||||
|
||||
Match crash at runtime
|
||||
Match Crash at Runtime
|
||||
======================
|
||||
|
||||
In order to find a more specific type, if one crash type matches
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.. _usercrash_doc:
|
||||
|
||||
usercrash
|
||||
Usercrash
|
||||
#########
|
||||
|
||||
Description
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.. _acrnlog:
|
||||
|
||||
acrnlog
|
||||
Acrnlog
|
||||
#######
|
||||
|
||||
Description
|
||||
@@ -32,7 +32,7 @@ Options:
|
||||
-s limit the size of each log file, in KB. 0 means no limitation.
|
||||
-n specify the number of log files to keep, old files would be deleted.
|
||||
|
||||
Temporary log file changes
|
||||
Temporary Log File Changes
|
||||
==========================
|
||||
|
||||
You can temporarily change the log file setting by following these
|
||||
@@ -68,7 +68,7 @@ can use these commands:
|
||||
console_loglevel: 2, mem_loglevel: 5, npk_loglevel: 5
|
||||
|
||||
|
||||
Permanent log file changes
|
||||
Permanent Log File Changes
|
||||
==========================
|
||||
|
||||
You can also permanently change the log file settings by
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.. _acrntrace:
|
||||
|
||||
acrntrace
|
||||
Acrntrace
|
||||
#########
|
||||
|
||||
Description
|
||||
@@ -12,7 +12,7 @@ A ``scripts`` directory includes scripts to analyze the trace data.
|
||||
Usage
|
||||
*****
|
||||
|
||||
acrntrace
|
||||
Acrntrace
|
||||
=========
|
||||
|
||||
The ``acrntrace`` tool runs on the Service OS (SOS) to capture trace data and
|
||||
@@ -98,7 +98,7 @@ Options:
|
||||
doesn't support for an invariant TSC. The results may therefore not be
|
||||
completely accurate in that regard.
|
||||
|
||||
Typical use example
|
||||
Typical Use Example
|
||||
===================
|
||||
|
||||
Here's a typical use of ``acrntrace`` to capture trace data from the SOS,
|
||||
|
||||
Reference in New Issue
Block a user