Miscellaneous cleanup of platformio.ini
#29
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dhebbeker
force-pushed
the
feature/miscellaneous-cleanup
branch
3 times, most recently
from
188819a to
2e9aa42
Compare
Used the PIO IDE to configure project: Added project description. Using the wizard did cleanup the file.
See [comment][1]. Do not forget to build in debug-mode. For example in PlatformIO IDE, select as project task 'Advanced' → 'Pre-Debug'. See also [here][2]. To decode backtraces from the Wokwi serial monitor, one can use [this python script][3]. [1]: platformio/platform-espressif32#105 (comment) [2]: https://docs.platformio.org/en/latest/projectconf/build_configurations.html#build-configurations [3]: https://github.com/me21/EspArduinoExceptionDecoder
dhebbeker
force-pushed
the
feature/miscellaneous-cleanup
branch
from
2e9aa42 to
a79f23c
Compare
dhebbeker
changed the title
platformio.ini
FiveTeethless
requested changes
May 22, 2023
|
|
||
| ;Path to source files relative to PIO project | ||
| ; see https://docs.platformio.org/en/stable/projectconf/sections/platformio/options/directory/src_dir.html | ||
| src_dir = src |
There was a problem hiding this comment.
you can leave this out
|
|
||
| ;switch "include" path to be src as well, as we decide to have headers and sources in same directories | ||
| ; this prevents the build environment from complaining the path not existing | ||
| include_dir = src |
There was a problem hiding this comment.
maybe check this, if it was necessary to stop PlatformIO from complaining, about missing "include" directory.
| [env] | ||
| ;filter for source file directory when building | ||
| ; see https://docs.platformio.org/en/stable/projectconf/sections/env/options/build/build_src_filter.html | ||
| build_src_filter = +<*> -<.git/> -<.svn/> |
There was a problem hiding this comment.
you can leave this out
|
|
||
| ;general dependencies | ||
| ; for version requirements see https://docs.platformio.org/en/stable/core/userguide/pkg/cmd_install.html#cmd-pkg-install-requirements | ||
| lib_deps = |
There was a problem hiding this comment.
this shoul be left here for other platforms
| [env:esp32-s3-devkitc-1] | ||
| platform = espressif32 | ||
| board = esp32-s3-devkitc-1 | ||
| framework = arduino | ||
| ;;add dependencies to general dependencies from [env] |
There was a problem hiding this comment.
this is an example of how the config of [env] can be expanded. If "${env.lib_deps}" was not used, the parameter would be overwritten.
dhebbeker
commented
May 22, 2023
|
We have agreed, that most changes shall not be applied.
I will rebase the remaining useful changes and create a new pull request. |
dhebbeker
added a commit
that referenced
this pull request
May 27, 2023
… project. Because we want to retain useful comments (see #29 (review) and platformio/platformio-core#3862).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using the GUI
I used PlatformIO Home to modify the project configuration. It removed most of the comments in
platformio.iniand added some. Instead of reverting these - admittedly unnecessary - changes, I suggest to accept those. This way PlatformIO Home can be used in future without the need to revert the changes to comments every time.Remove unnecessary entries
I took advantage of the situation and removed configuration statements which were set to default values or did not have any effect. This reduces the size of the file and - hopefully - the maintenance effort.
Add filter for debugging
For debugging runtime exceptions reading the backtrace can be helpful. In order to understand the backtrace which is written by the framework to the serial port, a backtrace decoder can be used. I added a filter to the ESP32 environment which handles this.
For this to work, do not forget to build in debug-mode. For example in PlatformIO IDE, select as project task 'Advanced' → 'Pre-Debug'. See also here. Also this only works as long as the serial output is read by PlatformIO.
To decode backtraces from the Wokwi serial monitor, one can use this python script.