Skip to content

Commit d5d6a3b

Browse files
authored
Correct "list" formatting (#8610)
Correct "list" formating in a06-global-build-options.rst. A formatting error was introduced in .md to .rst conversion.
1 parent dc6b15e commit d5d6a3b

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

doc/faq/a06-global-build-options.rst

+25-15
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,16 @@ signature line must be alone on a single line. The block comment ending
1818
compiler command-line options just as you would have for the GCC @file
1919
command option.
2020

21-
Actions taken in processing comment block to create ``build.opt`` \* for
22-
each line, white space is trimmed \* blank lines are skipped \* lines
23-
starting with ``*``, ``//``, or ``#`` are skipped \* the remaining
24-
results are written to build tree\ ``/core/build.opt`` \* multiple
25-
``/*@create-file:build.opt@`` ``*/`` comment blocks are not allowed \*
26-
``build.opt`` is finished with a ``-include ...`` command, which
27-
references the global .h its contents were extracted from.
21+
Actions taken in processing comment block to create ``build.opt``
22+
23+
- for each line, white space is trimmed
24+
- blank lines are skipped
25+
- lines starting with ``*``, ``//``, or ``#`` are skipped
26+
- the remaining results are written to build tree\ ``/core/build.opt``
27+
- multiple ``/*@create-file:build.opt@`` ``*/`` comment blocks are not
28+
allowed
29+
- ``build.opt`` is finished with a ``-include ...`` command, which
30+
references the global .h its contents were extracted from.
2831

2932
Example Sketch: ``LowWatermark.ino``
3033

@@ -108,10 +111,12 @@ multiple Sketches are open, they can no longer reliably share one cached
108111
of ``core.a`` cached. Other sketches will use this cached version for
109112
their builds.
110113

111-
There are two solutions to this issue: 1. Turn off the “Aggressively
112-
Cache Compiled core” feature, by setting ``compiler.cache_core=false``.
114+
There are two solutions to this issue:
115+
116+
1. Turn off the “Aggressively Cache Compiled core” feature, by setting
117+
``compiler.cache_core=false``.
113118
2. Rely on the not ideal fail-safe, aggressive cache workaround built
114-
into the script.
119+
into the script.
115120

116121
Using “compiler.cache_core=false”
117122
---------------------------------
@@ -145,11 +150,16 @@ When you switch between Sketch windows, core will be recompiled and the
145150
cache updated. The workaround logic is reset when Arduino IDE is
146151
completely shutdown and restarted.
147152

148-
The workaround is not perfect. These issues may be of concern: 1. Dirty
149-
temp space. Arduino build cache files left over from a previous run or
150-
boot. 2. Arduino command-line options: \* override default
151-
preferences.txt file. \* override a preference, specifically
152-
``compiler.cache_core``. 3. Multiple versions of the Arduino IDE running
153+
The workaround is not perfect. These issues may be of concern:
154+
155+
1. Dirty temp space. Arduino build cache files left over from a previous
156+
run or boot.
157+
2. Arduino command-line options:
158+
159+
- override default preferences.txt file.
160+
- override a preference, specifically ``compiler.cache_core``.
161+
162+
3. Multiple versions of the Arduino IDE running
153163

154164
**Dirty temp space**
155165

0 commit comments

Comments
 (0)