From 9f99d2350a97362c86ae3bbe8745684e1932c098 Mon Sep 17 00:00:00 2001 From: Harshit Malpani Date: Wed, 11 May 2022 11:37:42 +0530 Subject: [PATCH] docs: Added breaking change for esp_https_server to migration guide --- components/esp_https_server/include/esp_https_server.h | 5 ++++- docs/en/migration-guides/protocols.rst | 1 + 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/components/esp_https_server/include/esp_https_server.h b/components/esp_https_server/include/esp_https_server.h index 15654e4790..63f0845161 100644 --- a/components/esp_https_server/include/esp_https_server.h +++ b/components/esp_https_server/include/esp_https_server.h @@ -160,7 +160,10 @@ esp_err_t httpd_ssl_start(httpd_handle_t *handle, httpd_ssl_config_t *config); * Stop the server. Blocks until the server is shut down. * * @param[in] handle - * @return success + * @return + * - ESP_OK: Server stopped successfully + * - ESP_ERR_INVALID_ARG: Invalid argument + * - ESP_FAIL: Failure to shut down server */ esp_err_t httpd_ssl_stop(httpd_handle_t handle); diff --git a/docs/en/migration-guides/protocols.rst b/docs/en/migration-guides/protocols.rst index b7e3359bed..596580a6f7 100644 --- a/docs/en/migration-guides/protocols.rst +++ b/docs/en/migration-guides/protocols.rst @@ -86,6 +86,7 @@ Names of variables holding different certs in :cpp:type:`httpd_ssl_config_t` str * :cpp:member:`httpd_ssl_config::cacert_pem` variable inherits role of `client_verify_cert_pem` variable * :cpp:member:`httpd_ssl_config::cacert_len` variable inherits role of `client_verify_cert_len` variable +The return type of the :cpp:func:`httpd_ssl_stop` API has been changed to :cpp:type:`esp_err_t` from ``void``. ESP HTTPS OTA --------------