Skip to content

Docs: add an entry about compiler warnings #8492

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.

Sign up for GitHub

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
mcspr merged 3 commits into from
Feb 22, 2022
Merged

Docs: add an entry about compiler warnings #8492

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25c0843
take note of compilation warnings
mcspr Feb 20, 2022
3259fe8
backticks
mcspr Feb 20, 2022
8754809
list
mcspr Feb 20, 2022
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
backticks
  • Loading branch information
@mcspr
mcspr committed Feb 20, 2022
commit 3259fe83a5cf2e3d28caeeaf13c43515c95ba650
9 changes: 7 additions & 2 deletions doc/faq/a02-my-esp-crashes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,13 @@ Enable compilation warnings

Most common issues may be resolved by enabling compilation warnings and fixing them.

For Arduino IDE, select ``File -> Preferences`` and select ``Show verbose output during: compilation``
For PlatformIO, all warnings should be enabled by default.
For Arduino IDE:

- Select ``File -> Preferences``
- Make sure ``Show verbose output during: compilation`` is enabled
- Set ``Compiler warnings`` to ``More`` or ``All``

For PlatformIO, all warnings should already be enabled by default.

Notice that the default configuration of Arduino IDE inhibits **all** compilation warnings.
For the ESP8266 platform, some warnings should be treated as errors, otherwise it may cause unexpected issues at runtime:
Expand Down