Browse Source

Fix up internal links as external links (#10907)

QGC4.4
Hamish Willee 1 year ago committed by Julian Oes
parent
commit
59ff1a99b1
No known key found for this signature in database
GPG Key ID: F0ED380FEA56DE41
  1. 10
      docs/en/qgc-dev-guide/command_line_options.md
  2. 33
      docs/en/qgc-dev-guide/getting_started/index.md
  3. 10
      docs/en/qgc-dev-guide/tools/index.md
  4. 2
      docs/en/qgc-user-guide/getting_started/download_and_install.md
  5. 2
      docs/en/qgc-user-guide/index.md
  6. 2
      docs/en/qgc-user-guide/releases/stable_v3.2_long.md
  7. 17
      docs/en/qgc-user-guide/settings_view/console_logging.md

10
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 ** @@ -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
```
@ -31,9 +31,9 @@ Linux Terminal: @@ -31,9 +31,9 @@ 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` | 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. |

33
docs/en/qgc-dev-guide/getting_started/index.md

@ -9,7 +9,8 @@ It also provides information about optional or OS specific functionality. @@ -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 @@ -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: @@ -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: @@ -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: @@ -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
```

10
docs/en/qgc-dev-guide/tools/index.md

@ -11,10 +11,6 @@ and accessing the System Shell over MAVLink. @@ -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.

2
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 @@ -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:
<!-- match version using https://dev.qgroundcontrol.com/master/en/getting_started/#native-builds -->
<!-- match version using https://docs.qgroundcontrol.com/master/en/qgc-dev-guide/getting_started/#native-builds -->
<!-- usually based on Qt macOS dependency -->
1. Download [QGroundControl.dmg](https://d176tv9ibo4jno.cloudfront.net/latest/QGroundControl.dmg).

2
docs/en/qgc-user-guide/index.md

@ -23,5 +23,5 @@ The information provided should be correct, but you may find missing information @@ -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.
:::

2
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. @@ -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

17
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. @@ -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.

Loading…
Cancel
Save