* README.EXT, README.EXT.ja: added macros for the Compatibilities.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@22565 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

3 files changed, 54 insertions, 0 deletions

diff --git a/ChangeLog b/ChangeLog
index e1d4316809..604daef2f8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Mon Feb 23 10:15:35 2009  Nobuyoshi Nakada  <nobu@ruby-lang.org>
+
+	* README.EXT, README.EXT.ja: added macros for the Compatibilities.
+
 Mon Feb 23 03:19:37 2009  Tanaka Akira  <akr@fsij.org>
 
 	* ext/socket/mkconstants.rb: define SO_TIMESTAMPNS and SCM_TIMESTAMPNS
diff --git a/README.EXT b/README.EXT
index 20aeaa616f..17467477ce 100644
--- a/README.EXT
+++ b/README.EXT
@@ -1252,6 +1252,31 @@ The definition of rb_event_hook_func_t is below:
 
 Removes the specified hook function.
 
+** Macros for the Compatibilities
+
+Some macros to check API compatibilities are available by default.
+
+ NORETURN_STYLE_NEW
+
+Means that NORETURN macro is functional style instead of prefix.
+
+ HAVE_RB_DEFINE_ALLOC_FUNC
+
+Means that function rb_define_alloc_func() is provided, that means the
+allocation framework is used.  This is same as the result of
+have_func("rb_define_alloc_func", "ruby.h").
+
+ HAVE_RB_REG_NEW_STR
+
+Means that function rb_reg_new_str() is provided, that creates Regexp
+object from String object.  This is same as the result of
+have_func("rb_reg_new_str", "ruby.h").
+
+ HAVE_RB_IO_T
+
+Means that type rb_io_t is provided.
+
+
 Appendix C. Functions Available in extconf.rb
 
 These functions are available in extconf.rb:
diff --git a/README.EXT.ja b/README.EXT.ja
index e8dc8bc4a9..71ac60e6ac 100644
--- a/README.EXT.ja
+++ b/README.EXT.ja
@@ -1350,6 +1350,31 @@ rb_event_hook_func_tの定義は以下の通りです:
 
 指定されたフック関数を削除します．
 
+** 互換性のためのマクロ
+
+APIの互換性をチェックするために以下のマクロがデフォルトで定義されています．
+
+NORETURN_STYLE_NEW
+
+  NORETURN マクロが関数型マクロとして定義されていることを意味する．
+
+HAVE_RB_DEFINE_ALLOC_FUNC
+
+  rb_define_alloc_func() 関数が提供されていること、つまり
+  allocation framework が使われることを意味する．
+  have_func("rb_define_alloc_func", "ruby.h")
+  の結果と同じ．
+
+HAVE_RB_REG_NEW_STR
+
+  StringオブジェクトからRegexpオブジェクトを作る
+  rb_reg_new_str() 関数が提供されていることを意味する．
+  have_func("rb_reg_new_str", "ruby.h").
+  の結果と同じ．
+
+HAVE_RB_IO_T
+
+  rb_io_t 型が提供されていることを意味する．
 
 Appendix C. extconf.rbで使える関数たち