Skip to content

Commit 59f5bb4

Browse files
committed
Merge branch 'contrib/github_pr_17652' into 'master'
fix(esp_tls_conn_new_sync): Fix `esp_tls_conn_new_sync`'s doc to reflect its implementation (GitHub PR) Closes IDFGH-16528 and IDFGH-16475 See merge request espressif/esp-idf!42263
2 parents af1ceb3 + 2b42a6a commit 59f5bb4

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

components/esp-tls/esp_tls.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -412,10 +412,12 @@ esp_tls_t *esp_tls_init(void);
412412
* @param[in] hostname Hostname of the host.
413413
* @param[in] hostlen Length of hostname.
414414
* @param[in] port Port number of the host.
415-
* @param[in] cfg TLS configuration as esp_tls_cfg_t. If you wish to open
416-
* non-TLS connection, keep this NULL. For TLS connection,
417-
* a pass pointer to esp_tls_cfg_t. At a minimum, this
418-
* structure should be zero-initialized.
415+
* @param[in] cfg TLS configuration as esp_tls_cfg_t. For a TLS
416+
* connection, pass a pointer to a esp_tls_cfg_t. For a
417+
* plain TCP connection, pass a pointer to a
418+
* esp_tls_cfg_t with is_plain_tcp set to true. At a
419+
* minimum, this pointer should be not NULL and the
420+
* structure should be zero-initialized
419421
* @param[in] tls Pointer to esp-tls as esp-tls handle.
420422
*
421423
* @return

0 commit comments

Comments
 (0)