Skip to content
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

Docs: ESP32 Performance & Power #1481

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Conversation

petermm
Copy link
Contributor

@petermm petermm commented Jan 21, 2025

Docs for changing performance/power menuconfig on Esp32.

These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).

SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later

@petermm petermm force-pushed the docs-perf-power branch 3 times, most recently from 7cc29d1 to b0fbbfc Compare January 21, 2025 14:12
Copy link
Collaborator

@UncleGrumpy UncleGrumpy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this information makes more sense to include as an addendum to the Build Instructions section of the docs.

doc/src/programmers-guide.md Outdated Show resolved Hide resolved
doc/src/programmers-guide.md Outdated Show resolved Hide resolved
@petermm petermm force-pushed the docs-perf-power branch 2 times, most recently from 49e5ea4 to f122f46 Compare January 21, 2025 16:54
@petermm
Copy link
Contributor Author

petermm commented Jan 21, 2025

Moved it to build-instructions.md where it makes more sense, as you suggested.

@UncleGrumpy
Copy link
Collaborator

Sorry I missed the triple backticks the first time I looked through this ;-)

Copy link
Collaborator

@UncleGrumpy UncleGrumpy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed the backticks the first time through.

doc/src/build-instructions.md Outdated Show resolved Hide resolved
doc/src/build-instructions.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@UncleGrumpy UncleGrumpy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a great addition to the documentation. Thanks for helping fill in some of the gaps!

Docs for changing performance/power menuconfig on Esp32.

Signed-off-by: Peter M <[email protected]>
Copy link
Collaborator

@bettio bettio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good so far, but I'm not sure If we should add more details to the basic build instructions, rather than adding a page about tuning esp32 build.

@UncleGrumpy
Copy link
Collaborator

UncleGrumpy commented Jan 23, 2025

I do see your point, this may not be enough information to break out into a separate chapter yet, but it might be better to push these added customizations further down past the default build and flash instructions. A good place would be right before the section for adding custom nifs and ports to an image.

@UncleGrumpy
Copy link
Collaborator

On second thought, if we do start a guide for tuning the build it might attract more contributions, and could also include a section for building debug builds, and enabling the static code checker.

@bettio
Copy link
Collaborator

bettio commented Jan 23, 2025

On second thought, if we do start a guide for tuning the build it might attract more contributions, and could also include a section for building debug builds, and enabling the static code checker.

Let's refactor documentation on a second step, I will merge this first step that is still a good contribution.

@bettio bettio changed the title Docs: Esp32 Performance & Power Docs: ESP32 Performance & Power Jan 23, 2025
@bettio bettio merged commit d4b1c56 into atomvm:main Jan 23, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants