aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--ChangeLog8
-rw-r--r--ext/openssl/ossl_ssl.c13
-rw-r--r--lib/uri/common.rb21
3 files changed, 33 insertions, 9 deletions
diff --git a/ChangeLog b/ChangeLog
index b49edb6327..905b2718e0 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+Tue Nov 30 05:03:44 2010 Eric Hodel <drbrain@segment7.net>
+
+ * lib/uri/common.rb (encode_www_form, encode_www_form_component):
+ Improve english in documentation.
+
+ * ext/openssl/ossl_ssl.c (ssl_version=, ciphers=): Document
+ #ssl_version=, add documentation for #ciphers=.
+
Mon Nov 29 22:55:24 2010 Nobuyoshi Nakada <nobu@ruby-lang.org>
* lib/uri/common.rb (URI::WFKV_): get rid of backtrack explosion
diff --git a/ext/openssl/ossl_ssl.c b/ext/openssl/ossl_ssl.c
index ea6e04b55a..7fe06c0937 100644
--- a/ext/openssl/ossl_ssl.c
+++ b/ext/openssl/ossl_ssl.c
@@ -147,6 +147,13 @@ ossl_sslctx_s_alloc(VALUE klass)
return Data_Wrap_Struct(klass, 0, ossl_sslctx_free, ctx);
}
+/*
+ * call-seq:
+ * ctx.ssl_version = :TLSv1
+ * ctx.ssl_version = "SSLv23_client"
+ *
+ * You can get a list of valid methods with OpenSSL::SSL::SSLContext::METHODS
+ */
static VALUE
ossl_sslctx_set_ssl_version(VALUE self, VALUE ssl_method)
{
@@ -714,6 +721,12 @@ ossl_sslctx_get_ciphers(VALUE self)
* ctx.ciphers = "cipher1:cipher2:..."
* ctx.ciphers = [name, ...]
* ctx.ciphers = [[name, version, bits, alg_bits], ...]
+ *
+ * Sets the list of available ciphers for this context. Note in a server
+ * context some ciphers require the appropriate certificates. For example, an
+ * RSA cipher can only be chosen when an RSA certificate is available.
+ *
+ * See also OpenSSL::Cipher and OpenSSL::Cipher::ciphers
*/
static VALUE
ossl_sslctx_set_ciphers(VALUE self, VALUE v)
diff --git a/lib/uri/common.rb b/lib/uri/common.rb
index 8cd2f2b069..b23e971f5e 100644
--- a/lib/uri/common.rb
+++ b/lib/uri/common.rb
@@ -733,10 +733,11 @@ module URI
# Encode given +str+ to URL-encoded form data.
#
- # This doesn't convert *, -, ., 0-9, A-Z, _, a-z,
- # does convert SP to +, and convert others to %XX.
+ # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP
+ # (ASCII space) to + and converts others to %XX.
#
- # This refers http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+ # This is an implementation of
+ # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
#
# See URI.decode_www_form_component, URI.encode_www_form
def self.encode_www_form_component(str)
@@ -786,14 +787,16 @@ module URI
#
# This internally uses URI.encode_www_form_component(str).
#
- # This doesn't convert encodings of give items, so convert them before call
- # this method if you want to send data as other than original encoding or
- # mixed encoding data. (strings which is encoded in HTML5 ASCII incompatible
- # encoding is converted to UTF-8)
+ # This method doesn't convert the encoding of given items, so convert them
+ # before call this method if you want to send data as other than original
+ # encoding or mixed encoding data. (Strings which are encoded in an HTML5
+ # ASCII incompatible encoding are converted to UTF-8.)
#
- # This doesn't treat files. When you send a file, use multipart/form-data.
+ # This method doesn't handle files. When you send a file, use
+ # multipart/form-data.
#
- # This refers http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+ # This is an implementation of
+ # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
#
# See URI.encode_www_form_component, URI.decode_www_form
def self.encode_www_form(enum)