-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Doc addition: How to compile libs with different debug level #7193
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
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e6d7c3b
Initial commit with guide on building libs wirh higher debug level
PilnyTomas 844d2c1
Added reference to FAQ
PilnyTomas 836d0a2
Reword portion of core_debug.rst
PilnyTomas c9264ff
Merge branch 'master' into faq
VojtechBartoska cb3ac63
Removed extra empty line
PilnyTomas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
################################## | ||
Compile Arduino libs with ESP_LOGx | ||
################################## | ||
|
||
There are 2 primary approaches and both of them involve editing file ``configs/defconfig.common``. | ||
Edit the file directly and then build. | ||
Later you can ``git restore configs/defconfig.common`` to go back. | ||
Copy the file ``cp configs/defconfig.common configs/defconfig.debug`` and edit the debug version. | ||
|
||
``vim configs/defconfig.common`` or ``vim configs/defconfig.debug`` | ||
|
||
Edit **line 44** containing by default ``CONFIG_LOG_DEFAULT_LEVEL_ERROR=y`` to one of the following lines depending on your desired log level: | ||
|
||
.. code-block:: bash | ||
|
||
CONFIG_LOG_DEFAULT_LEVEL_NONE=y # No output | ||
CONFIG_LOG_DEFAULT_LEVEL_ERROR=y # Errors - default | ||
CONFIG_LOG_DEFAULT_LEVEL_WARN=y # Warnings | ||
CONFIG_LOG_DEFAULT_LEVEL_INFO=y # Info | ||
CONFIG_LOG_DEFAULT_LEVEL_DEBUG=y # Debug | ||
CONFIG_LOG_DEFAULT_LEVEL_VERBOSE=y # Verbose | ||
|
||
Then simply build the libs for all SoCs or one specific SoC. Note that building for all SoCs takes a lot of time, so if you are working only with specific SoC(s), build only for those. | ||
|
||
|
||
.. note:: | ||
If you have copied the ``defconfig`` file and the debug settings are in file ``configs/defconfig.debug`` add flag ``debug`` to compilation command. | ||
Example : ``./build.sh debug`` | ||
|
||
- **Option 1**: Build for all SoCs: ``./build.sh`` | ||
- **Option 2**: Build for one SoC: ``./build.sh -t <soc>``. The exact text to choose the SoC: | ||
|
||
- ``esp32`` | ||
- ``esp32s2`` | ||
- ``esp32c3`` | ||
- ``esp32s3`` | ||
- Example: ``./build.sh -t esp32`` | ||
- A wrong format or non-existing SoC will result in the error sed: can't read sdkconfig: No such file or directory | ||
- **Option 3**: Build for multiple SoCs (not all) - simply write them down separated with space: ``./build.sh -t <soc1> <soc2> <soc3>`` | ||
|
||
- Example: ``./build.sh -t esp32 esp32-c3`` | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here are two empty lines probably by typo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@PilnyTomas could you fix this please?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done in cb3ac63