8000 Update documentation and arduino debug options by mhightower83 · Pull Request #8837 · esp8266/Arduino · GitHub
[go: up one dir, main page]

Skip to content

Update documentation and arduino debug options #8837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Mar 29, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
e67c95c
Update documentation
mhightower83 Jan 29, 2023
f91d547
Added d-a-v's code. And updated description and debug macro.
mhightower83 Jan 30, 2023
679038d
Update doc
mhightower83 Jan 30, 2023
33bbf8b
Fixed code formatting
mhightower83 Jan 31, 2023
d135c64
Merge branch 'master' into pr-doc-debug
mhightower83 Jan 31, 2023
c453382
Merge branch 'pr-doc-debug' of github.com:mhightower83/Arduino into p…
mhightower83 Jan 31, 2023
2e062ae
Fixed example
mhightower83 Jan 31, 2023
1a92df1
Proposed "Debug port" menu change
mhightower83 Jan 31, 2023
9157394
Update boards.txt.py and docs - WIP
mhightower83 Feb 2, 2023
2ee9eb5
Merge branch 'master' into pr-doc-debug
mhightower83 Feb 2, 2023
9a6ea12
8000 Improve organization of optimization content.
mhightower83 Feb 2, 2023
8e49b33
Add fallback value for build.debug_optim to platform.txt
mhightower83 Feb 2, 2023
aab4d56
update text and undo changes to platformio-build.py
mhightower83 Feb 3, 2023
94e165d
tweak text
mhightower83 Feb 4, 2023
e51f134
Merge branch 'master' into pr-doc-debug
d-a-v Feb 5, 2023
ab7a02a
Added ':orphan:' mark to a06-global-build-options.rst
mhightower83 Feb 5, 2023
58ad384
Update doc. Added link in page index to 'Improving Exception Decoder …
mhightower83 Feb 13, 2023
073ff6e
Merge branch 'master' into pr-doc-debug
mhightower83 Feb 25, 2023
f2a6150
Merge branch 'master' into pr-doc-debug
mhightower83 Mar 11, 2023
633550f
Merge branch 'master' into pr-doc-debug
mhightower83 Mar 28, 2023
462252f
Update text to reference PR#8868 improvements for leaf function.
mhightower83 Mar 29, 2023
1bc6c4c
Merge branch 'master' into pr-doc-debug
d-a-v Mar 29, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
tweak text
  • Loading branch information
mhightower83 committed Feb 4, 2023
commit 94e165d74cbbbff56ef4a076e1e1a973fd2c64d1
7 changes: 4 additions & 3 deletions doc/Troubleshooting/stack_dump.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,12 @@ the hex after are the stack dump.
Decode
~~~~~~

It's possible to decode the Stack to readable information. For more info see the `Esp Exception Decoder <https://github.com/me-no-dev/EspExceptionDecoder>`__ tool.
It's possible to decode the Stack to readable information.
You can get a copy and read about the `Esp Exception Decoder <https://github.com/me-no-dev/EspExceptionDecoder>`__ tool.

For a troubleshooting example using the Exception Decoder Tool, read `FAQ: My ESP Crashes <../faq/a02-my-esp-crashes.rst#exception-decoder>`__.

.. figure:: ESP_Exception_Decoderp.png
:alt: ESP Exception Decoder

ESP Exception Decoder

For more on troubleshooting, read `FAQ: My ESP Crashes <../faq/a02-my-esp-crashes.rst>`__.
8 changes: 4 additions & 4 deletions doc/faq/a02-my-esp-crashes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -302,10 +302,10 @@ When you select ``Debug Optimization: Lite`` on the Arduino IDE Tools menu, it
turns off ``optimize-sibling-calls``. Turning off this optimization allows more
caller addresses to be written to the stack, improving the results from the
Exception Decoder. Without this option, the callers involved in the crash may be
missing from the results. Because of the limited stack space, there is the
remote possibility that removing this optimization could lead to more frequent
stack overflows. You only want to do this in a debug setting. This option does
not help the chained function issue.
missing from the Decoder results. Because of the limited stack space, there is
the remote possibility that removing this optimization could lead to more
frequent stack overflows. You only want to do this in a debug setting. This
option does not help the chained function issue.

When you select ``Debug Optimization: Optimum``, you get an even more complete
stack trace. For example, chained function calls may show up. This selection
Expand Down
2 changes: 1 addition & 1 deletion platform.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ build.stdcpp_level=-std=gnu++17

build.stacksmash_flags=

# legacy fallback
# Default - never leave undefined
build.debug_optim=-Os

build.float=-u _printf_float -u _scanf_float
Expand Down
0