]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
documentation and comment fixes
authorPatrick Pelletier <code@funwithsoftware.org>
Sat, 21 Apr 2012 22:32:32 +0000 (15:32 -0700)
committerNikos Mavrogiannopoulos <nmav@gnutls.org>
Sun, 22 Apr 2012 15:25:30 +0000 (17:25 +0200)
Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
NEWS
README-alpha
doc/cha-intro-tls.texi
lib/accelerated/x86/README
lib/auth/dh_common.c
lib/auth/dhe.c
lib/auth/srp.c
lib/auth/srp_sb64.c
lib/gnutls_state.c
lib/nettle/mpi.c

diff --git a/NEWS b/NEWS
index 1fb3f672d996ddb95ce276ab130bd8489ebe6698..de2a428cd36735464565792f780e1a66e8ff6a03 100644 (file)
--- 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
index 64d60236ef13a7fed0fc16e218432ff743916c38..5443ef0a1b478e679c61a6a1a3cf17afb131557b 100644 (file)
@@ -20,9 +20,10 @@ We require several tools to check out and build the software, including:
 - Texlive & epsf <http://www.tug.org/texlive/> (for PDF manual)
 - CVS <http://www.gnu.org/software/cvs/> (for gettext autopoint)
 - GTK-DOC <http://www.gtk.org/gtk-doc/> (for API manual)
-- Git <http://git.or.cz/>
+- Git <http://git-scm.com/>
 - Perl <http://www.cpan.org/>
 - Valgrind <http://valgrind.org/> (optional)
+- Nettle <http://www.lysator.liu.se/~nisse/nettle/>
 - Guile <http://www.gnu.org/software/guile/>
 - p11-kit <http://p11-glue.freedesktop.org/p11-kit.html>
 - libtasn1 <http://josefsson.org/libtasn1/> (optional)
index 428319c3d172d16d43733165190ae137fc886029..3ab1d651909898716e2b47b22910f96d5847a52f 100644 (file)
@@ -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
index ca3c546381d2b0ca32a6a0bc120df4cd8d11b193..7e35c47602e0fb674d7d7334ab617b0e16b0765b 100644 (file)
@@ -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.
 
index f4bba1ae7a7875b370894cee6e913d035c177455..56faee44daa47056eaeeb6ee7e98c76abfb94a1c 100644 (file)
@@ -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"
index 4fb59d42e850313fa37eba7b5cde8610f16e19bf..26e0718a407c9194318d4d4570ea99b0af7d19ef 100644 (file)
@@ -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,
 
index 29ed633179d82d7adb9c21c6a25b15666e5c9e67..835c87162bd59b170712ffe93c8706627678fc8e 100644 (file)
@@ -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
index 4298f333422d101e3e0059cc9df60e79ac3e9f4d..7327ab56bed7e7414589c7de36c409774051db24 100644 (file)
@@ -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./";
index 89d66f2c327db58e8a6e78c63ead5ae8a05881b3..6fae277de96ca9c150a116c95f4d5267b95d0c99 100644 (file)
@@ -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.
  *
index d4612b837acbbb84abb7db38dab7bd9f9bf9c585..cd4e9a7e78f87f002363920b0cbb225d5ed7e656 100644 (file)
@@ -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