Skip to content

Commit 8b53b85

Browse files
obraper1234
andauthored
[skip changelog] Make use of 'avr' as example platform more consistent (#1680)
* Make use of 'avr' as example platform more consistent It's fairly easy to miss the one line early in the doc that says this text uses 'avr' as an example, leading a reader to possibly believe the documentation hasn't been updated since 'avr' was the only platform choice. Within the doc, the text was a little inconsistent as to how it referred to the avr platform and platform specific tools. This change tries to standardize how we refer to the example platform. * Fix a couple lint errors. * Fix prettier lint errors. * Fix an additional prettier lint error * Update docs/sketch-build-process.md Co-authored-by: per1234 <[email protected]> Co-authored-by: per1234 <[email protected]>
1 parent a478b4a commit 8b53b85

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

docs/sketch-build-process.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
The process the Arduino development software uses to build a sketch. More useful information can be found in the
22
[Arduino platform specification](platform-specification.md). Note that the following refers specifically to the build
3-
process for AVR targets. Other architectures will have a similar build process.
3+
process for AVR targets. Other architectures follow a similar build process, but may use other tools and compilers.
44

55
## Overview
66

77
A number of things have to happen for your Arduino code to get onto the Arduino board. First, the Arduino development
88
software performs some minor pre-processing to turn your sketch into a C++ program. Next, dependencies of the sketch are
9-
located. It then gets passed to a compiler (avr-gcc), which turns the human readable code into machine readable
9+
located. It then gets passed to a compiler (e.g, `avr-gcc`), which turns the human readable code into machine readable
1010
instructions (or object files). Then your code gets combined with (linked against) the standard Arduino libraries that
1111
provide basic functions like `digitalWrite()` or `Serial.print()`. The result is a single Intel hex file, which contains
1212
the specific bytes that need to be written to the program memory of the chip on the Arduino board. This file is then
@@ -15,8 +15,8 @@ external programming hardware.
1515

1616
## Pre-Processing
1717

18-
The Arduino development software performs a few transformations to your sketch before passing it to the avr-gcc
19-
compiler:
18+
The Arduino development software performs a few transformations to your sketch before passing it to the compiler (e.g.,
19+
`avr-gcc`):
2020

2121
- All .ino and .pde files in the sketch folder (shown in the Arduino IDE as tabs with no extension) are concatenated
2222
together, starting with the file that matches the folder name followed by the others in alphabetical order. The .cpp
@@ -157,8 +157,8 @@ its cloud-based nature may make the locations of libraries less obvious.
157157

158158
## Compilation
159159

160-
Sketches are compiled by avr-gcc and avr-g++ according to the variables in the boards.txt file of the selected board's
161-
[platform](platform-specification.md).
160+
Sketches are compiled by architecture-specific versions of `gcc` and `g++` according to the variables in the boards.txt
161+
file of the selected board's [platform](platform-specification.md).
162162

163163
The sketch is built in a temporary directory in the system-wide temporary directory (e.g. /tmp on Linux).
164164

@@ -185,8 +185,9 @@ the build process will be printed in the console.
185185

186186
## Uploading
187187

188-
Sketches are uploaded by avrdude. The upload process is also controlled by variables in the boards and main preferences
189-
files. See the [Arduino platform specification](platform-specification.md) page for details.
188+
Sketches are uploaded by a platform-specific upload tool (e.g., avrdude). The upload process is also controlled by
189+
variables in the boards and main preferences files. See the [Arduino platform specification](platform-specification.md)
190+
page for details.
190191

191-
If verbose output during upload is enabled, debugging information will be output to the console, including avrdude
192-
command lines and verbose output.
192+
If verbose output during upload is enabled, debugging information will be output to the console, including the upload
193+
tool's command lines and verbose output.

0 commit comments

Comments
 (0)