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.

Sign up for GitHub

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

Jump to bottom

Missing documentation for sntp (IDFGH-9098) #10502

Closed
3 tasks done
Duvio opened this issue Jan 7, 2023 · 0 comments
Closed
3 tasks done

Missing documentation for sntp (IDFGH-9098) #10502

Duvio opened this issue Jan 7, 2023 · 0 comments
Assignees
@david-cermak
Labels
Resolution: Done Issue is done internally Status: Done Issue is done internally

Comments

@Duvio
Copy link

Duvio commented Jan 7, 2023 •
edited
Loading

Answers checklist.

  • I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
  • I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
  • I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

When looking at this documentation, i noticed that documentation of some functions like sntp_init is missing. This is less of a problem since this function has docs in the official lwIP docs, but the docs of some ESP specific functions like sntp_setservername are to be found nowhere except in the source files themselves, which is no easy task to do as you have to dig for them very deep. esp_time_impl_set_boot_time is also not documented.
https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/system_time.html

Is it supposed to be like this, and if not, can you please fix it?
@espressif-bot espressif-bot added the Status: Opened Issue is new label Jan 7, 2023
@github-actions github-actions bot changed the title Missing documentation for sntp Missing documentation for sntp (IDFGH-9098) Jan 7, 2023
@espressif-bot espressif-bot added Status: In Progress Work is in progress and removed Status: Opened Issue is new labels Jan 13, 2023
@espressif-bot espressif-bot added Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally Resolution: Done Issue is done internally and removed Status: In Progress Work is in progress Resolution: NA Issue resolution is unavailable labels Jan 18, 2023
espressif-bot pushed a commit that referenced this issue Mar 23, 2023
@david-cermak
esp_netif/lwip: Fix core-locking config (v4.4)
29b8a00 
* Fix thread safety issues in non-core locking
* Add option to verify thread safety issues in lwip (core-lock assertion)
* Make esp_sntp.h thread safe API
* Fix sntp example
(v4.4 - fixes minor merge issue that duplicated
DHCP_DEFINE_CUSTOM_TIMEOUTS and DHCP_REQUEST_TIMEOUT_SEQUENCE)

Closes #9908
Closes #10502
Closes #10466
espressif-bot pushed a commit that referenced this issue Mar 31, 2023
@david-cermak
esp_netif/lwip: Fix core-locking config (v5.0)
5b75693 
* Fix thread safety issues in non-core locking
* Add option to verify thread safety issues in lwip (core-lock assertion)
* Make esp_sntp.h thread safe API
* Fix sntp examples

Closes #9908
Closes #10502
Closes #10466
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@david-cermak david-cermak

Labels
Resolution: Done Issue is done internally Status: Done Issue is done internally
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Duvio @david-cermak @espressif-bot