OSDN > Buscar Software > YSLib > SCM > hg > YSLib-wiki > Commit

YSLib
Fork
YSLib
YSLib-wiki

YSLib-wiki: Commit

The wiki source of YSLib documentation.

Tools/Scripts.zh-CN.md: 添加新的约定、函数和变量的文档。

diff -r bcea1fd4e2ea -r 1ec85689eb4d Tools/Scripts.zh-CN.md

--- a/Tools/Scripts.zh-CN.md Wed Dec 24 06:45:32 2014 +0800

+++ b/Tools/Scripts.zh-CN.md Thu Dec 25 06:01:25 2014 +0800

		@@ -71,6 +71,12 @@
71	71
72	72	这个目录的脚本可用于整个项目或项目核心部分的构建工具使用。
73	73
	74	+当前有以下脚本忽略重复的 `.` 或 `source` ：
	75	+
	76	+* SHBuild-common.sh
	77	+
	78	+以前缀 `SHBuild_` 起始的名称保留使用。其中前缀 `SHBuild_Env_` 总是表示环境配置的只读变量名。
	79	+
74	80	## Tools/Scripts/SHBuild-bootstrap.sh
75	81
76	82	编译 [Stage1 SHBuild](SHBuild.zh-CN.md) 时被包含的脚本。

		@@ -148,6 +154,38 @@
148	154
149	155	这个脚本是公开的工具，被 `Tools/install-sysroot.sh` 部署到 `usr/bin` 目录下。
150	156
	157	+### 函数 SHBuild_AssertNonempty
	158	+
	159	+断言第一参数为名称的变量非空，否则显示出错并退出。
	160	+
	161	+使用 `eval` 实现。
	162	+
	163	+### 函数 SHBuild_CheckedCall
	164	+
	165	+断言第一参数为名称的变量非空，若空则使用 `eval` 对后续求值并初始化第一参数指定的只读变量。若发生初始化则在标准输出中显示。
	166	+
	167	+### 函数 SHBuild_InitReadonly
	168	+
	169	+检查第一参数为名称的命令存在，否则显示出错并退出。
	170	+
	171	+使用 `hash` 实现以优化性能。
	172	+
	173	+### 函数 SHBuild_CheckUName
	174	+
	175	+调用 `SHBuild_CheckedCall` 初始化只读变量 `SHBuild_Env_OS` 和 `SHBuild_Env_Arch` 的值。
	176	+
	177	+变量 `SHBuild_Env_OS` 的值标识操作系统：
	178	+
	179	+* `unkonwn` ：不支持的系统
	180	+* `OS_X` ： `uname` 结果符合 \Darwin\ ，用于标识 OS X 系统
	181	+* `Win32` ： `uname` 结果符合 \MIGW\ 或 \MSYS\ ，用于标识 Windows （桌面）系统
	182	+* `Linux` ： `uname` 结果符合 \Linux\ ，用于标识 Linux 系统
	183	+
	184	+变量 `SHBuild_Env_Arch` 的值标识体系结构：
	185	+
	186	+* `unkonwn` ：不支持的体系结构
	187	+* 其它值：当前支持的体系结构 `uname -m` 的结果，主要包括 i686 和 x86_64
	188	+
151	189	### 函数 SHBuild_2u
152	190
153	191	接受 1 个表示路径的参数。

		@@ -328,6 +366,14 @@
328	366
329	367	默认值为 `$LDFLAGS_DYN_EXTRA` 和 $LDFLAGS_DYN` 的总和。
330	368
	369	+### 变量 LIBPFX
	370	+
	371	+库前缀。在 Windows 下默认不设置，否则默认值为 `lib` 。
	372	+
	373	+### 变量 DSOPFX
	374	+
	375	+动态库文件名后缀。在 Windows 下默认为 `.dll` ，否则默认值为 `.so` 。
	376	+
331	377	### 变量 LDFLAGS
332	378
333	379	链接器使用的命令行选项。