From 2b42a6aa2ba08181ab9d382d40dd80ce98f29e9e Mon Sep 17 00:00:00 2001 From: Jared Pon <27853460+jaredponn@users.noreply.github.com> Date: Wed, 24 Sep 2025 14:38:19 +0000 Subject: [PATCH] fix(esp_tls_conn_new_sync): Fix `esp_tls_conn_new_sync`'s doc to reflect its implementation Closes https://github.com/espressif/esp-idf/pull/17652 Closes https://github.com/espressif/esp-idf/issues/17598 --- components/esp-tls/esp_tls.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/components/esp-tls/esp_tls.h b/components/esp-tls/esp_tls.h index 4d2674033e..7a4b8f3ca0 100644 --- a/components/esp-tls/esp_tls.h +++ b/components/esp-tls/esp_tls.h @@ -412,10 +412,12 @@ esp_tls_t *esp_tls_init(void); * @param[in] hostname Hostname of the host. * @param[in] hostlen Length of hostname. * @param[in] port Port number of the host. - * @param[in] cfg TLS configuration as esp_tls_cfg_t. If you wish to open - * non-TLS connection, keep this NULL. For TLS connection, - * a pass pointer to esp_tls_cfg_t. At a minimum, this - * structure should be zero-initialized. + * @param[in] cfg TLS configuration as esp_tls_cfg_t. For a TLS + * connection, pass a pointer to a esp_tls_cfg_t. For a + * plain TCP connection, pass a pointer to a + * esp_tls_cfg_t with is_plain_tcp set to true. At a + * minimum, this pointer should be not NULL and the + * structure should be zero-initialized * @param[in] tls Pointer to esp-tls as esp-tls handle. * * @return