Skip to content

Add interrupt section to docs #6560

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 5 commits into from
Sep 28, 2019
Merged

Conversation

earlephilhower
Copy link
Collaborator

Adds a section on interrupts to the docs and lists the restrictions
and warnings about running long tasks.

Fixes #6428

The Mac requires special handholding to allow SSL connections for
get.py, so document those for end users.
Adds a section on interrupts to the docs and lists the restrictions
and warnings about running long tasks.

Fixes esp8266#6428
Copy link
Collaborator

@devyte devyte left a comment

Choose a reason for hiding this comment

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

I believe there were some comments about slme of this already in section "why does my esp crash". It might be a good idea to cross check against that.

@earlephilhower
Copy link
Collaborator Author

Updated w/your proofreading and requests.

I believe there were some comments about slme of this already in section "why does my esp crash". It might be a good idea to cross check against that.

The FAQ does have a section on Interrupts, too, but I though it would be better to make the IRQ restrictions front-and-center before things crash, too. The contents are pretty close and don't contradict each other.

If you're really against it, I can drop the section in the reference.rst and just add a the bit about memory allocation in the FAQ bit.

@devyte
Copy link
Collaborator

devyte commented Sep 28, 2019

Oh, I'm completely in favor of this. Users have missed the current section enough times that I think an additional specific section would be beneficial, even if the info is duplicated.
What I meant was to check for contradictions, which you already did, and missed info in the other section that could be added here, e. g. timing constraints.

Copy link
Collaborator

@devyte devyte left a comment

Choose a reason for hiding this comment

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

I'm ok with this.

@earlephilhower earlephilhower merged commit 4489e23 into esp8266:master Sep 28, 2019
@earlephilhower earlephilhower deleted the irqunsafe branch September 28, 2019 23:10
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.

2 participants