* ext/openssl/*: Document synonymous methods, by windwiny [GH-277]

zzak · zzak · commit a152c41e5357 · 2013-04-16T02:24:09.000Z
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40316 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,7 @@
+Tue Apr 16 11:23:00 2013  Zachary Scott  <zachary@zacharyscott.net>
+
+	* ext/openssl/*: Document synonymous methods, by windwiny [GH-277]
+
 Mon Apr 15 22:21:42 2013  Tanaka Akira  <akr@fsij.org>
 
 	* ext/fiddle/depend: New file.
diff --git a/ext/openssl/ossl_hmac.c b/ext/openssl/ossl_hmac.c
@@ -206,7 +206,7 @@ ossl_hmac_s_digest(VALUE klass, VALUE digest, VALUE key, VALUE data)
 
 /*
  *  call-seq:
- *     HMAC.digest(digest, key, data) -> aString
+ *     HMAC.hexdigest(digest, key, data) -> aString
  *
  */
 static VALUE
diff --git a/ext/openssl/ossl_ocsp.c b/ext/openssl/ossl_ocsp.c
@@ -149,7 +149,7 @@ ossl_ocspreq_add_nonce(int argc, VALUE *argv, VALUE self)
  *  2: nonces both absent.
  *  3: nonce present in response only.
  *  0: nonces both present and not equal.
- * -1: nonce in request only.
+ *  -1: nonce in request only.
  *
  *  For most responders clients can check return > 0.
  *  If responder doesn't handle nonces return != 0 may be
diff --git a/ext/openssl/ossl_pkey_dh.c b/ext/openssl/ossl_pkey_dh.c
@@ -278,7 +278,9 @@ ossl_dh_is_private(VALUE self)
 
 /*
  *  call-seq:
+ *     dh.export -> aString
  *     dh.to_pem -> aString
+ *     dh.to_s -> aString
  *
  * Encodes this DH to its PEM encoding. Note that any existing per-session
  * public/private keys will *not* get encoded, just the Diffie-Hellman
@@ -428,7 +430,7 @@ ossl_dh_to_public_key(VALUE self)
 
 /*
  *  call-seq:
- *     dh.check_params -> true | false
+ *     dh.params_ok? -> true | false
  *
  * Validates the Diffie-Hellman parameters associated with this instance.
  * It checks whether a safe prime and a suitable generator are used. If this
diff --git a/ext/openssl/ossl_pkey_dsa.c b/ext/openssl/ossl_pkey_dsa.c
@@ -291,7 +291,9 @@ ossl_dsa_is_private(VALUE self)
 
 /*
  *  call-seq:
+ *    dsa.export([cipher, password]) -> aString
  *    dsa.to_pem([cipher, password]) -> aString
+ *    dsa.to_s([cipher, password]) -> aString
  *
  * Encodes this DSA to its PEM encoding.
  *
diff --git a/ext/openssl/ossl_pkey_ec.c b/ext/openssl/ossl_pkey_ec.c
@@ -533,8 +533,8 @@ static VALUE ossl_ec_key_to_string(VALUE self, VALUE ciph, VALUE pass, int forma
 
 /*
  *  call-seq:
- *     key.export   => String
- *     key.export(cipher, pass_phrase) => String
+ *     key.export([cipher, pass_phrase]) => String
+ *     key.to_pem([cipher, pass_phrase]) => String
  *
  * Outputs the EC key in PEM encoding.  If +cipher+ and +pass_phrase+ are
  * given they will be used to encrypt the key.  +cipher+ must be an
@@ -843,6 +843,7 @@ static VALUE ossl_ec_group_initialize(int argc, VALUE *argv, VALUE self)
 }
 
 /*  call-seq:
+ *     group1.eql?(group2)   => true | false
  *     group1 == group2   => true | false
  *
  */
@@ -1312,6 +1313,7 @@ static VALUE ossl_ec_point_initialize(int argc, VALUE *argv, VALUE self)
 
 /*
  *  call-seq:
+ *     point1.eql?(point2) => true | false
  *     point1 == point2 => true | false
  *
  */
diff --git a/ext/openssl/ossl_pkey_rsa.c b/ext/openssl/ossl_pkey_rsa.c
@@ -291,8 +291,9 @@ ossl_rsa_is_private(VALUE self)
 
 /*
  * call-seq:
- *   rsa.to_pem                      => PEM-format String
- *   rsa.to_pem(cipher, pass_phrase) => PEM-format String
+ *   rsa.export([cipher, pass_phrase]) => PEM-format String
+ *   rsa.to_pem([cipher, pass_phrase]) => PEM-format String
+ *   rsa.to_s([cipher, pass_phrase]) => PEM-format String
  *
  * Outputs this keypair in PEM encoding.  If +cipher+ and +pass_phrase+ are
  * given they will be used to encrypt the key.  +cipher+ must be an
diff --git a/ext/openssl/ossl_ssl.c b/ext/openssl/ossl_ssl.c
@@ -1634,7 +1634,7 @@ ossl_ssl_get_peer_cert_chain(VALUE self)
 
 /*
 * call-seq:
-*    ssl.version => String
+*    ssl.ssl_version => String
 *
 * Returns a String representing the SSL/TLS version that was negotiated
 * for the connection, for example "TLSv1.2".
diff --git a/ext/openssl/ossl_x509store.c b/ext/openssl/ossl_x509store.c
@@ -257,7 +257,7 @@ ossl_x509store_add_path(VALUE self, VALUE dir)
 
 /*
  * call-seq:
- *   store.set_default_path
+ *   store.set_default_paths
  *
  * Adds the default certificates to the certificate store.  These certificates
  * are loaded from the default configuration directory which can usually be

Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ ossl_hmac_s_digest(VALUE klass, VALUE digest, VALUE key, VALUE data)`
`206`	`206`
`207`	`207`	`/*`
`208`	`208`	`* call-seq:`
`209`		`- * HMAC.digest(digest, key, data) -> aString`
	`209`	`+ * HMAC.hexdigest(digest, key, data) -> aString`
`210`	`210`	`*`
`211`	`211`	`*/`
`212`	`212`	`static VALUE`
Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ ossl_ocspreq_add_nonce(int argc, VALUE *argv, VALUE self)`
`149`	`149`	`* 2: nonces both absent.`
`150`	`150`	`* 3: nonce present in response only.`
`151`	`151`	`* 0: nonces both present and not equal.`
`152`		`- * -1: nonce in request only.`
	`152`	`+ * -1: nonce in request only.`
`153`	`153`	`*`
`154`	`154`	`* For most responders clients can check return > 0.`
`155`	`155`	`* If responder doesn't handle nonces return != 0 may be`
Original file line number	Diff line number	Diff line change
`@@ -291,7 +291,9 @@ ossl_dsa_is_private(VALUE self)`
`291`	`291`
`292`	`292`	`/*`
`293`	`293`	`* call-seq:`
	`294`	`+ * dsa.export([cipher, password]) -> aString`
`294`	`295`	`* dsa.to_pem([cipher, password]) -> aString`
	`296`	`+ * dsa.to_s([cipher, password]) -> aString`
`295`	`297`	`*`
`296`	`298`	`* Encodes this DSA to its PEM encoding.`
`297`	`299`	`*`
Original file line number	Diff line number	Diff line change
`@@ -533,8 +533,8 @@ static VALUE ossl_ec_key_to_string(VALUE self, VALUE ciph, VALUE pass, int forma`
`533`	`533`
`534`	`534`	`/*`
`535`	`535`	`* call-seq:`
`536`		`- * key.export => String`
`537`		`- * key.export(cipher, pass_phrase) => String`
	`536`	`+ * key.export([cipher, pass_phrase]) => String`
	`537`	`+ * key.to_pem([cipher, pass_phrase]) => String`
`538`	`538`	`*`
`539`	`539`	`* Outputs the EC key in PEM encoding. If +cipher+ and +pass_phrase+ are`
`540`	`540`	`* given they will be used to encrypt the key. +cipher+ must be an`
`@@ -843,6 +843,7 @@ static VALUE ossl_ec_group_initialize(int argc, VALUE *argv, VALUE self)`
`843`	`843`	`}`
`844`	`844`
`845`	`845`	`/* call-seq:`
	`846`	`+ * group1.eql?(group2) => true \| false`
`846`	`847`	`* group1 == group2 => true \| false`
`847`	`848`	`*`
`848`	`849`	`*/`
`@@ -1312,6 +1313,7 @@ static VALUE ossl_ec_point_initialize(int argc, VALUE *argv, VALUE self)`
`1312`	`1313`
`1313`	`1314`	`/*`
`1314`	`1315`	`* call-seq:`
	`1316`	`+ * point1.eql?(point2) => true \| false`
`1315`	`1317`	`* point1 == point2 => true \| false`
`1316`	`1318`	`*`
`1317`	`1319`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -1634,7 +1634,7 @@ ossl_ssl_get_peer_cert_chain(VALUE self)`
`1634`	`1634`
`1635`	`1635`	`/*`
`1636`	`1636`	`* call-seq:`
`1637`		`-* ssl.version => String`
	`1637`	`+* ssl.ssl_version => String`
`1638`	`1638`	`*`
`1639`	`1639`	`* Returns a String representing the SSL/TLS version that was negotiated`
`1640`	`1640`	`* for the connection, for example "TLSv1.2".`
Original file line number	Diff line number	Diff line change
`@@ -257,7 +257,7 @@ ossl_x509store_add_path(VALUE self, VALUE dir)`
`257`	`257`
`258`	`258`	`/*`
`259`	`259`	`* call-seq:`
`260`		`- * store.set_default_path`
	`260`	`+ * store.set_default_paths`
`261`	`261`	`*`
`262`	`262`	`* Adds the default certificates to the certificate store. These certificates`
`263`	`263`	`* are loaded from the default configuration directory which can usually be`