Skip to content

Commit a71f209

Browse files
Merge pull request #3694 from iNavFlight/jh_update_ubuntu_build_document
update Ubuntu dev document to use the PPA compiler for all instances
2 parents 6529b6f + 72740d0 commit a71f209

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/development/Building in Ubuntu.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
iNav requires a reasonably modern `gcc-arm-none-eabi` compiler. As a consequence of the long term support options in Ubuntu, it is possible that the distribution compiler will be too old to build iNav firmware. For example, Ubuntu 16.04 LTS ships with version 4.9.3 which cannot compile contemporary iNav.
44

5-
As of March 2018, the recommendation for Ubuntu releases is:
5+
As of August 2018, the recommendation for Ubuntu releases is:
66

77
| Release | Compiler Source |
88
| ------- | --------------- |
99
| 16.04 or earlier | Use the 'official' PPA |
1010
| 17.10 | Use the 'official' PPA as the distro compiler (5.4) *may* be too old |
11-
| 18.04 | Use the distro compiler (6.3+) |
11+
| 18.04 | Use the 'official' PPA, as the distro compiler (6.3) was broken when last tested |
1212

1313
For Ubuntu derivatives (ElementaryOS, Mint etc.), please check the distro provided version, and if it's lower than 6, use the PPA.
1414

@@ -47,14 +47,15 @@ sudo apt-get install ruby2.4 ruby2.4-dev
4747

4848
# Using the Distro compiler
4949

50-
For Releases after 17.10 is is recommended to use the distro provided compiler, at least until it proves to be too old.
50+
In case Ubuntu ever provides a modern compiler (as of August 2018, not recommended):
51+
5152
```
5253
sudo apt install gcc-arm-none-eabi
5354
```
5455

5556
# Using the PPA compiler
5657

57-
For releases prior to (and perhaps including) 17.10, the PPA compiler is used. This can be used on releases post 17.10 if you really wish to have a newer compiler than the distro default.
58+
The PPA compiler is recommended for all cases:
5859

5960
```
6061
sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi
@@ -84,17 +85,17 @@ cd inav
8485
make
8586
```
8687

87-
If you have a github account with registered ssh key you can replace the `git clone` command with `git clone https://github.com/iNavFlight/inav.git` instead of the https link.
88+
If you have a github account with registered ssh key you can replace the `git clone` command with `git clone git@github.com:iNavFlight/inav.git` instead of the https link.
8889

89-
By default, this builds the SPRACINGF3 target, to build another target, specify the target name to the make command, for example:
90+
By default, this builds the REVO target, to build another target, specify the target name to the make command, for example:
9091
```
9192
make TARGET=MATEKF405
9293
```
9394
The resultant hex file are in the `obj/` directory.
9495

9596
You can use the INAV Configurator to flash the local ```obj/inav_TARGET.hex``` file, or use `stm32flash` or `dfu-util` directly from the command line.
9697

97-
https://github.com/fiam/msp-tool and https://github.com/stronnag/mwptools/blob/master/docs/MiscTools.asciidoc#flashsh provide / describe helper tools for command line flashing.
98+
[msp-tool](https://github.com/fiam/msp-tool) and [flash.sh](https://github.com/stronnag/mwptools/blob/master/docs/MiscTools.asciidoc#flashsh) provide / describe 3rd party helper tools for command line flashing.
9899

99100
# Updating and rebuilding
100101

0 commit comments

Comments
 (0)