doc/all: Improvements to the Documentation#18471
Merged
linguini1 merged 3 commits intoapache:masterfrom Mar 1, 2026
Merged
Conversation
added 3 commits
February 28, 2026 16:58
This patch fixes a typo in a comment. (Tested: checkpatch - all checks pass, compilation yields binary with identical SHA256 checksum with and without the patch.) Signed-off-by: Kerogit <kr.git@kerogit.eu>
…scription This patch fixes formatting error in desription of High Resolution Timer. Using indentation to (presumably) align non-bold text right of the bold text did not have the desired effect, instead the line was split into two and the second line was handled as an indented paragraph. Signed-off-by: Kerogit <kr.git@kerogit.eu>
This patch adds defconfig example to The Custom Boards How-To guide. The command specified in this guide which runs configure script fails if the defconfig file does not exists; the guide did not mention this file at all. If the file exists but is empty, the configure script fails and leaves the system in a broken state which is somewhat difficult to deal with. (Subsequent attempts to configure fail but so do attempts to distclean.) To resolve this, this patch adds a minimal defconfig example which should be sufficient for the configure script to do its work correctly. Signed-off-by: Kerogit <kr.git@kerogit.eu>
github-actions
bot
added
Area: Documentation
linguini1
approved these changes
Mar 1, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
These commits are contributions from Kerogit to fix the Documentation
Impact
Improvement
Testing
make html
...
copying images... [100%] _static/images/menuconfig-debug.png
copying downloadable files... [ 25%] platforms/xtensa/esp32s2/boards/esp32s2-saolacopying downloadable files... [100%] components/drivers/special/usbmonitor_wireshark_linux_example_adb.pcapng
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in _build/html.