From 7a86165d43829ed4a464dc9b14e48ffb0d1a6798 Mon Sep 17 00:00:00 2001
From: nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Fri, 18 Jan 2019 02:36:14 +0000
Subject: [DOC] mention rb_str_modify

[ruby-core:91134] [Bug #15543]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66861 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 doc/extension.ja.rdoc | 8 ++++++++
 doc/extension.rdoc    | 8 ++++++++
 2 files changed, 16 insertions(+)

(limited to 'doc')

diff --git a/doc/extension.ja.rdoc b/doc/extension.ja.rdoc
index 024aef9db4..d83be10729 100644
--- a/doc/extension.ja.rdoc
+++ b/doc/extension.ja.rdoc
@@ -301,6 +301,14 @@ rb_str_set_len(VALUE str, long len) ::
   lenバイトまでの内容は保存される．lenはstrの容量を越えてい
   てはならない．
 
+rb_str_modify(VALUE str) ::
+
+  Rubyの文字列の変更する準備をする．strが変更可能でなければ例
+  外が発生する．strのバッファが共有されている場合は，新しいバッ
+  ファを割り当てて共有されていない状態にする．RSTRING_PTRを使っ
+  て中身を変更したり，rb_str_set_lenを呼んだりする前には，
+  必ずこの関数を呼ばなけれならない．
+
 ==== 配列に対する関数
 
 rb_ary_new() ::
diff --git a/doc/extension.rdoc b/doc/extension.rdoc
index b7cba0d5e8..1355cdae64 100644
--- a/doc/extension.rdoc
+++ b/doc/extension.rdoc
@@ -279,6 +279,14 @@ rb_str_set_len(VALUE str, long len) ::
   up to len bytes, regardless RSTRING_LEN(str).  len must not exceed
   the capacity of str.
 
+rb_str_modify(VALUE str) ::
+
+  Prepares a Ruby string to modify.  If str is not modifiable, this
+  function raises an exception, or if the buffer of str is shared,
+  this function allocates new buffer to make it unshared.  Always
+  you MUST call this function before modifying the contents using
+  RSTRING_PTR and/or rb_str_set_len.
+
 ==== Array Functions
 
 rb_ary_new() ::
-- 
cgit v1.2.3