arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-06-06 05:21:22 +03:00
Code

Correct "list" formatting (#8610)

Browse Source 
Correct "list" formating in a06-global-build-options.rst.
A formatting error was introduced in .md to .rst conversion.
This commit is contained in:
M Hightower 2022-06-23 05:14:13 -07:00 committed by GitHub
parent dc6b15e38a
commit d5d6a3b023
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/faq/a06-global-build-options.rst
View File

@ -18,13 +18,16 @@ signature line must be alone on a single line. The block comment ending
compiler command-line options just as you would have for the GCC @file compiler command-line options just as you would have for the GCC @file
command option. command option.
Actions taken in processing comment block to create ``build.opt`` \* for Actions taken in processing comment block to create ``build.opt``
each line, white space is trimmed \* blank lines are skipped \* lines
starting with ``*``, ``//``, or ``#`` are skipped \* the remaining - for each line, white space is trimmed
results are written to build tree\ ``/core/build.opt`` \* multiple - blank lines are skipped
``/*@create-file:build.opt@`` ``*/`` comment blocks are not allowed \* - lines starting with ``*``, ``//``, or ``#`` are skipped
``build.opt`` is finished with a ``-include ...`` command, which - the remaining results are written to build tree\ ``/core/build.opt``
references the global .h its contents were extracted from. - multiple ``/*@create-file:build.opt@`` ``*/`` comment blocks are not
allowed
- ``build.opt`` is finished with a ``-include ...`` command, which
references the global .h its contents were extracted from.
Example Sketch: ``LowWatermark.ino`` Example Sketch: ``LowWatermark.ino``
@ -108,10 +111,12 @@ multiple Sketches are open, they can no longer reliably share one cached
of ``core.a`` cached. Other sketches will use this cached version for of ``core.a`` cached. Other sketches will use this cached version for
their builds. their builds.
There are two solutions to this issue: 1. Turn off the “Aggressively There are two solutions to this issue:
Cache Compiled core” feature, by setting ``compiler.cache_core=false``.
1. Turn off the “Aggressively Cache Compiled core” feature, by setting
``compiler.cache_core=false``.
2. Rely on the not ideal fail-safe, aggressive cache workaround built 2. Rely on the not ideal fail-safe, aggressive cache workaround built
into the script. into the script.
Using “compiler.cache_core=false” Using “compiler.cache_core=false”
--------------------------------- ---------------------------------
@ -145,11 +150,16 @@ When you switch between Sketch windows, core will be recompiled and the
cache updated. The workaround logic is reset when Arduino IDE is cache updated. The workaround logic is reset when Arduino IDE is
completely shutdown and restarted. completely shutdown and restarted.
The workaround is not perfect. These issues may be of concern: 1. Dirty The workaround is not perfect. These issues may be of concern:
temp space. Arduino build cache files left over from a previous run or
boot. 2. Arduino command-line options: \* override default 1. Dirty temp space. Arduino build cache files left over from a previous
preferences.txt file. \* override a preference, specifically run or boot.
``compiler.cache_core``. 3. Multiple versions of the Arduino IDE running 2. Arduino command-line options:
- override default preferences.txt file.
- override a preference, specifically ``compiler.cache_core``.
3. Multiple versions of the Arduino IDE running
**Dirty temp space** **Dirty temp space**