summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2022-04-03 13:38:31 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2022-04-03 13:38:31 +0900
commitf801386f0c7051085da9d6ca660642f3aa08c81e (patch)
tree84658687f9f6b4df861d76f76b141cff71dd8d3f
parent7648bae4c86121b0b259587da11d27297c248633 (diff)
[DOC] Describe append_{c,cpp,ld}flagsv3_2_0_preview1
-rw-r--r--doc/extension.ja.rdoc8
-rw-r--r--doc/extension.rdoc7
2 files changed, 15 insertions, 0 deletions
diff --git a/doc/extension.ja.rdoc b/doc/extension.ja.rdoc
index 3b68ec6cbc..dbe814560e 100644
--- a/doc/extension.ja.rdoc
+++ b/doc/extension.ja.rdoc
@@ -1757,6 +1757,14 @@ check_sizeof(type, header) ::
`SIZEOF_{TYPE}` を定義し,そのサイズを返す.定義されていな
いときはnilを返す.
+append_cppflags(array-of-flags[, opt])
+append_cflags(array-of-flags[, opt])
+append_ldflags(array-of-flags[, opt])
+
+ 各flagが使用可能であれば,それぞれ$CPPFLAGS, $CFLAGS,
+ $LDFLAGSに追加する.コンパイラのフラグには移植性がないので,
+ 変数に直接追加せずこれらを使うことが望ましい.
+
create_makefile(target[, target_prefix]) ::
拡張ライブラリ用のMakefileを生成する.この関数を呼ばなけれ
diff --git a/doc/extension.rdoc b/doc/extension.rdoc
index 30800c2435..01bbcd816b 100644
--- a/doc/extension.rdoc
+++ b/doc/extension.rdoc
@@ -956,6 +956,9 @@ need to put
at the top of the file. You can use the functions below to check
various conditions.
+ append_cppflags(array-of-flags[, opt]): append each flag to $CPPFLAGS if usable
+ append_cflags(array-of-flags[, opt]): append each flag to $CFLAGS if usable
+ append_ldflags(array-of-flags[, opt]): append each flag to $LDFLAGS if usable
have_macro(macro[, headers[, opt]]): check whether macro is defined
have_library(lib[, func[, headers[, opt]]]): check whether library containing function exists
find_library(lib[, func, *paths]): find library from paths
@@ -984,6 +987,10 @@ The value of the variables below will affect the Makefile.
$LDFLAGS: included in LDFLAGS make variable (such as -L)
$objs: list of object file names
+Compiler/linker flags are not portable usually, you should use
++append_cppflags+, +append_cpflags+ and +append_ldflags+ respectively
+instead of appending the above variables directly.
+
Normally, the object files list is automatically generated by searching
source files, but you must define them explicitly if any sources will
be generated while building.