mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-04-14 10:07:39 +08:00
88d623bedb
* Add vitepress tree * Update existing workflows so they dont trigger on changes in the docs path * Add nojekyll, package.json, LICENCE etc * Add crowdin docs upload/download scripts * Add docs flaw checker workflows * Used docs prefix for docs workflows * Crowdin obvious fixes * ci: docs move to self hosted runner runs on a beefy server for faster builds Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: don't run build action for docs or ci changes Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: update runners Signed-off-by: Ramon Roche <mrpollo@gmail.com> * Add docs/en * Add docs assets and scripts * Fix up editlinks to point to PX4 sources * Download just the translations that are supported * Add translation sources for zh, uk, ko * Update latest tranlsation and uorb graphs * update vitepress to latest --------- Signed-off-by: Ramon Roche <mrpollo@gmail.com> Co-authored-by: Ramon Roche <mrpollo@gmail.com>
2.2 KiB
2.2 KiB
Maintenance Notes
This picks and describes some tools to help analyze the state of the codebase and support its maintenance.
Analyze churn
The amount of churn, so the number of changes done to a file can be an indicator which files/parts might need refactoring.
To find churn metrics a tool such as Churn can be used:
gem install churn
An example output as of v1.6.0-rc2 would be:
cd src/PX4-Autopilot
churn --start_date "6 months ago"
**********************************************************************
* Revision Changes
**********************************************************************
Files
+------------------------------------------+
| file |
+------------------------------------------+
| src/modules/navigator/mission.cpp |
| src/modules/navigator/navigator_main.cpp |
| src/modules/navigator/rtl.cpp |
+------------------------------------------+
**********************************************************************
* Project Churn
**********************************************************************
Files
+---------------------------------------------------------------------------+---------------+
| file_path | times_changed |
+---------------------------------------------------------------------------+---------------+
| src/modules/mc_pos_control/mc_pos_control_main.cpp | 107 |
| src/modules/commander/commander.cpp | 67 |
| ROMFS/px4fmu_common/init.d/rcS | 52 |
| Makefile | 49 |
| src/drivers/px4fmu/fmu.cpp | 47 |
| ROMFS/px4fmu_common/init.d/rc.sensors | 40 |
| src/drivers/boards/aerofc-v1/board_config.h | 31 |
| src/modules/logger/logger.cpp | 29 |
| src/modules/navigator/navigator_main.cpp | 28 |