summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog6
-rw-r--r--string.c19
2 files changed, 19 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog
index 2813951efa..ea5dd07028 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+Mon Feb 27 17:00:15 2012 Akinori MUSHA <knu@iDaemons.org>
+
+ * string.c (rb_str_crypt): Update rdoc and state that this
+ function is system dependent. Reviewed by nobu, thanks to
+ @takai.
+
Mon Feb 27 17:03:20 2012 Nobuyoshi Nakada <nobu@ruby-lang.org>
* ext/bigdecimal/bigdecimal.c (GetVpValueWithPrec): since methods
diff --git a/string.c b/string.c
index e3e5fb99ac..cd8443b914 100644
--- a/string.c
+++ b/string.c
@@ -6771,12 +6771,19 @@ rb_str_oct(VALUE str)
/*
* call-seq:
- * str.crypt(other_str) -> new_str
- *
- * Applies a one-way cryptographic hash to <i>str</i> by invoking the standard
- * library function <code>crypt</code>. The argument is the salt string, which
- * should be two characters long, each character drawn from
- * <code>[a-zA-Z0-9./]</code>.
+ * str.crypt(salt_str) -> new_str
+ *
+ * Applies a one-way cryptographic hash to <i>str</i> by invoking the
+ * standard library function <code>crypt(3)</code> with the given
+ * salt string. While the format and the result are system and
+ * implementation dependent, using a salt matching the regular
+ * expression <code>^[a-zA-Z0-9./]{2}</code> should be safe and valid
+ * on any platform, in which only the first two characters are
+ * significant.
+ *
+ * This method is for use in system specific scripts, so if you want
+ * a cross-platform hash function consider using Digest or OpenSSL
+ * instead.
*/
static VALUE