Prechádzať zdrojové kódy

Merge branch 'bugfix/esp_tls_errors_header_in_docs' into 'master'

docs: Add esp_tls_errors.h to API reference list

Closes DOC-2797

See merge request espressif/esp-idf!17584
Aditya Patwardhan 3 rokov pred
rodič
commit
2cf6399cd5

+ 1 - 0
docs/doxygen/Doxyfile

@@ -116,6 +116,7 @@ INPUT = \
     $(PROJECT_PATH)/components/esp_netif/include/esp_netif.h \
     $(PROJECT_PATH)/components/esp_netif/include/esp_netif_net_stack.h \
     $(PROJECT_PATH)/components/esp-tls/esp_tls.h \
+    $(PROJECT_PATH)/components/esp-tls/esp_tls_errors.h \
     $(PROJECT_PATH)/components/mqtt/esp-mqtt/include/mqtt_client.h \
     $(PROJECT_PATH)/components/lwip/include/apps/ping/ping_sock.h \
     $(PROJECT_PATH)/components/lwip/include/apps/esp_sntp.h \

+ 4 - 2
docs/en/api-reference/protocols/esp_crt_bundle.rst

@@ -48,6 +48,8 @@ If using mbedTLS directly then the bundle may be activated by directly calling t
     esp_crt_bundle_attach(&conf);
 
 
+.. _updating_bundle:
+
 Generating the List of Root Certificates
 ----------------------------------------
 The list of root certificates comes from Mozilla's NSS root certificate store, which can be found `here <https://wiki.mozilla.org/CA/Included_Certificates>`_
@@ -57,12 +59,12 @@ Another alternative would be to download the finished list directly from the cur
 The common certificates bundle were made by selecting the authorities with a market share of more than 1 % from w3tech's `SSL Survey <https://w3techs.com/technologies/overview/ssl_certificate/all>`_.
 These authorities were then used to pick the names of the certificates for the filter list, `cmn_crt_authorities.csv`, from `this list <https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReportPEMCSV>`_ provided by Mozilla.
 
-.. _updating_bundle:
+
 
 Updating the Certificate Bundle
 -------------------------------
 
-The bundle is embedded into the app and can be updated along with the app by an OTA update. If you want to include a more up-to-date bundle than the bundle currently included in IDF, then the certificate list can be downloaded from Mozilla as described in :ref:`updating_bundle`.
+The bundle is embedded into the app and can be updated along with the app by an OTA update. If you want to include a more up-to-date bundle than the bundle currently included in ESP-IDF, then the certificate list can be downloaded from Mozilla as described in :ref:`updating_bundle`.
 
 
 

+ 1 - 0
docs/en/api-reference/protocols/esp_tls.rst

@@ -175,3 +175,4 @@ API Reference
 -------------
 
 .. include-build-file:: inc/esp_tls.inc
+.. include-build-file:: inc/esp_tls_errors.inc

+ 1 - 1
docs/en/api-reference/protocols/mqtt.rst

@@ -85,7 +85,7 @@ SSL
 If the certificate is not null-terminated then ``cert_len`` should also be set.
 Other SSL related configuration parameters are:
 
- * ``use_global_ca_store``: use the global certificate store to verify server certificate, see ``esp-tls.h`` for more information
+ * ``use_global_ca_store``: use the global certificate store to verify server certificate, see :component_file:`esp-tls/esp_tls.h` for more information
  * ``client_cert_pem``: pointer to certificate data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed.
  * ``client_cert_len``: length of the buffer pointed to by client_cert_pem. May be 0 for null-terminated pem.
  * ``client_key_pem``: pointer to private key data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed.