From 881c05817eb1d45adf437cdf2c731f5a61e069f6 Mon Sep 17 00:00:00 2001
From: yugui <yugui@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Thu, 15 Jan 2009 15:36:22 +0000
Subject: merges r21475 from trunk into ruby_1_9_1. describe
 Encoding.find("locale") in rdoc of Encoding.locale_charmap.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_9_1@21542 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 encoding.c | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'encoding.c')

diff --git a/encoding.c b/encoding.c
index f0411d16ee..6c70c74137 100644
--- a/encoding.c
+++ b/encoding.c
@@ -1207,6 +1207,11 @@ set_default_internal(VALUE klass, VALUE encoding)
  *     LANG=ja
  *       Encoding.locale_charmap  => "eucJP"
  *
+ * The result is higly platform dependent.
+ * So Encoding.find(Encoding.locale_charmap) may cause an error.
+ * If you need some encoding object even for unknown locale,
+ * Encoding.find("locale") can be used.
+ *
  */
 VALUE
 rb_locale_charmap(VALUE klass)
-- 
cgit v1.2.3