From a0d3efed88f73f0b89e7016e0154875e4084ab62 Mon Sep 17 00:00:00 2001 From: Neo Xu Date: Sun, 6 Oct 2024 15:38:34 +0800 Subject: [PATCH] chore(doc): add new debugging folder Now debugging folder includes below tools. - gdb - profiler - logging - VGLite simulator Signed-off-by: Neo Xu --- .../gdb_plugin.rst} | 26 +++++++++---------- docs/overview/debugging/index.rst | 13 ++++++++++ docs/{porting => overview/debugging}/log.rst | 0 docs/overview/{ => debugging}/profiler.rst | 0 docs/overview/{ => debugging}/vg_lite_tvg.rst | 0 docs/overview/index.rst | 4 +-- docs/porting/index.rst | 1 - 7 files changed, 27 insertions(+), 17 deletions(-) rename docs/overview/{debugging.rst => debugging/gdb_plugin.rst} (74%) create mode 100644 docs/overview/debugging/index.rst rename docs/{porting => overview/debugging}/log.rst (100%) rename docs/overview/{ => debugging}/profiler.rst (100%) rename docs/overview/{ => debugging}/vg_lite_tvg.rst (100%) diff --git a/docs/overview/debugging.rst b/docs/overview/debugging/gdb_plugin.rst similarity index 74% rename from docs/overview/debugging.rst rename to docs/overview/debugging/gdb_plugin.rst index e71c7ac6ff..36423e2826 100644 --- a/docs/overview/debugging.rst +++ b/docs/overview/debugging/gdb_plugin.rst @@ -1,19 +1,19 @@ -.. _tools: +.. _gdb_plugin: -===== -Tools -===== +=========== +GDB Plug-In +=========== -LVGL has provided many tools to help you develop and debug your application. They are located in the ``lvgl/scripts`` directory. +Debugging LVGL with GDB +----------------------- -GDB Plugin -********** - -### Debugging LVGL with GDB - -To facilitate debugging LVGL with GDB, a GDB plugin is provided. This plugin can be found in the ``lvgl/scripts/gdb`` directory. -The GDB plugin can be used with any target where GDB is available. For example, you can use it to debug a device connected to a PC via JLink, which provides a GDB server. Additionally, if your device crashes and you have a core dump, you can use GDB to analyze the core dump. -To load the LVGL GDB plugin within GDB's command line, type the following command: +To facilitate debugging LVGL with GDB, a GDB plugin is provided. This plugin +can be found in the ``lvgl/scripts/gdb`` directory. The GDB plugin can be used +with any target where GDB is available. For example, you can use it to debug a +device connected to a PC via JLink, which provides a GDB server. Additionally, +if your device crashes and you have a core dump, you can use GDB to analyze the +core dump. To load the LVGL GDB plugin within GDB's command line, type the +following command: ``source lvgl/scripts/gdb/lvgl.py`` diff --git a/docs/overview/debugging/index.rst b/docs/overview/debugging/index.rst new file mode 100644 index 0000000000..f63522fcb1 --- /dev/null +++ b/docs/overview/debugging/index.rst @@ -0,0 +1,13 @@ +.. _debugging: + +============== +Debugging LVGL +============== + +.. toctree:: + :maxdepth: 2 + + log + profiler + vg_lite_tvg + gdb_plugin diff --git a/docs/porting/log.rst b/docs/overview/debugging/log.rst similarity index 100% rename from docs/porting/log.rst rename to docs/overview/debugging/log.rst diff --git a/docs/overview/profiler.rst b/docs/overview/debugging/profiler.rst similarity index 100% rename from docs/overview/profiler.rst rename to docs/overview/debugging/profiler.rst diff --git a/docs/overview/vg_lite_tvg.rst b/docs/overview/debugging/vg_lite_tvg.rst similarity index 100% rename from docs/overview/vg_lite_tvg.rst rename to docs/overview/debugging/vg_lite_tvg.rst diff --git a/docs/overview/index.rst b/docs/overview/index.rst index 712ee5fdcc..b40e92205d 100644 --- a/docs/overview/index.rst +++ b/docs/overview/index.rst @@ -23,8 +23,6 @@ Overview fs animations timer - profiler renderers/index new_widget - vg_lite_tvg - debugging + debugging/index diff --git a/docs/porting/index.rst b/docs/porting/index.rst index 787089bb0e..9cc60a6575 100644 --- a/docs/porting/index.rst +++ b/docs/porting/index.rst @@ -15,5 +15,4 @@ Porting timer_handler sleep os - log draw