tools: acrn-crashlog: update the documents

This patch updates the documents according to the latest implementation
of crashlogctl.

Tracked-On: #1024
Signed-off-by: CHEN Gang <gang.c.chen@intel.com>
Reviewed-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
Reviewed-by: Zhi Jin <zhi.jin@intel.com>
This commit is contained in:
CHEN Gang
2018-10-09 16:57:48 +08:00
committed by David Kinder
parent 655132fc8e
commit 2f8c31f6b4
2 changed files with 103 additions and 20 deletions

View File

@@ -53,19 +53,12 @@ The work flow diagram:
Usage
*****
- The server is launched automatically at boot, and the client is configured in
``core_pattern`` or ``coredump-wrapper``. In ``prepare.service``, it will
check the content of ``/proc/sys/kernel/core_pattern``. If there is
``coredump-wrapper``, which means that ``core_pattern`` has been set in
``systemd``, no need to do it again. Otherwise, the content should be
changed by:
.. code-block:: none
$ echo "|/usr/bin/usercrash_c %p %e %s" > /proc/sys/kernel/core_pattern
That means client will be triggered once userspace crash occurs. Then the
event will be sent to server from client.
- The server is launched automatically at boot after this tool is enabled with
instruction ``sudo crashlogctl enable``, and the client is configured in
``usercrash-wrapper``, which is set as the app of ``core_pattern``. In
``usercrash-wrapper``, it will collect and reorder the parameters of the
client and default app. Once a crash occurs in user space, the client and
default app will be invoked separately.
- The ``debugger`` is an independent tool to dump the debug information of the
specific process, including backtrace, stack, opened files, registers value,