处理remote-gdb层级结构

Author: nan2088

docs/faq/remote-gdb.mdx

@@ -4,40 +4,34 @@ title: "How to do remote debugging"
 type: explainer
 ---
 
-### Description
 
-During the process of program development, it is often necessary to configure various development environments. If there are differences in environment dependencies between local and online, it may cause some unknown bugs. It is recommended to use **Docker**.
-
-In the daily development process, project code is often stored on a remote host. We usually use SSH to connect to the remote host from our local machine for development.
-
-So, how can we enter the remote host's Docker container for code debugging? In this section, we will take the widely used **vscode** as an example to introduce how to use vscode to remotely access the Docker container for c++/python development/debugging. For other IDEs, interested users can Google it.
+In this section, we will introduce how to use vscode to remotely access the Docker container for c++/python development/debugging.
 
 To complete this, there are two main steps:
-Step 1: Configure the Docker on the remote host
-Step 2: Configure vscode
+- Step 1: Configure the Docker on the remote host
+- Step 2: Configure vscode
 
-The specific operations for each step are detailed below!
 
-### Step 1: Configure Docker on the remote host
-#### 1. Start Docker
+## Step 1: Configure Docker on the remote host
+### 1. Start Docker
 To allow vscode to SSH into the Docker container, we need to assign a port number when starting the Docker container. The specific startup method is as follows: (8022 is the host port, which can be modified to avoid conflicts. 22 is the fixed port inside Docker and can be left as default.)
 
 ```bash
 docker_image_name=nvcr.io/nvidia/pytorch:22.12-py3
 docker run -it --gpus all --ipc=host --ulimit memlock=-1 --ulimit stack=67108864 -p 8022:22 -v `pwd`:/workspace  --name="any_names"  --cap-add=SYS_PTRACE $docker_image_name  bash
 ```
 
-#### 2. Add password inside Docker
+### 2. Add password inside Docker
 `passwd`
 
-#### 3. Install openssh
+### 3. Install openssh
 
 ```bash
 apt-get update
 apt-get install -y  openssh-server  openssh-client vim
 ```
 
-#### Modify system configuration
+### Modify system configuration
 
 
 
@@ -57,13 +51,13 @@ Start the service: `/etc/init.d/ssh start` or `/etc/init.d/ssh restart`
 
 After starting the service, you can perform connection verification: `ssh -p 22 root@127.0.0.1`. If the startup fails, it will report a "Connection refused" error. If successful, it will prompt you to enter a password and display a "Welcome" message.
 
-#### 5. Install debugging tools inside Docker
+### 5. Install debugging tools inside Docker
 
 ```bash
 apt-get install gdb
 ```
 
-#### Compile torchpipe in debug mode
+### 6. Compile torchpipe in debug mode
 
 
 Change directory to torchpipe:
@@ -77,10 +71,10 @@ DEBUG=1 NCATCH_SUB=1 pip3 install -e .
 ```
 
 
-### Step 2: Configure vscode
+## Step 2: Configure vscode
 
 
-#### 1. Connect vscode to remote Docker
+### 1. Connect vscode to remote Docker
 
 Configure the ssh config file as follows, **note that User is root**, start vscode, install the Remote-SSH plugin, and configure the config as follows:
 
@@ -91,23 +85,20 @@ Host docker_debug  #docker_debug can be any name
     Port 8022 #the port number in Step 1
 ```
 
-:::tip For users in China
- f you find the network speed too slow, please refer to [Offline installation of vscode server](https://zhuanlan.zhihu.com/p/426876766) and its top comments. 
-:::
 
 
 
-#### 2. Install Extensions in VS Code
+### 2. Install Extensions in VS Code
 In the extension marketplace:
 
 - Search for and install the corresponding language extension for C++
 
 - Search for and install the corresponding language extension for Python
 
-#### 3. Configure VS Code
+### 3. Configure VS Code
 Click `run - open configurations`, and complete the configuration of the launch.json file according to the following scenario.
 
-##### 3.1 Scenario One: Debugging Only Python Code
+#### 3.1 Scenario One: Debugging Only Python Code
 
 **Configuration File:**
 
@@ -142,7 +133,7 @@ pdb.set_trace()
 ```
 
 
-##### 3.2 Scenario 2: Debugging Only C++ Code
+#### 3.2 Scenario 2: Debugging Only C++ Code
 
 **Configuration File**
 
@@ -174,7 +165,7 @@ pdb.set_trace()
 
 You can directly execute your Python file, such as python3 a.py, and then start "(gdb) Attach" to bind to the Python process. If the Python process exits too quickly, you can sleep for a period of time to begin debugging.
 
-##### 3.3 Scenario 3: Debugging Python and C++ Together
+#### 3.3 Scenario 3: Debugging Python and C++ Together
 
 [Reference: Example debugging mixed Python C++ in VS Code](https://nadiah.org/2020/03/01/example-debug-mixed-python-c-in-visual-studio-code/)
 
@@ -240,7 +231,7 @@ Trace the stack after a crash: bt
 
 
 
-#### 4. VSCode Header File Autocomplete (Optional)
+### 4. VSCode Header File Autocomplete (Optional)
 Update the project configuration in `./.vscode/c_cpp_properties.json` by adding the appropriate header file paths.
 ```json
 {

i18n/zh/docusaurus-plugin-content-docs/current/faq/remote-gdb.mdx

@@ -4,40 +4,40 @@ title: "如何进行远程调试"
 type: explainer
 ---
 
-### 说明
-
+ 
 在程序开发过程中，经常需要我们去配置各种开发环境，并且如果本地与线上存在环境依赖的不同，还可能导致出现一些不知原因的bug，比较推荐使用的便是**Docker**。
 
 在日常开发过程中，项目代码往往存放在远程的主机中，我们通常利用本地机器通过SSH连接到远程主机进行开发。
 
 那么，如何进入到远程主机docker内部进行代码调试呢？本节以使用较为广泛的**vscode**为例，介绍如何通过vscode远程到docker容器内部进行c++/python部分的开发/调试工作。其他的IDE，感兴趣的用户可以自行Google。
 
 要完成这个主要有两步骤：
-步骤一、配置远程主机的docker
-步骤二、配置vscode
+
+- 步骤一、配置远程主机的docker
+- 步骤二、配置vscode
 
 下面详细介绍每一步的具体操作！
 
 
-### 步骤一：远程主机docker配置
-#### 1. 启动docker
+## 步骤一：远程主机docker配置
+### 1. 启动docker
 为了能够让vscode能够ssh连接到docker中，我们需要在启动docker容器的时候为其分配端口号。具体的启动方式如下：（8022为宿主端口，可修改，防止冲突。22为docker内的固定端口，默认即可）
 
 ```bash
 docker_image_name=nvcr.io/nvidia/pytorch:22.12-py3
 docker run -it --gpus all --ipc=host --ulimit memlock=-1 --ulimit stack=67108864 -p 8022:22 -v `pwd`:/workspace  --name="any_names"  --cap-add=SYS_PTRACE $docker_image_name  bash
 ```
 
-#### 2. docker内增加密码
+### 2. docker内增加密码
 `passwd`
 
-#### 3. 安装openssh
+### 3. 安装openssh
 ```bash
 apt-get update
 apt-get install -y  openssh-server  openssh-client vim
 ```
 
-#### 4. 修改系统配置
+### 4. 修改系统配置
 ```bash
 vim /etc/ssh/sshd_config
 ```
@@ -52,12 +52,12 @@ PubkeyAuthentication yes
 启动服务后可以进行连接验证：`ssh -p 22 root@127.0.0.1`，如果启动失败，会报Connection refused的错误，成功则会让你输入密码，并有Welcome字样提示。
 
 
-#### 5. docker内安装调试工具
+### 5. docker内安装调试工具
 ```bash
 apt-get install gdb
 ```
 
-#### 6. 编译torchpipe为debug模式
+### 6. 编译torchpipe为debug模式
 
 进入到torchpipe目录
 
@@ -69,9 +69,9 @@ DEBUG=1 NCATCH_SUB=1 pip3 install -e .
 ```
 
 
-### 步骤二：vscode配置
+## 步骤二：vscode配置
 
-#### 1. vscode连接远程docker
+### 1. vscode连接远程docker
 
 按如下方式配置ssh的config文件，**注意User为root**，启动vscode，安装Remote-SSH插件，配置config如下：
 
@@ -85,19 +85,19 @@ Host docker_debug  #docker_debug为名字，随便起
 :::tip 国内用户
 如果觉得网速过慢，参考 [离线安装vscode server](https://zhuanlan.zhihu.com/p/426876766) 及其置顶评论。
 :::
-#### 2. vscode安装扩展
+### 2. vscode安装扩展
 在扩展商店内：
 
 - 搜索 c++ 安装相应语言扩展
 
 - 搜索 python 安装相应语言扩展
 
-#### 3. vscode配置
+### 3. vscode配置
 
 点击 `run  - open configurations`， 按照如下场景完成配置文件launch.json的配置。
 
 
-##### 3.1 情境一：仅调试Python部分代码
+#### 3.1 情境一：仅调试Python部分代码
 
 **配置文件：**
 
@@ -134,7 +134,7 @@ pdb.set_trace()
 
 
 
-##### 3.2 情境二：仅调试C++部分代码
+#### 3.2 情境二：仅调试C++部分代码
 
 **配置文件**
 
@@ -168,7 +168,7 @@ pdb.set_trace()
 
 
 
-##### 3.3 情境三：python和C++联调
+#### 3.3 情境三：python和C++联调
 
 [参考链接: Example debugging mixed Python C++ in VS Code](https://nadiah.org/2020/03/01/example-debug-mixed-python-c-in-visual-studio-code/)
 
@@ -236,7 +236,7 @@ run your.py
 
 
 
-#### 4. vscode头文件补全(可选)
+### 4. vscode头文件补全(可选)
 修改 项目配置 `./.vscode/c_cpp_properties.json`
 补充相应头文件路径
 ```json