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

Missing documentation on features #242

Closed
VorpalBlade opened this issue Apr 26, 2023 · 2 comments
Closed

Missing documentation on features #242

VorpalBlade opened this issue Apr 26, 2023 · 2 comments

Comments

@VorpalBlade
Copy link

The Cargo.toml features of this crate appear to be undocumented. For example:

  • What is the difference between alloc in this crate, in esp-idf-svc and alloc_handler in esp-idf-sys?
  • There appear to be embassy related features, is that a work in progress or ready?
  • The critical-section feature, when do I need it?

I'm new to embedded Rust, and I'm finding the three idf crates (hal, sys and svc) quite confusing. Some brief overview documentation would go a long way.

@Vollbrecht
Copy link
Collaborator

  1. even though most people use esp-idf-svc/hal with the standard library we implemented it in a way so it can be used in a no_std environement. So when used there, it gates the parts that still need a allocator. The user than can provide its own allocator or uses it from std.
  2. We are using some embassy stuff, but also implement some other async related stuff esp specific - and its all working. But this is all not recommended to use if you are just beginning working with embedded rust.
  3. https://en.wikipedia.org/wiki/Critical_section

@ivmarkov
Copy link
Collaborator

Closing in favor of #258

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

No branches or pull requests

3 participants