From: Patrick Pelletier Date: Sat, 21 Apr 2012 22:32:32 +0000 (-0700) Subject: documentation and comment fixes X-Git-Tag: gnutls_3_0_21~144 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bb9d96bae90cde2a5e5e18f52e1d7a7e419d2d76;p=thirdparty%2Fgnutls.git documentation and comment fixes Signed-off-by: Nikos Mavrogiannopoulos --- diff --git a/NEWS b/NEWS index 1fb3f672d9..de2a428cd3 100644 --- a/NEWS +++ b/NEWS @@ -142,7 +142,7 @@ No changes since last version. ** gnutls-cli: added the --ocsp option which will verify the peer's certificate with OCSP. -** gnutls-cli: added the --tofu and if specified, gnutls-cli +** gnutls-cli: added the --tofu option and if specified, gnutls-cli will use an ssh-style authentication method. ** gnutls-cli: if no --x509cafile is provided a default is diff --git a/README-alpha b/README-alpha index 64d60236ef..5443ef0a1b 100644 --- a/README-alpha +++ b/README-alpha @@ -20,9 +20,10 @@ We require several tools to check out and build the software, including: - Texlive & epsf (for PDF manual) - CVS (for gettext autopoint) - GTK-DOC (for API manual) -- Git +- Git - Perl - Valgrind (optional) +- Nettle - Guile - p11-kit - libtasn1 (optional) diff --git a/doc/cha-intro-tls.texi b/doc/cha-intro-tls.texi index 428319c3d1..3ab1d65190 100644 --- a/doc/cha-intro-tls.texi +++ b/doc/cha-intro-tls.texi @@ -574,7 +574,7 @@ legitimate end of data or not. @item Weak message integrity for export ciphers. The cryptographic keys in @acronym{SSLv2} are used for both message authentication and encryption, so if weak encryption schemes are -negotiated (say 40-bit keys) the message authentication code use the +negotiated (say 40-bit keys) the message authentication code uses the same weak key, which isn't necessary. @end itemize diff --git a/lib/accelerated/x86/README b/lib/accelerated/x86/README index ca3c546381..7e35c47602 100644 --- a/lib/accelerated/x86/README +++ b/lib/accelerated/x86/README @@ -1,4 +1,4 @@ -The AES-NI and Padlock implementation by Andy Polyakov are not part of the -GnuTLS library, but is used with GnuTLS. Their license is included in +The AES-NI and Padlock implementations by Andy Polyakov are not part of the +GnuTLS library, but are used with GnuTLS. Their license is included in license.txt. diff --git a/lib/auth/dh_common.c b/lib/auth/dh_common.c index f4bba1ae7a..56faee44da 100644 --- a/lib/auth/dh_common.c +++ b/lib/auth/dh_common.c @@ -22,7 +22,7 @@ /* This file contains common stuff in Ephemeral Diffie-Hellman (DHE) * and Anonymous DH key exchange(DHA). These are used in the handshake - * procedure of the certificate and anoymous authentication. + * procedure of the certificate and anonymous authentication. */ #include "gnutls_int.h" diff --git a/lib/auth/dhe.c b/lib/auth/dhe.c index 4fb59d42e8..26e0718a40 100644 --- a/lib/auth/dhe.c +++ b/lib/auth/dhe.c @@ -48,7 +48,7 @@ const mod_auth_st ecdhe_ecdsa_auth_struct = { _gnutls_gen_cert_server_crt, _gnutls_gen_cert_client_crt, gen_dhe_server_kx, - _gnutls_gen_ecdh_common_client_kx, /* This is the only different */ + _gnutls_gen_ecdh_common_client_kx, /* This is the only difference */ _gnutls_gen_cert_client_crt_vrfy, _gnutls_gen_cert_server_cert_req, @@ -65,7 +65,7 @@ const mod_auth_st ecdhe_rsa_auth_struct = { _gnutls_gen_cert_server_crt, _gnutls_gen_cert_client_crt, gen_dhe_server_kx, - _gnutls_gen_ecdh_common_client_kx, /* This is the only different */ + _gnutls_gen_ecdh_common_client_kx, /* This is the only difference */ _gnutls_gen_cert_client_crt_vrfy, _gnutls_gen_cert_server_cert_req, diff --git a/lib/auth/srp.c b/lib/auth/srp.c index 29ed633179..835c87162b 100644 --- a/lib/auth/srp.c +++ b/lib/auth/srp.c @@ -675,7 +675,7 @@ check_g_n (const uint8_t * g, size_t n_g, const uint8_t * n, size_t n_n) } /* Check if N is a prime and G a generator of the - * group. This is check only done if N is big enough. + * group. This check is only done if N is big enough. * Otherwise only the included parameters must be used. */ static int diff --git a/lib/auth/srp_sb64.c b/lib/auth/srp_sb64.c index 4298f33342..7327ab56be 100644 --- a/lib/auth/srp_sb64.c +++ b/lib/auth/srp_sb64.c @@ -27,8 +27,8 @@ #ifdef ENABLE_SRP -/* this a modified base64 for srp !!! - * It seems that everybody makes an own base64 conversion. +/* this is a modified base64 for srp !!! + * It seems that everybody makes their own base64 conversion. */ static const uint8_t b64table[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz./"; diff --git a/lib/gnutls_state.c b/lib/gnutls_state.c index 89d66f2c32..6fae277de9 100644 --- a/lib/gnutls_state.c +++ b/lib/gnutls_state.c @@ -980,17 +980,17 @@ _gnutls_PRF (gnutls_session_t session, * Apply the TLS Pseudo-Random-Function (PRF) on the master secret * and the provided data. * - * The @label variable usually contain a string denoting the purpose - * for the generated data. The @seed usually contain data such as the + * The @label variable usually contains a string denoting the purpose + * for the generated data. The @seed usually contains data such as the * client and server random, perhaps together with some additional * data that is added to guarantee uniqueness of the output for a * particular purpose. * * Because the output is not guaranteed to be unique for a particular - * session unless @seed include the client random and server random + * session unless @seed includes the client random and server random * fields (the PRF would output the same data on another connection * resumed from the first one), it is not recommended to use this - * function directly. The gnutls_prf() function seed the PRF with the + * function directly. The gnutls_prf() function seeds the PRF with the * client and server random fields directly, and is recommended if you * want to generate pseudo random data unique for each session. * @@ -1027,14 +1027,14 @@ gnutls_prf_raw (gnutls_session_t session, * Apply the TLS Pseudo-Random-Function (PRF) on the master secret * and the provided data, seeded with the client and server random fields. * - * The @label variable usually contain a string denoting the purpose - * for the generated data. The @server_random_first indicate whether + * The @label variable usually contains a string denoting the purpose + * for the generated data. The @server_random_first indicates whether * the client random field or the server random field should be first - * in the seed. Non-0 indicate that the server random field is first, + * in the seed. Non-0 indicates that the server random field is first, * 0 that the client random field is first. * * The @extra variable can be used to add more data to the seed, after - * the random variables. It can be used to tie make sure the + * the random variables. It can be used to make sure the * generated output is strongly connected to some additional data * (e.g., a string used in user authentication). * @@ -1218,7 +1218,7 @@ gnutls_session_get_ptr (gnutls_session_t session) * @ptr: is the user pointer * * This function will set (associate) the user given pointer @ptr to - * the session structure. This is pointer can be accessed with + * the session structure. This pointer can be accessed with * gnutls_session_get_ptr(). **/ void @@ -1438,7 +1438,7 @@ gnutls_protocol_get_version (gnutls_session_t session) * @client: the client part of the random * @server: the server part of the random * - * This functions returns pointers to the client and server + * This function returns pointers to the client and server * random fields used in the TLS handshake. The pointers are * not to be modified or deallocated. * diff --git a/lib/nettle/mpi.c b/lib/nettle/mpi.c index d4612b837a..cd4e9a7e78 100644 --- a/lib/nettle/mpi.c +++ b/lib/nettle/mpi.c @@ -519,7 +519,7 @@ gen_group (mpz_t * prime, mpz_t * generator, unsigned int nbits, unsigned int *q _gnutls_debug_log ("Found prime q of %u bits. Looking for generator...\n", *q_bits); - /* finally a prime! Let calculate generator + /* finally a prime! Let's calculate generator */ /* c = r^((p-1)/q), r == random