From d467ba04f210176500bd962e0c6350ac80ce3878 Mon Sep 17 00:00:00 2001 From: slz Date: Thu, 5 Feb 2026 14:31:19 +0800 Subject: [PATCH] Refactor log collection instructions for clarity in FAQ documentation --- docs/en/source/camera_devices/8_FAQ/FAQ.md | 4 ++-- docs/zh/source/camera_devices/8_FAQ/FAQ.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/source/camera_devices/8_FAQ/FAQ.md b/docs/en/source/camera_devices/8_FAQ/FAQ.md index 7595a261..aba7fa94 100644 --- a/docs/en/source/camera_devices/8_FAQ/FAQ.md +++ b/docs/en/source/camera_devices/8_FAQ/FAQ.md @@ -27,13 +27,13 @@ If the camera node crashes unexpectedly, it will generate a crash log in the cur ### How to Collect and Save Logs -1. **SDK debug logs** +- **SDK debug logs** Set the launch parameter `log_level` to `debug`. After running, the SDK will generate log files in the `Log/` folder under the current project directory. If you want a more recognizable file name for this test, you can set the parameter `log_file_name`. > SDK logs are appended to the same file: multiple launches will continue writing into the same log file. > Recommendation: before packaging logs to send to technical support, delete old log files, then reproduce the issue and collect new logs. This keeps the logs cleaner and makes troubleshooting more accurate. -2. **ROS 2 logs (`~/.ros/log`)** +- **ROS 2 logs (`~/.ros/log`)** In the launch file, set the node (or composable node container) parameter `output` to `"log"` to save ROS 2 logs locally. > After setting `output="log"`, ROS 2 logs will be stored in the `~/.ros/log/` directory. diff --git a/docs/zh/source/camera_devices/8_FAQ/FAQ.md b/docs/zh/source/camera_devices/8_FAQ/FAQ.md index 4332cf98..2f6d1b09 100644 --- a/docs/zh/source/camera_devices/8_FAQ/FAQ.md +++ b/docs/zh/source/camera_devices/8_FAQ/FAQ.md @@ -27,13 +27,13 @@ ### 如何采集和保存日志 -1. **SDK debug 日志** +- **SDK debug 日志** 将 launch 参数 `log_level` 设为 `debug` 运行后，会在当前工程目录下的 `Log/` 文件夹中生成 SDK 日志文件。如果需要为本次测试指定一个更易识别的日志文件名，可以修改参数 `log_file_name`。 > SDK 日志是追加写入的：多次启动会在同一个文件里不断累积日志。 > 建议：在准备打包日志发给技术支持前，先删除旧的日志文件，然后重新复现问题并采集新的日志，这样日志更干净、定位更准确。 -2. **ROS2 日志（~/.ros/log）** +- **ROS2 日志（~/.ros/log）** 在 launch 文件中，将节点（或可组合节点容器）的 `output` 参数设为 `"log"`，即可将 ROS2 日志保存到本地： > 设置为 `output="log"` 后，ROS2 日志将保存在 `~/.ros/log/` 目录下。