From 853766efab1e3fd1a43e9c8d36d67677563aa16d Mon Sep 17 00:00:00 2001 From: liuxu <759587231@qq.com> Date: Tue, 1 Sep 2020 23:54:38 -0700 Subject: [PATCH] vscode:images rename --- docs/howto/how_to_debug.md | 16 ++-- .../how_to_use_apollo_2.5_navigation_mode.md | 2 +- ...ow_to_use_apollo_2.5_navigation_mode_cn.md | 2 +- .../check_route_reverse_early_change_lane.png | Bin .../choose_apollo_root_directory.png | Bin .../config_launch_json_for_remote_debug.png | Bin .../enable_simcontrol.png | Bin .../failed_to_connect_gdbserver.png | Bin .../gdbserver_attach_debug.png | Bin .../open_directory.png | Bin .../planning_id_ps.png | Bin .../planning_id_top.png | Bin .../remote_debug_planning_module.png | Bin .../remote_show_dreamview.png | Bin .../remote_start_gdbserver.png | Bin .../run_normal_build_task.png | Bin .../{vscode => build_debug}/run_tasks.png | Bin .../selete_build_task.png | Bin .../ssh_remote_login_192_168_3_137.png | Bin .../start_routing_and_planning.png | Bin .../images/{vscode => build_debug}/tasks.png | Bin .../view_gdbserver_process.png | Bin .../{vscode => build_debug}/view_ipc_ip.png | Bin .../vscode_build_complete.png | Bin .../vscode_call_for_password.png | Bin .../vscode_debug_interface.png | Bin .../apollo_2_5_technical_tutorial.md | 75 ------------------ 27 files changed, 10 insertions(+), 85 deletions(-) rename docs/howto/images/{vscode => build_debug}/check_route_reverse_early_change_lane.png (100%) rename docs/howto/images/{vscode => build_debug}/choose_apollo_root_directory.png (100%) rename docs/howto/images/{vscode => build_debug}/config_launch_json_for_remote_debug.png (100%) rename docs/howto/images/{vscode => build_debug}/enable_simcontrol.png (100%) rename docs/howto/images/{vscode => build_debug}/failed_to_connect_gdbserver.png (100%) rename docs/howto/images/{vscode => build_debug}/gdbserver_attach_debug.png (100%) rename docs/howto/images/{vscode => build_debug}/open_directory.png (100%) rename docs/howto/images/{vscode => build_debug}/planning_id_ps.png (100%) rename docs/howto/images/{vscode => build_debug}/planning_id_top.png (100%) rename docs/howto/images/{vscode => build_debug}/remote_debug_planning_module.png (100%) rename docs/howto/images/{vscode => build_debug}/remote_show_dreamview.png (100%) rename docs/howto/images/{vscode => build_debug}/remote_start_gdbserver.png (100%) rename docs/howto/images/{vscode => build_debug}/run_normal_build_task.png (100%) rename docs/howto/images/{vscode => build_debug}/run_tasks.png (100%) rename docs/howto/images/{vscode => build_debug}/selete_build_task.png (100%) rename docs/howto/images/{vscode => build_debug}/ssh_remote_login_192_168_3_137.png (100%) rename docs/howto/images/{vscode => build_debug}/start_routing_and_planning.png (100%) rename docs/howto/images/{vscode => build_debug}/tasks.png (100%) rename docs/howto/images/{vscode => build_debug}/view_gdbserver_process.png (100%) rename docs/howto/images/{vscode => build_debug}/view_ipc_ip.png (100%) rename docs/howto/images/{vscode => build_debug}/vscode_build_complete.png (100%) rename docs/howto/images/{vscode => build_debug}/vscode_call_for_password.png (100%) rename docs/howto/images/{vscode => build_debug}/vscode_debug_interface.png (100%) delete mode 100644 docs/quickstart/apollo_2_5_technical_tutorial.md diff --git a/docs/howto/how_to_debug.md b/docs/howto/how_to_debug.md index e154a7008f..090a7eafad 100644 --- a/docs/howto/how_to_debug.md +++ b/docs/howto/how_to_debug.md @@ -59,15 +59,15 @@ bash scripts/bootstrap.sh Start the module to be debugged, either by using the command line or by using the Dreamview interface. The following is an example of debugging the **Planning** module from the Dreamview interface. Open Chrome browser, enter the URL: http://localhost:8888/, open the Dreamview interface, open the **SimControl** option, as shown below: -![7](images/vscode/enable_simcontrol.png) +![7](images/build_debug/enable_simcontrol.png) Click on the `Module Controler` tab on the left toolbar and select the `Routing` and `Planning` options as shown below: -![8](images/vscode/start_routing_and_planning.png) +![8](images/build_debug/start_routing_and_planning.png) Click the `Default Routing` tab on the left toolbar, select `Route: Reverse Early Change Lane` or any of these options, send a `Routing Request` request, and generate a global navigation path, as shown below: -![9](images/vscode/check_route_reverse_early_change_lane.png) +![9](images/build_debug/check_route_reverse_early_change_lane.png) #### Viewing the "Planning" Process ID @@ -79,7 +79,7 @@ ps aux | grep mainboard | grep planning The result in the following figure is similar to the previous figure, you can see that the `Planning` process ID is 4147. -![11](images/vscode/planning_id_ps.png) +![11](images/build_debug/planning_id_ps.png) #### Debugging Planning module using GDBServer @@ -90,14 +90,14 @@ sudo gdbserver :1111 --attach 4147 ``` In the above command, ":1111" indicates that the debugging service process with the port "1111" is enabled, and "4147" indicates the "Planning" process ID. If the result is as shown below, the operation is successful. -![12](images/vscode/gdbserver_attach_debug.png) +![12](images/build_debug/gdbserver_attach_debug.png) After restarting a command terminal and entering Docker, use the following command to see that the "gdbserver" process is running normally: ``` bash ps aux | grep gdbserver ``` -![13](images/vscode/view_gdbserver_process.png) +![13](images/build_debug/view_gdbserver_process.png) #### Starting GDBServer with a Script File @@ -139,7 +139,7 @@ ifconfig Assuming that the IP address of the industrial computer LAN is: 192.168.3.137, open your Chrome or Firefox browser, enter the following URL: http://192.168.3.137:8888/, start the module (`Planning`) to be debugged as shown in [Start the module that needs debugging](#Start-the-module-that-needs-debugging) section -![17](images/vscode/remote_show_dreamview.png) +![17](images/build_debug/remote_show_dreamview.png) #### Use the SSH Command to Remotely Log In to the Industrial PC and Start the Gdbserver Service of the Industrial PC @@ -159,4 +159,4 @@ bash docker/scripts/dev_start_gdb_server.sh planning 1111 ``` As shown in the figure below, if you see a prompt similar to Listening on port 1111, the gdbserver service starts successfully. -![19](images/vscode/remote_start_gdbserver.png) +![19](images/build_debug/remote_start_gdbserver.png) diff --git a/docs/howto/how_to_use_apollo_2.5_navigation_mode.md b/docs/howto/how_to_use_apollo_2.5_navigation_mode.md index cda5a011f0..2cb32f4fb7 100644 --- a/docs/howto/how_to_use_apollo_2.5_navigation_mode.md +++ b/docs/howto/how_to_use_apollo_2.5_navigation_mode.md @@ -32,7 +32,7 @@ Open Visual Studio Code and execute menu command `File -> Open Folder`. In the p ![img](images/navigation_mode/choose_apollo_directory_en.png) -Next, execute menu command `Tasks -> Run Build Task` or directly press `Ctrl + Shift + B` (shortcut keys which are the same as in Visual Studio and QT) to build a project. Docker will be launched when compiling if it has not yet been started. A superuser password needs to be entered in the terminal window at the bottom. After the command is executed, a display of `Terminal will be reused by tasks, press any key to close it.` in the terminal window at the bottom indicates that the build is successful. Keep good internet connection during the whole process, otherwise the dependencies cannot be downloaded. You may encounter some problems during the build. Solutions can be found in [this blog](https://blog.csdn.net/davidhopper/article/details/79349927) post and the [Help Doc](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_build_and_debug_apollo_in_vscode_cn.md) on GitHub. +Next, execute menu command `Tasks -> Run Build Task` or directly press `Ctrl + Shift + B` (shortcut keys which are the same as in Visual Studio and QT) to build a project. Docker will be launched when compiling if it has not yet been started. A superuser password needs to be entered in the terminal window at the bottom. After the command is executed, a display of `Terminal will be reused by tasks, press any key to close it.` in the terminal window at the bottom indicates that the build is successful. Keep good internet connection during the whole process, otherwise the dependencies cannot be downloaded. You may encounter some problems during the build. Solutions can be found in [this blog](https://blog.csdn.net/davidhopper/article/details/79349927) post and the [Help Doc](https://github.com/ApolloAuto/apollo/blob/r5.5.0/docs/howto/how_to_build_and_debug_apollo_in_vscode_cn.md) on GitHub. ![img](images/navigation_mode/build_successfully_en.png) diff --git a/docs/howto/how_to_use_apollo_2.5_navigation_mode_cn.md b/docs/howto/how_to_use_apollo_2.5_navigation_mode_cn.md index 3e66e38a47..12c658d93d 100644 --- a/docs/howto/how_to_use_apollo_2.5_navigation_mode_cn.md +++ b/docs/howto/how_to_use_apollo_2.5_navigation_mode_cn.md @@ -27,7 +27,7 @@ ![img](images/navigation_mode/choose_apollo_directory.png) -之后，执行菜单命令`任务->运行生成任务`或直接按快捷键`Ctrl+Shift+B`（与`Visual Studio`和`QT`的快捷键一致）构建工程，若之前没有启动过`Docker`，则编译时会启动`Docker`，需在底部终端窗口输入超级用户密码。命令执行完毕，若在底部终端窗口出现`终端将被任务重用，按任意键关闭。`信息（如下图所示），则表示构建成功。整个过程**一定要保持网络畅通**，否则无法下载依赖包。构建过程可能会遇到一些问题，解决方法可参见我写的一篇[博客](https://blog.csdn.net/davidhopper/article/details/79349927) ，也可直接查看`GitHub`网站的[帮助文档](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_build_and_debug_apollo_in_vscode_cn.md)。 +之后，执行菜单命令`任务->运行生成任务`或直接按快捷键`Ctrl+Shift+B`（与`Visual Studio`和`QT`的快捷键一致）构建工程，若之前没有启动过`Docker`，则编译时会启动`Docker`，需在底部终端窗口输入超级用户密码。命令执行完毕，若在底部终端窗口出现`终端将被任务重用，按任意键关闭。`信息（如下图所示），则表示构建成功。整个过程**一定要保持网络畅通**，否则无法下载依赖包。构建过程可能会遇到一些问题，解决方法可参见我写的一篇[博客](https://blog.csdn.net/davidhopper/article/details/79349927) ，也可直接查看`GitHub`网站的[帮助文档](https://github.com/ApolloAuto/apollo/blob/r5.5.0/docs/howto/how_to_build_and_debug_apollo_in_vscode_cn.md)。 ![img](images/navigation_mode/build_successfully.png) diff --git a/docs/howto/images/vscode/check_route_reverse_early_change_lane.png b/docs/howto/images/build_debug/check_route_reverse_early_change_lane.png similarity index 100% rename from docs/howto/images/vscode/check_route_reverse_early_change_lane.png rename to docs/howto/images/build_debug/check_route_reverse_early_change_lane.png diff --git a/docs/howto/images/vscode/choose_apollo_root_directory.png b/docs/howto/images/build_debug/choose_apollo_root_directory.png similarity index 100% rename from docs/howto/images/vscode/choose_apollo_root_directory.png rename to docs/howto/images/build_debug/choose_apollo_root_directory.png diff --git a/docs/howto/images/vscode/config_launch_json_for_remote_debug.png b/docs/howto/images/build_debug/config_launch_json_for_remote_debug.png similarity index 100% rename from docs/howto/images/vscode/config_launch_json_for_remote_debug.png rename to docs/howto/images/build_debug/config_launch_json_for_remote_debug.png diff --git a/docs/howto/images/vscode/enable_simcontrol.png b/docs/howto/images/build_debug/enable_simcontrol.png similarity index 100% rename from docs/howto/images/vscode/enable_simcontrol.png rename to docs/howto/images/build_debug/enable_simcontrol.png diff --git a/docs/howto/images/vscode/failed_to_connect_gdbserver.png b/docs/howto/images/build_debug/failed_to_connect_gdbserver.png similarity index 100% rename from docs/howto/images/vscode/failed_to_connect_gdbserver.png rename to docs/howto/images/build_debug/failed_to_connect_gdbserver.png diff --git a/docs/howto/images/vscode/gdbserver_attach_debug.png b/docs/howto/images/build_debug/gdbserver_attach_debug.png similarity index 100% rename from docs/howto/images/vscode/gdbserver_attach_debug.png rename to docs/howto/images/build_debug/gdbserver_attach_debug.png diff --git a/docs/howto/images/vscode/open_directory.png b/docs/howto/images/build_debug/open_directory.png similarity index 100% rename from docs/howto/images/vscode/open_directory.png rename to docs/howto/images/build_debug/open_directory.png diff --git a/docs/howto/images/vscode/planning_id_ps.png b/docs/howto/images/build_debug/planning_id_ps.png similarity index 100% rename from docs/howto/images/vscode/planning_id_ps.png rename to docs/howto/images/build_debug/planning_id_ps.png diff --git a/docs/howto/images/vscode/planning_id_top.png b/docs/howto/images/build_debug/planning_id_top.png similarity index 100% rename from docs/howto/images/vscode/planning_id_top.png rename to docs/howto/images/build_debug/planning_id_top.png diff --git a/docs/howto/images/vscode/remote_debug_planning_module.png b/docs/howto/images/build_debug/remote_debug_planning_module.png similarity index 100% rename from docs/howto/images/vscode/remote_debug_planning_module.png rename to docs/howto/images/build_debug/remote_debug_planning_module.png diff --git a/docs/howto/images/vscode/remote_show_dreamview.png b/docs/howto/images/build_debug/remote_show_dreamview.png similarity index 100% rename from docs/howto/images/vscode/remote_show_dreamview.png rename to docs/howto/images/build_debug/remote_show_dreamview.png diff --git a/docs/howto/images/vscode/remote_start_gdbserver.png b/docs/howto/images/build_debug/remote_start_gdbserver.png similarity index 100% rename from docs/howto/images/vscode/remote_start_gdbserver.png rename to docs/howto/images/build_debug/remote_start_gdbserver.png diff --git a/docs/howto/images/vscode/run_normal_build_task.png b/docs/howto/images/build_debug/run_normal_build_task.png similarity index 100% rename from docs/howto/images/vscode/run_normal_build_task.png rename to docs/howto/images/build_debug/run_normal_build_task.png diff --git a/docs/howto/images/vscode/run_tasks.png b/docs/howto/images/build_debug/run_tasks.png similarity index 100% rename from docs/howto/images/vscode/run_tasks.png rename to docs/howto/images/build_debug/run_tasks.png diff --git a/docs/howto/images/vscode/selete_build_task.png b/docs/howto/images/build_debug/selete_build_task.png similarity index 100% rename from docs/howto/images/vscode/selete_build_task.png rename to docs/howto/images/build_debug/selete_build_task.png diff --git a/docs/howto/images/vscode/ssh_remote_login_192_168_3_137.png b/docs/howto/images/build_debug/ssh_remote_login_192_168_3_137.png similarity index 100% rename from docs/howto/images/vscode/ssh_remote_login_192_168_3_137.png rename to docs/howto/images/build_debug/ssh_remote_login_192_168_3_137.png diff --git a/docs/howto/images/vscode/start_routing_and_planning.png b/docs/howto/images/build_debug/start_routing_and_planning.png similarity index 100% rename from docs/howto/images/vscode/start_routing_and_planning.png rename to docs/howto/images/build_debug/start_routing_and_planning.png diff --git a/docs/howto/images/vscode/tasks.png b/docs/howto/images/build_debug/tasks.png similarity index 100% rename from docs/howto/images/vscode/tasks.png rename to docs/howto/images/build_debug/tasks.png diff --git a/docs/howto/images/vscode/view_gdbserver_process.png b/docs/howto/images/build_debug/view_gdbserver_process.png similarity index 100% rename from docs/howto/images/vscode/view_gdbserver_process.png rename to docs/howto/images/build_debug/view_gdbserver_process.png diff --git a/docs/howto/images/vscode/view_ipc_ip.png b/docs/howto/images/build_debug/view_ipc_ip.png similarity index 100% rename from docs/howto/images/vscode/view_ipc_ip.png rename to docs/howto/images/build_debug/view_ipc_ip.png diff --git a/docs/howto/images/vscode/vscode_build_complete.png b/docs/howto/images/build_debug/vscode_build_complete.png similarity index 100% rename from docs/howto/images/vscode/vscode_build_complete.png rename to docs/howto/images/build_debug/vscode_build_complete.png diff --git a/docs/howto/images/vscode/vscode_call_for_password.png b/docs/howto/images/build_debug/vscode_call_for_password.png similarity index 100% rename from docs/howto/images/vscode/vscode_call_for_password.png rename to docs/howto/images/build_debug/vscode_call_for_password.png diff --git a/docs/howto/images/vscode/vscode_debug_interface.png b/docs/howto/images/build_debug/vscode_debug_interface.png similarity index 100% rename from docs/howto/images/vscode/vscode_debug_interface.png rename to docs/howto/images/build_debug/vscode_debug_interface.png diff --git a/docs/quickstart/apollo_2_5_technical_tutorial.md b/docs/quickstart/apollo_2_5_technical_tutorial.md deleted file mode 100644 index 0a67a92996..0000000000 --- a/docs/quickstart/apollo_2_5_technical_tutorial.md +++ /dev/null @@ -1,75 +0,0 @@ -# Apollo 2.5 Technical Tutorial - - - - -## Overview -> Learn Apollo basic concepts and Apollo 2.5 quick start - - * [Apollo 2.5 quick start](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_2_5_quick_start.md "Apollo 2.5 quick start") - -## Hardware system installation -> Learn the procedure of Apollo 2.5 hardware system installation - - * [Apollo 2.5 hardware system installation guide](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_2_5_hardware_system_installation_guide_v1.md "Apollo 2.5 hardware system installation guide") - -## Calibration -> Learn the process of the calibration service - - * [Calibration guide between LiDAR and INS](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_1_5_lidar_calibration_guide.md "Calibration guide between LiDAR and INS") - * [Guide for Camera-to-Camera calibration, Camera-to-LiDAR calibration, Radar-to-Camera calibration, IMU-to-Vehicle calibration](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_2_0_sensor_calibration_guide.md "Guide for Camera-to-Camera Calibration, Camera-to-LiDAR Calibration, Radar-to-Camera Calibration, IMU-to-Vehicle Calibration") - * [Multiple-LiDAR GNSS calibration guide](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/multiple_lidar_gnss_calibration_guide.md "Multiple-LiDAR GNSS calibration guide") - * [Apollo coordination](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/coordination.pdf "Apollo coordination") - - -## Software installation -> Learn the procedure of Apollo 2.5 software system installation - - * [Apollo software installation guide](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_software_installation_guide.md "Apollo software installation guide") - * [How to Debug a Dreamview Start Problem](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_debug_dreamview_start_problem.md) - * [Run offline demo](https://github.com/ApolloAuto/apollo/blob/master/docs/demo_guide/README.md "Run offline demo") - - -## Software architecture and principles -> Learn Apollo software architecture and principles of core modules - - * [Apollo software architecture](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/Apollo_2.0_Software_Architecture.md "Apollo software architecture") - * [3D Obstacle Perception](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/3d_obstacle_perception.md) - * [Apollo 2.5 Perception](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/perception_apollo_2.5.md) - * [QP-Spline-Path Optimizer](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/qp_spline_path_optimizer.md) - * [QP-Spline-ST-Speed Optimizer](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/qp_spline_st_speed_optimizer.md) - * [Reference Line Smoother](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/reference_line_smoother.md) - * [Traffic Light Perception](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/traffic_light.md) - - -## Software modules and extension -> Learn Apollo software modules and extension - - * [Canbus module](https://github.com/ApolloAuto/apollo/blob/master/modules/canbus/README.md) - * [Common module](https://github.com/ApolloAuto/apollo/blob/master/modules/common/README.md) - * [Control module](https://github.com/ApolloAuto/apollo/blob/master/modules/control/README.md) - * [Data module](https://github.com/ApolloAuto/apollo/blob/master/modules/data/README.md) - * [Localization module](https://github.com/ApolloAuto/apollo/blob/master/modules/localization/README.md) - * [Perception module](https://github.com/ApolloAuto/apollo/blob/master/modules/perception/README.md) - * [Planning module](https://github.com/ApolloAuto/apollo/blob/master/modules/planning/README.md) - * [Prediction module](https://github.com/ApolloAuto/apollo/blob/master/modules/prediction/README.md) - * [Routing module](https://github.com/ApolloAuto/apollo/blob/master/modules/routing/README.md) - - * [How to Add a New GPS Receiver](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_gps_receiver.md "How to add a new GPS Receiver") - * [How to Add a New CAN Card](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_can_card.md "How to Add a New CAN Card") - * [How to Add a New Control Algorithm](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_control_algorithm.md "How to Add a New Control Algorithm") - * [How to Add a New Evaluator in Prediction Module](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_evaluator_in_prediction_module.md) - * [How to Add a New Predictor in Prediction Module](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_predictor_in_prediction_module.md) - * [How to Add a New Vehicle](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_a_new_vehicle.md) - * [How to Add a New External Dependency](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_add_an_external_dependency.md) - - -## Developer-Friendliness -> Learn Apollo developer tools - - * [Apollo 2.5 map collection guide](https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_2_5_map_collection_guide.md "Apollo 2.5 map collection guide") - * [How to build and debug Apollo in VSCode](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_build_and_debug_apollo_in_vscode_cn.md "How to build and debug Apollo in VSCode") - * [How to use Apollo 2.5 navigation mode](https://github.com/ApolloAuto/apollo/blob/master/docs/howto/how_to_use_apollo_2.5_navigation_mode_cn.md "[How to use Apollo 2.5 navigation mode") - * [Introduction of Dreamview](https://github.com/ApolloAuto/apollo/blob/master/docs/specs/dreamview_usage_table.md "Introduction of Dreamview") - - -- GitLab