From 8236b8da81a3d256c2bca2d89a056afda919d7d2 Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Mon, 20 Apr 2020 11:22:33 +1000 Subject: [PATCH] Fix up doc links to point to master branch --- .github/ISSUE_TEMPLATE/1_Bug_report.md | 2 +- README.md | 18 +++++++++--------- .../init.d/airframes/3031_phantom | 2 +- .../init.d/airframes/3033_wingwing | 2 +- .../px4fmu_common/init.d/airframes/4051_s250aq | 2 +- .../init.d/airframes/4052_holybro_qav250 | 2 +- Tools/px_uploader.py | 2 +- .../leddar_one/leddar_one_main.cpp | 2 +- src/drivers/distance_sensor/ll40ls/ll40ls.cpp | 2 +- .../distance_sensor/ll40ls_pwm/ll40ls.cpp | 2 +- src/drivers/distance_sensor/sf0x/sf0x_main.cpp | 2 +- src/drivers/distance_sensor/sf1xx/sf1xx.cpp | 2 +- .../teraranger/teraranger_main.cpp | 2 +- .../distance_sensor/tfmini/tfmini_main.cpp | 2 +- src/modules/ekf2/ekf2_main.cpp | 2 +- src/modules/micrortps_bridge/README.md | 2 +- src/modules/replay/Replay.cpp | 2 +- src/modules/vmount/vmount.cpp | 2 +- src/systemcmds/ver/ver.c | 2 +- 19 files changed, 27 insertions(+), 27 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_Bug_report.md b/.github/ISSUE_TEMPLATE/1_Bug_report.md index ded792c26d..128e17663c 100644 --- a/.github/ISSUE_TEMPLATE/1_Bug_report.md +++ b/.github/ISSUE_TEMPLATE/1_Bug_report.md @@ -19,7 +19,7 @@ A clear and concise description of what you expected to happen. **Log Files and Screenshots** *Always* provide a link to the flight log file: -- Download the flight log file from the vehicle ([tutorial](https://docs.px4.io/en/getting_started/flight_reporting.html)). +- Download the flight log file from the vehicle ([tutorial](https://docs.px4.io/master/en/getting_started/flight_reporting.html)). - Share the link to a log showing the problem on [PX4 Flight Review](http://logs.px4.io/). Add screenshots to help explain your problem. diff --git a/README.md b/README.md index 2eb0f4045f..ce4a06136f 100644 --- a/README.md +++ b/README.md @@ -9,31 +9,31 @@ This repository holds the [PX4](http://px4.io) flight control solution for drones, with the main applications located in the [src/modules](https://github.com/PX4/Firmware/tree/master/src/modules) directory. It also contains the PX4 Drone Middleware Platform, which provides drivers and middleware to run drones. * Official Website: http://px4.io (License: BSD 3-clause, [LICENSE](https://github.com/PX4/Firmware/blob/master/LICENSE)) -* [Supported airframes](https://docs.px4.io/en/airframes/airframe_reference.html) ([portfolio](http://px4.io/#airframes)): - * [Multicopters](https://docs.px4.io/en/airframes/airframe_reference.html#copter) - * [Fixed wing](https://docs.px4.io/en/airframes/airframe_reference.html#plane) - * [VTOL](https://docs.px4.io/en/airframes/airframe_reference.html#vtol) +* [Supported airframes](https://docs.px4.io/master/en/airframes/airframe_reference.html) ([portfolio](http://px4.io/#airframes)): + * [Multicopters](https://docs.px4.io/master/en/airframes/airframe_reference.html#copter) + * [Fixed wing](https://docs.px4.io/master/en/airframes/airframe_reference.html#plane) + * [VTOL](https://docs.px4.io/master/en/airframes/airframe_reference.html#vtol) * many more experimental types (Rovers, Blimps, Boats, Submarines, Autogyros, etc) * Releases: [Downloads](https://github.com/PX4/Firmware/releases) ## PX4 Users -The [PX4 User Guide](https://docs.px4.io/en/) explains how to assemble [supported vehicles](https://docs.px4.io/en/airframes/airframe_reference.html) and fly drones with PX4. -See the [forum and chat](https://docs.px4.io/en/#support) if you need help! +The [PX4 User Guide](https://docs.px4.io/master/en/) explains how to assemble [supported vehicles](https://docs.px4.io/master/en/airframes/airframe_reference.html) and fly drones with PX4. +See the [forum and chat](https://docs.px4.io/master/en/#support) if you need help! ## PX4 Developers This [Developer Guide](https://dev.px4.io/) is for software developers who want to modify the flight stack and middleware (e.g. to add new flight modes), hardware integrators who want to support new flight controller boards and peripherals, and anyone who wants to get PX4 working on a new (unsupported) airframe/vehicle. -Developers should read the [Guide for Contributions](https://dev.px4.io/en/contribute/). -See the [forum and chat](https://dev.px4.io/en/#support) if you need help! +Developers should read the [Guide for Contributions](https://dev.px4.io/master/en/contribute/). +See the [forum and chat](https://dev.px4.io/master/en/#support) if you need help! ### Weekly Dev Call -The PX4 Dev Team syncs up on a [weekly dev call](https://dev.px4.io/en/contribute/#dev_call). +The PX4 Dev Team syncs up on a [weekly dev call](https://dev.px4.io/master/en/contribute/#dev_call). > **Note** The dev call is open to all interested developers (not just the core dev team). This is a great opportunity to meet the team and contribute to the ongoing development of the platform. It includes a QA session for newcomers. All regular calls are listed in the [Dronecode calendar](https://www.dronecode.org/calendar/). diff --git a/ROMFS/px4fmu_common/init.d/airframes/3031_phantom b/ROMFS/px4fmu_common/init.d/airframes/3031_phantom index 7d1f46c62b..0ee7d347a7 100644 --- a/ROMFS/px4fmu_common/init.d/airframes/3031_phantom +++ b/ROMFS/px4fmu_common/init.d/airframes/3031_phantom @@ -2,7 +2,7 @@ # # @name Phantom FPV Flying Wing # -# @url https://docs.px4.io/en/frames_plane/wing_wing_z84.html +# @url https://docs.px4.io/master/en/frames_plane/wing_wing_z84.html # # @type Flying Wing # @class Plane diff --git a/ROMFS/px4fmu_common/init.d/airframes/3033_wingwing b/ROMFS/px4fmu_common/init.d/airframes/3033_wingwing index 3135485f22..4579284912 100644 --- a/ROMFS/px4fmu_common/init.d/airframes/3033_wingwing +++ b/ROMFS/px4fmu_common/init.d/airframes/3033_wingwing @@ -2,7 +2,7 @@ # # @name Wing Wing (aka Z-84) Flying Wing # -# @url https://docs.px4.io/en/framebuild_plane/wing_wing_z84.html +# @url https://docs.px4.io/master/en/framebuild_plane/wing_wing_z84.html # # @type Flying Wing # @class Plane diff --git a/ROMFS/px4fmu_common/init.d/airframes/4051_s250aq b/ROMFS/px4fmu_common/init.d/airframes/4051_s250aq index 2d66e262d3..b14c275ee5 100644 --- a/ROMFS/px4fmu_common/init.d/airframes/4051_s250aq +++ b/ROMFS/px4fmu_common/init.d/airframes/4051_s250aq @@ -1,7 +1,7 @@ #!/bin/sh # # @name Spedix S250AQ -# @url https://docs.px4.io/en/framebuild_multicopter/spedix_s250_pixracer.html +# @url https://docs.px4.io/master/en/framebuild_multicopter/spedix_s250_pixracer.html # # @type Quadrotor asymmetric # @class Copter diff --git a/ROMFS/px4fmu_common/init.d/airframes/4052_holybro_qav250 b/ROMFS/px4fmu_common/init.d/airframes/4052_holybro_qav250 index d76d93fe6a..bc188ee1e6 100644 --- a/ROMFS/px4fmu_common/init.d/airframes/4052_holybro_qav250 +++ b/ROMFS/px4fmu_common/init.d/airframes/4052_holybro_qav250 @@ -2,7 +2,7 @@ # # @name HolyBro QAV250 # -# @url https://docs.px4.io/en/frames_multicopter/holybro_qav250_pixhawk4_mini.html +# @url https://docs.px4.io/master/en/frames_multicopter/holybro_qav250_pixhawk4_mini.html # # @type Quadrotor x # @class Copter diff --git a/Tools/px_uploader.py b/Tools/px_uploader.py index 68159db068..b783eae54b 100755 --- a/Tools/px_uploader.py +++ b/Tools/px_uploader.py @@ -322,7 +322,7 @@ class uploader(object): except NotImplementedError: raise RuntimeError("Programing not supported for this version of silicon!\n" - "See https://docs.px4.io/en/flight_controller/silicon_errata.html") + "See https://docs.px4.io/master/en/flight_controller/silicon_errata.html") except RuntimeError: # timeout, no response yet return False diff --git a/src/drivers/distance_sensor/leddar_one/leddar_one_main.cpp b/src/drivers/distance_sensor/leddar_one/leddar_one_main.cpp index 9f074f4c72..da07bd85e5 100644 --- a/src/drivers/distance_sensor/leddar_one/leddar_one_main.cpp +++ b/src/drivers/distance_sensor/leddar_one/leddar_one_main.cpp @@ -103,7 +103,7 @@ Serial bus driver for the LeddarOne LiDAR. Most boards are configured to enable/start the driver on a specified UART using the SENS_LEDDAR1_CFG parameter. -Setup/usage information: https://docs.px4.io/en/sensor/leddar_one.html +Setup/usage information: https://docs.px4.io/master/en/sensor/leddar_one.html ### Examples diff --git a/src/drivers/distance_sensor/ll40ls/ll40ls.cpp b/src/drivers/distance_sensor/ll40ls/ll40ls.cpp index ee5c52d78c..4f16fe5314 100644 --- a/src/drivers/distance_sensor/ll40ls/ll40ls.cpp +++ b/src/drivers/distance_sensor/ll40ls/ll40ls.cpp @@ -57,7 +57,7 @@ I2C bus driver for LidarLite rangefinders. The sensor/driver must be enabled using the parameter SENS_EN_LL40LS. -Setup/usage information: https://docs.px4.io/en/sensor/lidar_lite.html +Setup/usage information: https://docs.px4.io/master/en/sensor/lidar_lite.html )DESCR_STR"); PRINT_MODULE_USAGE_NAME("ll40ls", "driver"); diff --git a/src/drivers/distance_sensor/ll40ls_pwm/ll40ls.cpp b/src/drivers/distance_sensor/ll40ls_pwm/ll40ls.cpp index cd793cab52..dc54681fd3 100644 --- a/src/drivers/distance_sensor/ll40ls_pwm/ll40ls.cpp +++ b/src/drivers/distance_sensor/ll40ls_pwm/ll40ls.cpp @@ -147,7 +147,7 @@ PWM driver for LidarLite rangefinders. The sensor/driver must be enabled using the parameter SENS_EN_LL40LS. -Setup/usage information: https://docs.px4.io/en/sensor/lidar_lite.html +Setup/usage information: https://docs.px4.io/master/en/sensor/lidar_lite.html )DESCR_STR"); PRINT_MODULE_USAGE_NAME("ll40ls", "driver"); diff --git a/src/drivers/distance_sensor/sf0x/sf0x_main.cpp b/src/drivers/distance_sensor/sf0x/sf0x_main.cpp index 0ab7ef9136..57838a38cf 100644 --- a/src/drivers/distance_sensor/sf0x/sf0x_main.cpp +++ b/src/drivers/distance_sensor/sf0x/sf0x_main.cpp @@ -104,7 +104,7 @@ Serial bus driver for the LightWare SF02/F, SF10/a, SF10/b, SF10/c, SF11/c Laser Most boards are configured to enable/start the driver on a specified UART using the SENS_SF0X_CFG parameter. -Setup/usage information: https://docs.px4.io/en/sensor/sfxx_lidar.html +Setup/usage information: https://docs.px4.io/master/en/sensor/sfxx_lidar.html ### Examples diff --git a/src/drivers/distance_sensor/sf1xx/sf1xx.cpp b/src/drivers/distance_sensor/sf1xx/sf1xx.cpp index 8a32458147..637fbf6b2c 100644 --- a/src/drivers/distance_sensor/sf1xx/sf1xx.cpp +++ b/src/drivers/distance_sensor/sf1xx/sf1xx.cpp @@ -289,7 +289,7 @@ void SF1XX::print_usage() I2C bus driver for Lightware SFxx series LIDAR rangefinders: SF10/a, SF10/b, SF10/c, SF11/c, SF/LW20. -Setup/usage information: https://docs.px4.io/en/sensor/sfxx_lidar.html +Setup/usage information: https://docs.px4.io/master/en/sensor/sfxx_lidar.html )DESCR_STR"); PRINT_MODULE_USAGE_NAME("sf1xx", "driver"); diff --git a/src/drivers/distance_sensor/teraranger/teraranger_main.cpp b/src/drivers/distance_sensor/teraranger/teraranger_main.cpp index 4c1c6be528..ac31394d3a 100644 --- a/src/drivers/distance_sensor/teraranger/teraranger_main.cpp +++ b/src/drivers/distance_sensor/teraranger/teraranger_main.cpp @@ -47,7 +47,7 @@ I2C bus driver for TeraRanger rangefinders. The sensor/driver must be enabled using the parameter SENS_EN_TRANGER. -Setup/usage information: https://docs.px4.io/en/sensor/rangefinders.html#teraranger-rangefinders +Setup/usage information: https://docs.px4.io/master/en/sensor/rangefinders.html#teraranger-rangefinders )DESCR_STR"); PRINT_MODULE_USAGE_NAME("teraranger", "driver"); PRINT_MODULE_USAGE_SUBCATEGORY("distance_sensor"); diff --git a/src/drivers/distance_sensor/tfmini/tfmini_main.cpp b/src/drivers/distance_sensor/tfmini/tfmini_main.cpp index 4425ab80ff..6f3b1bfd1c 100644 --- a/src/drivers/distance_sensor/tfmini/tfmini_main.cpp +++ b/src/drivers/distance_sensor/tfmini/tfmini_main.cpp @@ -115,7 +115,7 @@ Serial bus driver for the Benewake TFmini LiDAR. Most boards are configured to enable/start the driver on a specified UART using the SENS_TFMINI_CFG parameter. -Setup/usage information: https://docs.px4.io/en/sensor/tfmini.html +Setup/usage information: https://docs.px4.io/master/en/sensor/tfmini.html ### Examples diff --git a/src/modules/ekf2/ekf2_main.cpp b/src/modules/ekf2/ekf2_main.cpp index 9b5a358eb8..83c073c5eb 100644 --- a/src/modules/ekf2/ekf2_main.cpp +++ b/src/modules/ekf2/ekf2_main.cpp @@ -2448,7 +2448,7 @@ int Ekf2::print_usage(const char *reason) ### Description Attitude and position estimator using an Extended Kalman Filter. It is used for Multirotors and Fixed-Wing. -The documentation can be found on the [ECL/EKF Overview & Tuning](https://docs.px4.io/en/advanced_config/tuning_the_ecl_ekf.html) page. +The documentation can be found on the [ECL/EKF Overview & Tuning](https://docs.px4.io/master/en/advanced_config/tuning_the_ecl_ekf.html) page. ekf2 can be started in replay mode (`-r`): in this mode it does not access the system time, but only uses the timestamps from the sensor topics. diff --git a/src/modules/micrortps_bridge/README.md b/src/modules/micrortps_bridge/README.md index 5c9760cd6e..22e86f1d48 100644 --- a/src/modules/micrortps_bridge/README.md +++ b/src/modules/micrortps_bridge/README.md @@ -1 +1 @@ -For see a complete documentation, please follow this [link](https://dev.px4.io/en/middleware/micrortps.html) +For see a complete documentation, please follow this [link](https://dev.px4.io/master/en/middleware/micrortps.html) diff --git a/src/modules/replay/Replay.cpp b/src/modules/replay/Replay.cpp index a8fb1fef21..00c2012ffe 100644 --- a/src/modules/replay/Replay.cpp +++ b/src/modules/replay/Replay.cpp @@ -1055,7 +1055,7 @@ The module is typically used together with uORB publisher rules, to specify whic The replay module will just publish all messages that are found in the log. It also applies the parameters from the log. -The replay procedure is documented on the [System-wide Replay](https://dev.px4.io/en/debug/system_wide_replay.html) +The replay procedure is documented on the [System-wide Replay](https://dev.px4.io/master/en/debug/system_wide_replay.html) page. )DESCR_STR"); diff --git a/src/modules/vmount/vmount.cpp b/src/modules/vmount/vmount.cpp index ee23062cef..316c2f84bd 100644 --- a/src/modules/vmount/vmount.cpp +++ b/src/modules/vmount/vmount.cpp @@ -601,7 +601,7 @@ static void usage() Mount (Gimbal) control driver. It maps several different input methods (eg. RC or MAVLink) to a configured output (eg. AUX channels or MAVLink). -Documentation how to use it is on the [gimbal_control](https://dev.px4.io/en/advanced/gimbal_control.html) page. +Documentation how to use it is on the [gimbal_control](https://dev.px4.io/master/en/advanced/gimbal_control.html) page. ### Implementation Each method is implemented in its own class, and there is a common base class for inputs and outputs. diff --git a/src/systemcmds/ver/ver.c b/src/systemcmds/ver/ver.c index 36dc62cb0a..34806eb291 100644 --- a/src/systemcmds/ver/ver.c +++ b/src/systemcmds/ver/ver.c @@ -250,7 +250,7 @@ int ver_main(int argc, char *argv[]) printf("\nWARNING WARNING WARNING!\n" "Revision %c has a silicon errata:\n" "%s" - "\nhttps://docs.px4.io/en/flight_controller/silicon_errata.html\n\n", rev, errata); + "\nhttps://docs.px4.io/master/en/flight_controller/silicon_errata.html\n\n", rev, errata); } }