From ad927e22d39ee61454c644d5c226fded8699d033 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 7 Jun 2018 18:31:24 -0700 Subject: [PATCH] fixes #510 HTTP and TLS man pages refer to private symbols --- docs/man/nng_http_req_copy_data.3http.adoc | 2 +- docs/man/nng_http_req_set_data.3http.adoc | 2 +- docs/man/nng_http_res_copy_data.3http.adoc | 2 +- docs/man/nng_http_res_set_data.3http.adoc | 2 +- docs/man/nng_tls_config_alloc.3tls.adoc | 2 +- docs/man/nng_tls_config_auth_mode.3tls.adoc | 2 +- docs/man/nng_tls_config_ca_chain.3tls.adoc | 2 +- docs/man/nng_tls_config_ca_file.3tls.adoc | 2 +- docs/man/nng_tls_config_cert_key_file.3tls.adoc | 2 +- docs/man/nng_tls_config_free.3tls.adoc | 2 +- docs/man/nng_tls_config_own_cert.3tls.adoc | 2 +- docs/man/nng_tls_config_server_name.3tls.adoc | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/man/nng_http_req_copy_data.3http.adoc b/docs/man/nng_http_req_copy_data.3http.adoc index a6eb93827..66562d8b0 100644 --- a/docs/man/nng_http_req_copy_data.3http.adoc +++ b/docs/man/nng_http_req_copy_data.3http.adoc @@ -30,7 +30,7 @@ and sets the HTTP body for the request _req_ to it. The copy will be deallocated automatically when _req_ is freed. The copied body data will be automatically sent with the request when it -is sent using `<>`. +is sent using `<>`. This also updates the relevant `Content-Length` header of _req_. diff --git a/docs/man/nng_http_req_set_data.3http.adoc b/docs/man/nng_http_req_set_data.3http.adoc index 5988386e5..2e1631ae5 100644 --- a/docs/man/nng_http_req_set_data.3http.adoc +++ b/docs/man/nng_http_req_set_data.3http.adoc @@ -28,7 +28,7 @@ int nng_http_req_set_data(nng_http_req *req, const void *body, size_t size); The `nng_http_req_set_data()` sets the HTTP body associated with the request _req_ to _body_, and the size of the body to _size_. This body data will be automatically sent with the request when it -is sent using `<>`. +is sent using `<>`. This also updates the relevant `Content-Length` header of _req_. diff --git a/docs/man/nng_http_res_copy_data.3http.adoc b/docs/man/nng_http_res_copy_data.3http.adoc index e4d109baa..e36fb58e4 100644 --- a/docs/man/nng_http_res_copy_data.3http.adoc +++ b/docs/man/nng_http_res_copy_data.3http.adoc @@ -30,7 +30,7 @@ and sets the HTTP body for the response _res_ to it. The copy will be deallocated automatically when _res_ is freed. The copied body data will be automatically sent with the response when it -is sent using `<>`. +is sent using `<>`. This also updates the relevant `Content-Length` header of _res_. diff --git a/docs/man/nng_http_res_set_data.3http.adoc b/docs/man/nng_http_res_set_data.3http.adoc index e6d77a2b6..8202ec612 100644 --- a/docs/man/nng_http_res_set_data.3http.adoc +++ b/docs/man/nng_http_res_set_data.3http.adoc @@ -28,7 +28,7 @@ int nng_http_res_set_data(nng_http_res *res, const void *body, size_t size); The `nng_http_res_set_data()` sets the HTTP body associated with the response _res_ to _body_, and the size of the body to _size_. This body data will be automatically sent with the response when it -is sent using `<>`. +is sent using `<>`. This also updates the relevant `Content-Length` header of _res_. diff --git a/docs/man/nng_tls_config_alloc.3tls.adoc b/docs/man/nng_tls_config_alloc.3tls.adoc index c68fac051..92ed5d418 100644 --- a/docs/man/nng_tls_config_alloc.3tls.adoc +++ b/docs/man/nng_tls_config_alloc.3tls.adoc @@ -25,7 +25,7 @@ typedef enum nng_tls_mode { NNG_TLS_MODE_SERVER } nng_tls_mode; -int nng_tls_config_alloc(nni_tls_config **cfgp, nng_tls_mode mode); +int nng_tls_config_alloc(nng_tls_config **cfgp, nng_tls_mode mode); ---- == DESCRIPTION diff --git a/docs/man/nng_tls_config_auth_mode.3tls.adoc b/docs/man/nng_tls_config_auth_mode.3tls.adoc index da9ee0c4a..958faf020 100644 --- a/docs/man/nng_tls_config_auth_mode.3tls.adoc +++ b/docs/man/nng_tls_config_auth_mode.3tls.adoc @@ -26,7 +26,7 @@ typedef enum nng_tls_auth_mode { NNG_TLS_AUTH_MODE_REQUIRED } nng_tls_auth_mode; -int nng_tls_config_auth_mode(nni_tls_config *cfg, nng_tls_auth_mode mode); +int nng_tls_config_auth_mode(nng_tls_config *cfg, nng_tls_auth_mode mode); ---- == DESCRIPTION diff --git a/docs/man/nng_tls_config_ca_chain.3tls.adoc b/docs/man/nng_tls_config_ca_chain.3tls.adoc index 6930bbada..65468d41d 100644 --- a/docs/man/nng_tls_config_ca_chain.3tls.adoc +++ b/docs/man/nng_tls_config_ca_chain.3tls.adoc @@ -20,7 +20,7 @@ nng_tls_config_ca_chain - configure certificate authority certificate chain #include #include -int nng_tls_config_ca_cert(nni_tls_config *cfg, const char *chain, +int nng_tls_config_ca_cert(nng_tls_config *cfg, const char *chain, const char *crl); ---- diff --git a/docs/man/nng_tls_config_ca_file.3tls.adoc b/docs/man/nng_tls_config_ca_file.3tls.adoc index 04d76934c..2743425c5 100644 --- a/docs/man/nng_tls_config_ca_file.3tls.adoc +++ b/docs/man/nng_tls_config_ca_file.3tls.adoc @@ -20,7 +20,7 @@ nng_tls_config_ca_file - load certificate authority from file #include #include -int nng_tls_config_ca_file(nni_tls_config *cfg, const char *path); +int nng_tls_config_ca_file(nng_tls_config *cfg, const char *path); ---- == DESCRIPTION diff --git a/docs/man/nng_tls_config_cert_key_file.3tls.adoc b/docs/man/nng_tls_config_cert_key_file.3tls.adoc index 47581e028..70d34d458 100644 --- a/docs/man/nng_tls_config_cert_key_file.3tls.adoc +++ b/docs/man/nng_tls_config_cert_key_file.3tls.adoc @@ -20,7 +20,7 @@ nng_tls_config_cert_key_file - load own certificate and key from file #include #include -int nng_tls_config_cert_key_file(nni_tls_config *cfg, const char *path, +int nng_tls_config_cert_key_file(nng_tls_config *cfg, const char *path, const char *pass); ---- diff --git a/docs/man/nng_tls_config_free.3tls.adoc b/docs/man/nng_tls_config_free.3tls.adoc index b6733d4be..41e1b8b83 100644 --- a/docs/man/nng_tls_config_free.3tls.adoc +++ b/docs/man/nng_tls_config_free.3tls.adoc @@ -20,7 +20,7 @@ nng_tls_config_free - deallocate a TLS configuration object #include #include -void nng_tls_config_free(nni_tls_config *cfg); +void nng_tls_config_free(nng_tls_config *cfg); ---- == DESCRIPTION diff --git a/docs/man/nng_tls_config_own_cert.3tls.adoc b/docs/man/nng_tls_config_own_cert.3tls.adoc index 00c84ca96..789ae9d39 100644 --- a/docs/man/nng_tls_config_own_cert.3tls.adoc +++ b/docs/man/nng_tls_config_own_cert.3tls.adoc @@ -20,7 +20,7 @@ nng_tls_config_own_cert - configure own certificate and key #include #include -int nng_tls_config_own_cert(nni_tls_config *cfg, const char *cert, +int nng_tls_config_own_cert(nng_tls_config *cfg, const char *cert, const char *key, const char *pass); ---- diff --git a/docs/man/nng_tls_config_server_name.3tls.adoc b/docs/man/nng_tls_config_server_name.3tls.adoc index 85fe51f6b..1620f770c 100644 --- a/docs/man/nng_tls_config_server_name.3tls.adoc +++ b/docs/man/nng_tls_config_server_name.3tls.adoc @@ -20,7 +20,7 @@ nng_tls_config_server_name - configure remote server name #include #include -int nng_tls_config_server_name(nni_tls_config *cfg, const char *name); +int nng_tls_config_server_name(nng_tls_config *cfg, const char *name); ---- == DESCRIPTION