Skip to content

Commit 495966e

Browse files
authored
[skip changelog]Make general minor improvements to the wording of the documentation (#906)
* Restructure paragraph re: standardizing architecture names The information about architecture values being case sensitive was placed in the middle of a largely unrelated paragraph. The paragraph about using standardized architecture names had an overly strident tone, which I have softened. * Improve wording of documentation Do some minor rewording of sentences to improve clarity and readability, but without changing their informational content.
1 parent 28c872c commit 495966e

File tree

5 files changed

+18
-17
lines changed

5 files changed

+18
-17
lines changed

cli/compile/compile.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ func NewCommand() *cobra.Command {
8484
command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if board supports them.")
8585
command.Flags().StringSliceVar(&libraries, "libraries", []string{},
8686
"List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths.")
87-
command.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, "Optional, optimize compile output for debug, not for release.")
87+
command.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, "Optional, optimize compile output for debugging, rather than for release.")
8888
command.Flags().StringVarP(&programmer, "programmer", "P", "", "Optional, use the specified programmer to upload.")
8989

9090
return command

docs/library-specification.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ otherwise below, **all fields are required**. The available fields are:
4949
- **author** - name/nickname of the authors and their email addresses (not mandatory) separated by comma ","
5050
- **maintainer** - name and email of the maintainer
5151
- **sentence** - a sentence explaining the purpose of the library
52-
- **paragraph** - a longer description of the library. The value of **sentence** always will be prepended, so you should
53-
start by writing the second sentence here
54-
- **category** - (defaults to `Uncategorized`) if present, one of these:
52+
- **paragraph** - a longer description of the library. The value of **sentence** will be prepended to this, so you
53+
should start by writing the second sentence here
54+
- **category** - (defaults to `Uncategorized`) allowed values:
5555
- Display
5656
- Communication
5757
- Signal Input/Output
@@ -213,7 +213,7 @@ Remember that files placed inside this folder will increase the size of the libr
213213
that weights a few kilobytes may not be such a good idea.
214214

215215
The content of the _extras_ folder is totally ignored by the Arduino development software; you are free to put anything
216-
inside such as supporting documentation, etc.
216+
inside.
217217

218218
### Keywords
219219

docs/package_index_json-specification.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ The other fields are:
156156
- `size`: the size of the archive in bytes
157157
- `checksum`: the checksum of the archive, used to check if the file has been corrupted. The format is
158158
`ALGORITHM:CHECKSUM`, currently `MD5`, `SHA-1`,`SHA-256` algorithm are supported, we recommend `SHA-256`. On \*nix or
159-
MacOSX you may be able to use the command `shasum -a 256 filename` to generate SHA-256 checksums. There are many free
160-
options for Windows including md5deep, there are also online utilities for generating checksums.
159+
macOS you can use the command `shasum -a 256 filename` to generate SHA-256 checksums. There are free options for
160+
Windows, including md5deep. There are also online utilities for generating checksums.
161161

162162
##### How a tool's path is determined in platform.txt
163163

@@ -307,7 +307,7 @@ cause the Arduino IDE to no longer load until you have deleted the file from you
307307
```
308308

309309
In the example there is one `PACKAGE`, My Board. The package is compatible with the AVR architecture. There are two
310-
versions of the `PACKAGE`, 1.0.0 and 1.0.1. No `TOOLS` needed to be installed so that section was left blank.
310+
versions of the `PACKAGE`, 1.0.0 and 1.0.1. No `TOOLS` needed to be installed so that section was left empty.
311311

312312
Here is the Boards Manager entry created by the example: ![Boards Manager screenshot](img/boards-manager-screenshot.png)
313313

docs/platform-specification.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ A vendor/maintainer can have multiple supported architectures. For example, belo
2020

2121
The vendor "arduino" has two supported architectures (AVR and SAM), while "xxxxx" and "yyyyy" have only AVR.
2222

23-
If possible, follow existing architecture name conventions when creating hardware packages. The architecture folder name
24-
is used to determine library compatibility and also to permit referencing resources from another core of the same
25-
architecture so using a non-standard architecture name can only be harmful to your users. Architecture values are case
26-
sensitive (e.g. `AVR` != `avr`). Use the vendor folder name to differentiate your package, **NOT** the architecture
27-
name.
23+
Architecture values are case sensitive (e.g. `AVR` != `avr`).
24+
25+
If possible, follow existing architecture name conventions when creating hardware packages. Use the vendor folder name
26+
to differentiate your package. The architecture folder name is used to determine library compatibility and to permit
27+
referencing resources from another core of the same architecture, so use of a non-standard architecture name can have a
28+
harmful effect.
2829

2930
## Architecture configurations
3031

@@ -313,8 +314,8 @@ error.
313314

314315
If **recipe.preproc.macros** is not defined, it is automatically generated from **recipe.cpp.o.pattern**.
315316

316-
Note that older Arduino IDE versions used the **recipe.preproc.includes** recipe to determine includes, which is
317-
undocumented here. Since Arduino IDE 1.6.7 (arduino-builder 1.2.0) this was changed and **recipe.preproc.includes** is
317+
Note that older Arduino IDE versions used the **recipe.preproc.includes** recipe (which is not documented here) to
318+
determine includes. Since Arduino IDE 1.6.7 (arduino-builder 1.2.0) this was changed and **recipe.preproc.includes** is
318319
no longer used.
319320

320321
#### Pre and post build hooks (since Arduino IDE 1.6.5)

docs/sketch-build-process.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,10 @@ The "folder name priority" is determined as follows (in order of highest to lowe
102102

103103
The "location priority" is determined as follows (in order of highest to lowest priority):
104104

105-
1. The library is in a custom libraries path specified via the
105+
1. The library is under a custom libraries path specified via the
106106
[`--libraries` option](commands/arduino-cli_compile.md#options) of `arduino-cli compile` (in decreasing order of
107107
priority when multiple custom paths are defined)
108-
1. The library is in the `libraries` subfolder of the IDE's sketchbook or Arduino CLI's user directory
108+
1. The library is under the `libraries` subfolder of the IDE's sketchbook or Arduino CLI's user directory
109109
1. The library is bundled with the board platform/core
110110
([`{runtime.platform.path}/libraries`](platform-specification.md#global-predefined-properties))
111111
1. The library is bundled with the [referenced](platform-specification.md#referencing-another-core-variant-or-tool)

0 commit comments

Comments
 (0)