diff --git a/docs/en/qgc-dev-guide/command_line_options.md b/docs/en/qgc-dev-guide/command_line_options.md index a681d27..215e47b 100644 --- a/docs/en/qgc-dev-guide/command_line_options.md +++ b/docs/en/qgc-dev-guide/command_line_options.md @@ -8,21 +8,21 @@ You will need to open a command prompt or terminal, change directory to where ** Windows Command Prompt: -```bash +```sh cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full ``` OSX Terminal app (**Applications/Utilities**): -```bash +```sh cd /Applications/qgroundcontrol.app/Contents/MacOS/ ./qgroundcontrol --logging:full ``` Linux Terminal: -```bash +```sh ./qgroundcontrol-start.sh --logging:full ``` @@ -30,16 +30,16 @@ Linux Terminal: The options/command line arguments are listed in the table below. -| Option | Description | -| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). | -| `--logging:full` | Turns on full logging. See [Console Logging](https://docs.qgroundcontrol.com/en/settings_view/console_logging.html#logging-from-the-command-line). | -| `--logging:full,LinkManagerVerboseLog,ParameterLoaderLog` | Turns on full logging and turns off the following listed comma-separated logging options. | -| `--logging:LinkManagerLog,ParameterLoaderLog` | Turns on the specified comma separated logging options | -| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. | -| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. | -| `--fake-mobile` | Simulates running on a mobile device. | -| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. | +| Option | Description | +| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). | +| `--logging:full` | Turns on full logging. See [Console Logging](../../qgc-user-guide/settings_view/console_logging.html#logging-from-the-command-line). | +| `--logging:full,LinkManagerVerboseLog,ParameterLoaderLog` | Turns on full logging and turns off the following listed comma-separated logging options. | +| `--logging:LinkManagerLog,ParameterLoaderLog` | Turns on the specified comma separated logging options | +| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. | +| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. | +| `--fake-mobile` | Simulates running on a mobile device. | +| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. | Notes: diff --git a/docs/en/qgc-dev-guide/getting_started/index.md b/docs/en/qgc-dev-guide/getting_started/index.md index a6e2f3d..173d0d9 100644 --- a/docs/en/qgc-dev-guide/getting_started/index.md +++ b/docs/en/qgc-dev-guide/getting_started/index.md @@ -9,7 +9,8 @@ It also provides information about optional or OS specific functionality. ## Daily Builds -If you just want to test (and not debug) a recent build of _QGroundControl_ you can use the [Daily Build](https://docs.qgroundcontrol.com/en/releases/daily_builds.html). Versions are provided for all platforms. +If you just want to test (and not debug) a recent build of _QGroundControl_ you can use the [Daily Build](../../qgc-user-guide/releases/daily_builds.md). +Versions are provided for all platforms. ## Source Code @@ -19,11 +20,14 @@ It is [dual-licensed under Apache 2.0 and GPLv3](https://github.com/mavlink/qgro To get the source files: 1. Clone the repo (or your fork) including submodules: - ``` + + ```sh git clone --recursive -j8 https://github.com/mavlink/qgroundcontrol.git ``` + 2. Update submodules (required each time you pull new source code): - ``` + + ```sh git submodule update --recursive ``` @@ -133,9 +137,11 @@ To install Qt: ::: - **Ubuntu:** + - Airmap: Create a file named **user_config.pri** (in the repo root directory) containing the text `DEFINES += DISABLE_AIRMAP`. This can be done in a bash terminal using the command: - ``` + + ```sh echo -e "DEFINES += DISABLE_AIRMAP\r\n" | tee user_config.pri ``` @@ -165,22 +171,28 @@ To install Qt: Example commands to build a default QGC and run it afterwards: 1. Make sure you cloned the repository and updated the submodules before, see chapter _Source Code_ above and switch into the repository folder: - ``` + + ```sh cd qgroundcontrol ``` + 1. Create and enter a shadow build directory: - ``` + + ```sh mkdir build cd build ``` + 1. Configure the build using the qmake script in the root of the repository: - ``` + + ```sh qmake ../ ``` + 1. Run make to compile and link. To accelerate the process things you can use the `-j{number of threads}` parameter. - ``` + ```sh make -j12 ``` @@ -188,14 +200,15 @@ Example commands to build a default QGC and run it afterwards: You can also specify build time flags here. For example, you could disable airmap inclusion using the command: - ``` + ```sh DEFINES+=DISABLE_AIRMAP make build ``` ::: 1. Run the QGroundcontrol binary that was just built: - ``` + + ```sh ./staging/QGroundControl ``` diff --git a/docs/en/qgc-dev-guide/tools/index.md b/docs/en/qgc-dev-guide/tools/index.md index 2661bd9..1ec6f58 100644 --- a/docs/en/qgc-dev-guide/tools/index.md +++ b/docs/en/qgc-dev-guide/tools/index.md @@ -11,10 +11,6 @@ and accessing the System Shell over MAVLink. Tools include: - **[Mock Link](../tools/mock_link.md)** (Daily Builds only) - Creates and stops multiple simulated vehicle links. -- **[Replay Flight Data](https://docs.qgroundcontrol.com/en/app_menu/replay_flight_data.html)** - Replay a telemetry log (User Guide). -- **[MAVLink Inspector](https://docs.qgroundcontrol.com/en/app_menu/mavlink_inspector.html)** - Display received MAVLink messages/values. -- **[MAVLink Analyzer](https://docs.qgroundcontrol.com/en/app_menu/mavlink_analyzer.html)** - Plot trends for MAVLink messages/values. -- **[Custom Command Widget](https://docs.qgroundcontrol.com/en/app_menu/custom_command_widget.html)** - Load custom/test QML UI at runtime. -- **[Onboard Files](https://docs.qgroundcontrol.com/en/app_menu/onboard_files.html)** - Navigate vehicle file system and upload/download files. -- **[HIL Config Widget](https://docs.qgroundcontrol.com/en/app_menu/hil_config.html)** - Settings for HIL simulators. -- **[MAVLink Console](https://docs.qgroundcontrol.com/en/analyze_view/mavlink_console.html)** (PX4 Only) - Connect to the PX4 nsh shell and send commands. +- **[Replay Flight Data](../../qgc-user-guide/fly_view/replay_flight_data.md)** - Replay a telemetry log (User Guide). +- **[MAVLink Inspector](../../qgc-user-guide/analyze_view/mavlink_inspector.html)** - Display received MAVLink messages/values and plot trends. +- **[MAVLink Console](../../qgc-user-guide/analyze_view/mavlink_console.html)** (PX4 Only) - Connect to the PX4 nsh shell and send commands. diff --git a/docs/en/qgc-user-guide/getting_started/download_and_install.md b/docs/en/qgc-user-guide/getting_started/download_and_install.md index 6f702fb..02c9762 100644 --- a/docs/en/qgc-user-guide/getting_started/download_and_install.md +++ b/docs/en/qgc-user-guide/getting_started/download_and_install.md @@ -36,7 +36,7 @@ It is possible to manually build 32 bit versions (this is not supported by the d _QGroundControl_ can be installed on macOS 10.11 or later: - + 1. Download [QGroundControl.dmg](https://d176tv9ibo4jno.cloudfront.net/latest/QGroundControl.dmg). diff --git a/docs/en/qgc-user-guide/index.md b/docs/en/qgc-user-guide/index.md index 61b6a3d..660ff78 100644 --- a/docs/en/qgc-user-guide/index.md +++ b/docs/en/qgc-user-guide/index.md @@ -23,5 +23,5 @@ The information provided should be correct, but you may find missing information ::: ::: tip -Information about _QGroundControl_ development, architecture, contributing, and translating can be found in the [Developers Guide](https://dev.qgroundcontrol.com/en/). +Information about _QGroundControl_ development, architecture, contributing, and translating can be found in the [Developer Guide](../qgc-dev-guide/index.md) section. ::: diff --git a/docs/en/qgc-user-guide/releases/stable_v3.2_long.md b/docs/en/qgc-user-guide/releases/stable_v3.2_long.md index 9544ac7..bc3b1a0 100644 --- a/docs/en/qgc-user-guide/releases/stable_v3.2_long.md +++ b/docs/en/qgc-user-guide/releases/stable_v3.2_long.md @@ -47,7 +47,7 @@ This is now supported from the Copy Trims button on the Radio setup page. Previous version of _QGroundControl_ saved missions, geo-fences and rally points in separate files (**.mission**, **.fence**, **.rally**). QGC now save all information related to a flight plan into a single file called a _Plan File_ with a file extension of **.plan**. -Information about the format can be found in [Plan File Format](https://dev.qgroundcontrol.com/en/file_formats/plan.html) (QGC Developer Guide). +Information about the format can be found in [Plan File Format](../../qgc-dev-guide/file_formats/plan.md) (QGC Developer Guide). ### Plan Toolbar diff --git a/docs/en/qgc-user-guide/settings_view/console_logging.md b/docs/en/qgc-user-guide/settings_view/console_logging.md index f4ccd50..575e163 100644 --- a/docs/en/qgc-user-guide/settings_view/console_logging.md +++ b/docs/en/qgc-user-guide/settings_view/console_logging.md @@ -27,22 +27,31 @@ An alternate mechanism for logging is using the `--logging` command line option. How you do this and where the traces are output vary by OS: - Windows + - You must open a command prompt, change directory to the **qgroundcontrol.exe** location, and run it from there: - ```bash + + ```sh cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full ``` + - When _QGroundControl_ starts you should see a separate console window open which will have the log output + - OSX + - You must run _QGroundControl_ from Terminal. The Terminal app is located in Applications/Utilities. Once Terminal is open paste the following into it: - ```bash + + ```sh cd /Applications/qgroundcontrol.app/Contents/MacOS/ ./qgroundcontrol --logging:full ``` + - Log traces will output to the Terminal window. + - Linux - - - ```bash + + ```sh ./qgroundcontrol-start.sh --logging:full ``` + - Log traces will output to the shell you are running from.