add documentation for the advanced configuration option 'enable_lwip_tcp_sack' #5234
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| - **enable_lwip_check_thread_safety** (*Optional*, boolean): Enable LWIP thread safety checks to detect incorrect usage of | ||
| the TCP/IP stack from multiple threads. This helps catch thread safety issues when core locking is enabled. Defaults to ``true``. | ||
| - **enable_lwip_tcp_sack** (*Optional*, boolean): Enable TCP selective acknowledgments | ||
| to improve performance on lossy or high latency networks. Defaults to ``true``. |
There was a problem hiding this comment.
The documentation should mention that the option is framework-dependent (only applies when using esp-idf)
There was a problem hiding this comment.
Ah, yeah, sorry forgot that.
The other lwip options should get the same treatment, though.
There was a problem hiding this comment.
Actually, never mind. I was missing that context. The header for the entire LWIP options section already says "LWIP Optimization Options (ESP-IDF only):" so there is no need to add notes on the specific options.
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
2 participants
Description:
add documentation for the advanced configuration option 'enable_lwip_tcp_sack'
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.