Skip to content

Commit 14f7b2f

Browse files
cmaglieper1234
andauthored
Apply suggestions from code review
Co-authored-by: per1234 <[email protected]>
1 parent 1ebfb6f commit 14f7b2f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

RFCs/0003-build-profiles.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ These incompatibilities might arise due to newer versions of a Platform, Tool, o
88

99
## Problem
1010

11-
An Arduino project is known as Sketch. It comprises its main .ino file plus optional local source code (in the same folder) and an optional extra src folder containing additional sources if required.
11+
An Arduino project is known as Sketch. It comprises its main `.ino` file plus optional local source code (in the same folder) and an optional extra `src` folder containing additional sources if required.
1212

1313
The sketch compiles against a set of globally installed libraries and platforms. When said library and/or part of the hardware platform is updated, sometimes introducing some breaking changes, that sketch might not compile anymore or behave differently.
1414

15-
Currently, Arduino guarantees no portability and reproducibility of a build at a later time unless exact instructions are provided by the developer to the final user, such as the required platform, including version and possibly a 3rd party platform URL to download and install the platform, or all the required libraries including the exact version of each one.
15+
Currently, the only way to guarantee portability and reproducibility of a sketch build at a later time is for the developer to provide instructions to the final user for the installation of the sketch dependencies, including the exact versions of the boards platform and libraries.
1616

1717
## Goals
1818

@@ -73,7 +73,7 @@ default_profile: <DEFAULT_PROFILE_NAME>
7373

7474
We have a `profiles:` section containing all the profiles. Each field is self-explanatory, in particular:
7575

76-
- `<PROFILE*NAME>` is the profile identifier, it’s a user-defined field, and the allowed characters are alphanumerics, underscore `_`, dot `.`, and dash `-`
76+
- `<PROFILE_NAME>` is the profile identifier, it’s a user-defined field, and the allowed characters are alphanumerics, underscore `_`, dot `.`, and dash `-`
7777
- `<PLATFORM>` is the target core platform identifier, for example, `arduino:avr` or `adafruit:samd`
7878
- `<PLATFORM_VERSION>` is the target core platform version required
7979
- `<3RD_PARTY_PLATFORM_URL>` is the index URL to download the target core platform (also known as “Additional Boards Manager URLs” in the Arduino IDE). This field can be omitted for the official `arduino:*` platforms.
@@ -156,9 +156,9 @@ will, instead, trigger a profile-based build using the default profile indicated
156156

157157
We will add the possibility to add custom libraries directly in the sketch using the `libraries` subdirectory in the sketch root folder.
158158

159-
A typical usage scenario is when the sketch needs a library that is not part of the library manager, or if the sketch needs a library with some customizations that are not available in the upstream release.
159+
A typical usage scenario is when the sketch needs a library that is not offered for installation from Library Manager, or if the sketch needs a library with some customizations that are not available in the upstream release.
160160

161-
To accomplish this the idea is to put the custom libraries' source code directly in the sketch `libraries` subdirectory (exactly as we do for the globally installed libraries in the `libraries` subdirectory of the sketchbook root folder). For example:
161+
To accomplish this the idea is to put the custom libraries' source code directly in the `libraries` subdirectory of the sketch (exactly as we do for the globally installed libraries in the `libraries` subdirectory of the sketchbook root folder). For example:
162162

163163
```
164164
~/Arduino/HumiditySensor$ tree

0 commit comments

Comments
 (0)