Add more options for configuring compilers #453

theotherjimmy · 2017-03-15T20:29:43Z

We added a few more options for configuring compilers in the mbed-os
tools, so I'm adding those options to the readme here. The new options
are:

Setting env variables
PATH detection

Further, I updated the order of the subsections to reflect their
priority. Things earlier in the list configure the compiler in preference
to things later in the list.

Finally, there is one edit for consistency. Previously we had a command
line blah --global blah blah and in the text it referred to -G.
I changed the command line to be consistent

Reviews/Requests for edits:

bridadan

Few little nits, but great changes!

bridadan · 2017-03-15T20:58:42Z

README.md

+There are multiple ways to do this:
+* `mbed_settings.py` file in the root of your program, which is automatically created if it doesn't already exist. 
+* The mbed CLI configuration
+* setting an environment variable


Probably make the 's' of "setting" capital here, to make it consistent with the others.

bridadan · 2017-03-15T20:59:33Z

README.md

+
+* If you want to use the [ARM Compiler toolchain](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads), set `ARM_PATH` to the *base* directory of your ARM Compiler installation (example: C:\Program Files\ARM\armcc5.06). The recommended version of the ARM Compiler toolchain is 5.06.
+* If you want to use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set `GCC_ARM_PATH` to the *binary* directory of your GCC ARM installation (example: C:\Program Files\GNU Tools ARM Embedded\4.9 2015q2\bin). Use versions 4.9 of GCC ARM Embedded; version 5.0 or any version above might be incompatible with the tools.
+


I realize IAR wasn't part of these instructions before, but would you mind adding it here?

AnotherButler

Nice work. I have a few questions, mostly so I can change passive voice to active voice if applicable.

AnotherButler · 2017-03-15T21:02:50Z

README.md

-* Through the mbed CLI configuration.
-* Via mbed_settings.py file in the root of your program, which is automatically created (if it doesn't already exist). 
+There are multiple ways to do this:
+* `mbed_settings.py` file in the root of your program, which is automatically created if it doesn't already exist. 


What automatically creates this? CLI?

AnotherButler · 2017-03-15T21:06:14Z

README.md


-Edit `mbed_settings.py` to set your toolchain:
+For each of the compilers, there is a corresponding environment variable that is checked for the path to that compiler. The environment variables are as follows:


What checks the environment variable for the path to that compiler? The compiler?

AnotherButler · 2017-03-15T21:09:12Z

README.md


-Edit `mbed_settings.py` to set your toolchain:
+For each of the compilers, there is a corresponding environment variable that is checked for the path to that compiler. The environment variables are as follows:
+* `MBED_ARM_PATH`: The path to the *base* directory of your ARM Compiler installation. This should be one directory up the directory containing the binaries for `armcc` and friends.


Does this mean the directory above or before the directory containing the binaries for armcc, or does this mean something else?

it's the directory containing the directory containing armcc. That's a mouthful. I'm open to suggestions to fix it.

screamerbg · 2017-03-15T21:40:06Z

Thanks for aligning functionality and docs @theotherjimmy +1.
See @AnotherButler's comments.

theotherjimmy · 2017-03-15T22:16:17Z

@AnotherButler I changed the passive voice you pointed out to active. I also tried to clarify what a base directory is.
@bridadan I fixed the nit. I added IAR.

Could you both review again?

bridadan

One little nit with the IAR bit, but otherwise looks great 👍

bridadan · 2017-03-16T01:29:41Z

README.md

+
+* To use the [ARM Compiler toolchain](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads), set `ARM_PATH` to the *base* directory of your ARM Compiler installation (example: C:\Program Files\ARM\armcc5.06). The recommended version of the ARM Compiler toolchain is 5.06.
+* To use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set `GCC_ARM_PATH` to the *binary* directory of your GCC ARM installation (example: C:\Program Files\GNU Tools ARM Embedded\4.9 2015q2\bin). Use versions 4.9 of GCC ARM Embedded; version 5.0 or any version above might be incompatible with the tools.
+* To use the [IAR EWARM toolhain](https://www.iar.com/iar-embedded-workbench/#!?architecture=ARM), set `IAR_PATH` to the *base* directory of your IAR installation. Use versions 7.80 of IAR EWARM; prior versions might be incompatible with the tools.


Last nit! Can you provide an example of the correct directory like above? I always find I forget this myself.

Also: Use versions 7.80 of IAR EWARM;.... I think versions should be version.

AnotherButler

I appreciate the clarification. I added my minor grammar comments. This looks great.

AnotherButler · 2017-03-16T17:16:55Z

README.md

+* The mbed CLI configuration
+* Setting an environment variable
+* Adding directory of the compiler binary to your PATH
+


Please make sure each bullet has a period at the end for consistency.

AnotherButler · 2017-03-16T17:19:15Z

README.md

+Edit `mbed_settings.py` to set your toolchain:
+
+* To use the [ARM Compiler toolchain](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads), set `ARM_PATH` to the *base* directory of your ARM Compiler installation (example: C:\Program Files\ARM\armcc5.06). The recommended version of the ARM Compiler toolchain is 5.06.
+* To use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set `GCC_ARM_PATH` to the *binary* directory of your GCC ARM installation (example: C:\Program Files\GNU Tools ARM Embedded\4.9 2015q2\bin). Use versions 4.9 of GCC ARM Embedded; version 5.0 or any version above might be incompatible with the tools.


Please change "versions 4.9" to "version 4.9" for agreement.
Please change "or any version above" to "or any more recent version" to fit our style.

AnotherButler · 2017-03-16T17:20:29Z

README.md

+* To use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set `GCC_ARM_PATH` to the *binary* directory of your GCC ARM installation (example: C:\Program Files\GNU Tools ARM Embedded\4.9 2015q2\bin). Use versions 4.9 of GCC ARM Embedded; version 5.0 or any version above might be incompatible with the tools.
+* To use the [IAR EWARM toolhain](https://www.iar.com/iar-embedded-workbench/#!?architecture=ARM), set `IAR_PATH` to the *base* directory of your IAR installation. Use versions 7.80 of IAR EWARM; prior versions might be incompatible with the tools.
+
+Since `mbed_settings.py` contains local settings (possibly relevant only to a single OS on a single machine), it should not be checked into version control. 


Please change "Since" to "Because" because "since" implies time, and "because" implies causation.
Please change "it should not be checked" to you should not check it" for active voice.

AnotherButler · 2017-03-16T17:21:15Z

README.md

+For each of the compilers, `mbed compile` checks a corresponding environment variable for the compiler's location. The environment variables are as follows:
+* `MBED_ARM_PATH`: The path to the *base* directory of your ARM Compiler installation. This should be the directory containing the directory containing the binaries for `armcc` and friends.
+* `MBED_IAR_PATH`: The path to the *base* directory of your IAR EWARM Compiler installation. This should be one directory containing the directory containing the binaries for `iccarm` and friends.
+* `MBED_GCC_ARM_PATH`: The path to the *binary* directory of your GCC ARM Embedded Compiler installation. This should be the directory containing the binaries for `arm-none-eabi-gcc` and friends.


Thanks for clarifying this.

AnotherButler · 2017-03-16T17:22:42Z

README.md


-As a rule, because `mbed_settings.py` contains local settings (possibly relevant only to a single OS on a single machine), it should not be versioned. 
+If none of the above have been configured, the `mbed compile` command will fall back to checking your `PATH` for an executable that is part of the compiler suite in question. This check is the same as a shell would perform to find the executable on the command line. When it finds the executable it's looking for, it uses the location of that executable as the appropriate path except in the case of GCC, which will not use a path in this case.


Please change "none of the above have" to "none of the above has" for agreement.
Please hyphenate "command-line".
Please change "which will not use a path in this case" to "which does not use a path" to eliminate the repetition and for consistent tense.

We added a few more options for configuring compilers in the mbed-os tools, so I'm adding those options to the readme here. The new options are: - Setting env variables - `PATH` detection Further, I updated the order of the subsections to reflect their priority. Things earlier in the list configure the compiler in preference to things later in the list. Finally, there is one edit for consistency. Previously we had a command line `blah --global blah blah` and in the text it referred to `-G`. I changed the command line to be consistent

theotherjimmy · 2017-03-20T19:53:52Z

@AnotherButler I re-wrote the patch again to include you second set of suggestions. Could you review again?

I think we should go over this whole file together soon and edit the whole thing.

Compiler configuration section not included because of open PR ARMmbed#453

screamerbg · 2017-03-22T13:27:45Z

@AnotherButler Can you please review?

AnotherButler · 2017-03-22T15:27:37Z

@screamerbg This looks good to me. theotherjimmy and I put together another PR with some grammar changes for the other sections that this PR did not change, so we've been over the whole document. It looks good.

screamerbg · 2017-03-23T14:36:14Z

Thanks @theotherjimmy @AnotherButler

theotherjimmy force-pushed the docs-compiler-conf branch from 2faf6a3 to 76fd8cc Compare March 15, 2017 20:32

bridadan approved these changes Mar 15, 2017

View reviewed changes

AnotherButler reviewed Mar 15, 2017

View reviewed changes

theotherjimmy force-pushed the docs-compiler-conf branch 3 times, most recently from a9b0daf to a64ffc1 Compare March 15, 2017 22:14

bridadan reviewed Mar 16, 2017

View reviewed changes

AnotherButler reviewed Mar 16, 2017

View reviewed changes

theotherjimmy force-pushed the docs-compiler-conf branch from a64ffc1 to 6bf5efc Compare March 20, 2017 19:51

AnotherButler pushed a commit to AnotherButler/mbed-cli that referenced this pull request Mar 20, 2017

Update for active voice, clarity and grammar

dbdd7f1

Compiler configuration section not included because of open PR ARMmbed#453

AnotherButler mentioned this pull request Mar 22, 2017

Update for active voice, clarity and grammar #457

Merged

screamerbg merged commit 98aab16 into ARMmbed:master Mar 23, 2017


		* If you want to use the [ARM Compiler toolchain](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads), set `ARM_PATH` to the base directory of your ARM Compiler installation (example: C:\Program Files\ARM\armcc5.06). The recommended version of the ARM Compiler toolchain is 5.06.
		* If you want to use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set `GCC_ARM_PATH` to the binary directory of your GCC ARM installation (example: C:\Program Files\GNU Tools ARM Embedded\4.9 2015q2\bin). Use versions 4.9 of GCC ARM Embedded; version 5.0 or any version above might be incompatible with the tools.


		Edit `mbed_settings.py` to set your toolchain:
		For each of the compilers, there is a corresponding environment variable that is checked for the path to that compiler. The environment variables are as follows:


		As a rule, because `mbed_settings.py` contains local settings (possibly relevant only to a single OS on a single machine), it should not be versioned.
		If none of the above have been configured, the `mbed compile` command will fall back to checking your `PATH` for an executable that is part of the compiler suite in question. This check is the same as a shell would perform to find the executable on the command line. When it finds the executable it's looking for, it uses the location of that executable as the appropriate path except in the case of GCC, which will not use a path in this case.

Add more options for configuring compilers #453

Add more options for configuring compilers #453

Uh oh!

Conversation

theotherjimmy commented Mar 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bridadan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnotherButler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

screamerbg commented Mar 15, 2017

Uh oh!

theotherjimmy commented Mar 15, 2017

Uh oh!

bridadan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnotherButler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

theotherjimmy commented Mar 20, 2017

Uh oh!

screamerbg commented Mar 22, 2017

Uh oh!

AnotherButler commented Mar 22, 2017

Uh oh!

screamerbg commented Mar 23, 2017

Uh oh!

Uh oh!

theotherjimmy commented Mar 15, 2017 •

edited

Loading