diff options
Diffstat (limited to 'manual.md')
| -rw-r--r-- | manual.md | 222 |
1 files changed, 111 insertions, 111 deletions
@@ -475,86 +475,86 @@ target("test2") Translating ..., help me please! [Edit this page](https://github.com/tboox/xmake/blob/master/docs/manual.md) </p> -| Interfaces | Description | Support version | -| --------------------------------------------- | ------------------------------------ | ----------------------- | -| [target](#target) | 定义工程目标 | >= 1.0.1 | -| [target_end](#target_end) | 结束定义工程目标 | >= 2.1.1 | -| [set_kind](#targetset_kind) | 设置目标编译类型 | >= 1.0.1 | -| [set_strip](#targetset_strip) | 设置是否strip信息 | >= 1.0.1 | -| [set_default](#targetset_default) | 设置是否为默认构建安装目标 | >= 2.1.3 | -| [set_options](#targetset_options) | 设置关联选项 | >= 1.0.1 | -| [set_symbols](#targetset_symbols) | 设置符号信息 | >= 1.0.1 | -| [set_basename](#targetset_basename) | 设置目标文件名 | >= 2.1.2 | -| [set_warnings](#targetset_warnings) | 设置警告级别 | >= 1.0.1 | -| [set_optimize](#targetset_optimize) | 设置优化级别 | >= 1.0.1 | -| [set_languages](#targetset_languages) | 设置代码语言标准 | >= 1.0.1 | -| [set_headerdir](#targetset_headerdir) | 设置头文件安装目录 | >= 1.0.1 | -| [set_targetdir](#targetset_targetdir) | 设置生成目标文件目录 | >= 1.0.1 | -| [set_objectdir](#targetset_objectdir) | 设置对象文件生成目录 | >= 1.0.1 | -| [add_imports](#targetadd_imports) | 为所有自定义脚本预先导入扩展模块 | >= 2.1.7 | -| [add_rules](#targetadd_rules) | 添加规则到目标 | >= 2.1.9 | -| [on_load](#targeton_load) | 自定义目标加载脚本 | >= 2.1.5 | -| [on_build](#targeton_build) | 自定义编译脚本 | >= 2.0.1 | -| [on_clean](#targeton_clean) | 自定义清理脚本 | >= 2.0.1 | -| [on_package](#targeton_package) | 自定义打包脚本 | >= 2.0.1 | -| [on_install](#targeton_install) | 自定义安装脚本 | >= 2.0.1 | -| [on_uninstall](#targeton_uninstall) | 自定义卸载脚本 | >= 2.0.1 | -| [on_run](#targeton_run) | 自定义运行脚本 | >= 2.0.1 | -| [before_build](#targetbefore_build) | 在构建之前执行一些自定义脚本 | >= 2.0.1 | -| [before_clean](#targetbefore_clean) | 在清除之前执行一些自定义脚本 | >= 2.0.1 | -| [before_package](#targetbefore_package) | 在打包之前执行一些自定义脚本 | >= 2.0.1 | -| [before_install](#targetbefore_install) | 在安装之前执行一些自定义脚本 | >= 2.0.1 | -| [before_uninstall](#targetbefore_uninstall) | 在卸载之前执行一些自定义脚本 | >= 2.0.1 | -| [before_run](#targetbefore_run) | 在运行之前执行一些自定义脚本 | >= 2.0.1 | -| [after_build](#targetafter_build) | 在构建之后执行一些自定义脚本 | >= 2.0.1 | -| [after_clean](#targetafter_clean) | 在清除之后执行一些自定义脚本 | >= 2.0.1 | -| [after_package](#targetafter_package) | 在打包之后执行一些自定义脚本 | >= 2.0.1 | -| [after_install](#targetafter_install) | 在安装之后执行一些自定义脚本 | >= 2.0.1 | -| [after_uninstall](#targetafter_uninstall) | 在卸载之后执行一些自定义脚本 | >= 2.0.1 | -| [after_run](#targetafter_run) | 在运行之后执行一些自定义脚本 | >= 2.0.1 | -| [set_config_h](#targetset_config_h) | 设置自动生成的配置头文件路径 | >= 1.0.1 < 2.1.5 已废弃 | -| [set_config_h_prefix](#targetset_config_h) | 设置自动生成的头文件中宏定义命名前缀 | >= 1.0.1 < 2.1.5 已废弃 | -| [set_config_header](#targetset_config_header) | 设置自动生成的配置头文件路径和前缀 | >= 2.1.5 | -| [set_pcheader](#targetset_pcheader) | 设置c预编译头文件 | >= 2.1.5 | -| [set_pcxxheader](#targetset_pcxxheader) | 设置c++预编译头文件 | >= 2.1.5 | -| [add_deps](#targetadd_deps) | 添加子工程目标依赖 | >= 1.0.1 | -| [add_links](#targetadd_links) | 添加链接库名 | >= 1.0.1 | -| [add_files](#targetadd_files) | 添加源代码文件 | >= 1.0.1 | -| [del_files](#targetdel_files) | 从前面的源文件列表中删除指定文件 | >= 2.1.9 | -| [add_headers](#targetadd_headers) | 添加安装的头文件 | >= 1.0.1 | -| [add_linkdirs](#targetadd_linkdirs) | 添加链接库搜索目录 | >= 1.0.1 | -| [add_rpathdirs](#targetadd_rpathdirs) | 添加运行时候动态链接库搜索目录 | >= 2.1.3 | -| [add_includedirs](#targetadd_includedirs) | 添加头文件搜索目录 | >= 1.0.1 | -| [add_defines](#targetadd_defines) | 添加宏定义 | >= 1.0.1 | -| [add_undefines](#targetadd_undefines) | 取消宏定义 | >= 1.0.1 | -| [add_defines_h](#targetadd_defines_h) | 添加宏定义到头文件 | >= 1.0.1 | -| [add_undefines_h](#targetadd_undefines_h) | 取消宏定义到头文件 | >= 1.0.1 | -| [add_cflags](#targetadd_cflags) | 添加c编译选项 | >= 1.0.1 | -| [add_cxflags](#targetadd_cxflags) | 添加c/c++编译选项 | >= 1.0.1 | -| [add_cxxflags](#targetadd_cxxflags) | 添加c++编译选项 | >= 1.0.1 | -| [add_mflags](#targetadd_mflags) | 添加objc编译选项 | >= 1.0.1 | -| [add_mxflags](#targetadd_mxflags) | 添加objc/objc++编译选项 | >= 1.0.1 | -| [add_mxxflags](#targetadd_mxxflags) | 添加objc++编译选项 | >= 1.0.1 | -| [add_scflags](#targetadd_scflags) | 添加swift编译选项 | >= 2.0.1 | -| [add_asflags](#targetadd_asflags) | 添加汇编编译选项 | >= 2.0.1 | -| [add_gcflags](#targetadd_gcflags) | 添加go编译选项 | >= 2.1.1 | -| [add_ldflags](#targetadd_ldflags) | 添加链接选项 | >= 1.0.1 | -| [add_arflags](#targetadd_arflags) | 添加静态库归档选项 | >= 1.0.1 | -| [add_shflags](#targetadd_shflags) | 添加动态库链接选项 | >= 1.0.1 | -| [add_cfunc](#targetadd_cfunc) | 添加单个c库函数检测 | >= 2.0.1 | -| [add_cxxfunc](#targetadd_cxxfunc) | 添加单个c++库函数检测 | >= 2.0.1 | -| [add_cfuncs](#targetadd_cfuncs) | 添加c库函数检测 | >= 2.0.1 | -| [add_cxxfuncs](#targetadd_cxxfuncs) | 添加c++库函数接口 | >= 2.0.1 | -| [add_packages](#targetadd_packages) | 添加包依赖 | >= 2.0.1 | -| [add_options](#targetadd_options) | 添加关联选项 | >= 2.0.1 | -| [add_languages](#targetadd_languages) | 添加语言标准 | >= 1.0.1 | -| [add_vectorexts](#targetadd_vectorexts) | 添加向量扩展指令 | >= 1.0.1 | -| [add_frameworks](#targetadd_frameworks) | 添加链接框架 | >= 2.1.1 | -| [add_frameworkdirs](#targetadd_frameworkdirs) | 添加链接框架的搜索目录 | >= 2.1.5 | +| Interfaces | Description | Support version | +| --------------------------------------------- | -------------------------------------------- | --------------------------- | +| [target](#target) | Define a project target | >= 1.0.1 | +| [target_end](#target_end) | End target definition | >= 2.1.1 | +| [set_kind](#targetset_kind) | Set target kind | >= 1.0.1 | +| [set_strip](#targetset_strip) | Strip target symbols | >= 1.0.1 | +| [set_default](#targetset_default) | Mark as default target | >= 2.1.3 | +| [set_options](#targetset_options) | Set configuartion options | >= 1.0.1 | +| [set_symbols](#targetset_symbols) | Set symbol info | >= 1.0.1 | +| [set_basename](#targetset_basename) | Set the base name for target file | >= 2.1.2 | +| [set_warnings](#targetset_warnings) | Set compilation warning level | >= 1.0.1 | +| [set_optimize](#targetset_optimize) | Set compilation optimization level | >= 1.0.1 | +| [set_languages](#targetset_languages) | Set source code language standards | >= 1.0.1 | +| [set_headerdir](#targetset_headerdir) | Set output directories for header files | >= 1.0.1 | +| [set_targetdir](#targetset_targetdir) | Set output directories for target file | >= 1.0.1 | +| [set_objectdir](#targetset_objectdir) | Set output directories for object files | >= 1.0.1 | +| [add_imports](#targetadd_imports) | Add imported modules for the custom script | >= 2.1.7 | +| [add_rules](#targetadd_rules) | Add custom compilation rule to target | >= 2.1.9 | +| [on_load](#targeton_load) | Run custom load target configuartion script | >= 2.1.5 | +| [on_build](#targeton_build) | Run custom build target script | >= 2.0.1 | +| [on_clean](#targeton_clean) | Run custom clean files script | >= 2.0.1 | +| [on_package](#targeton_package) | Run custom package target script | >= 2.0.1 | +| [on_install](#targeton_install) | Run custom install target file script | >= 2.0.1 | +| [on_uninstall](#targeton_uninstall) | Run custom uninstall target file script | >= 2.0.1 | +| [on_run](#targeton_run) | Run custom run target script | >= 2.0.1 | +| [before_build](#targetbefore_build) | Run custom script before building target | >= 2.0.1 | +| [before_clean](#targetbefore_clean) | Run custom script before cleaning target | >= 2.0.1 | +| [before_package](#targetbefore_package) | Run custom script before packaging target | >= 2.0.1 | +| [before_install](#targetbefore_install) | Run custom script before installing target | >= 2.0.1 | +| [before_uninstall](#targetbefore_uninstall) | Run custom script before uninstalling target | >= 2.0.1 | +| [before_run](#targetbefore_run) | Run custom script before running target | >= 2.0.1 | +| [after_build](#targetafter_build) | Run custom script after building target | >= 2.0.1 | +| [after_clean](#targetafter_clean) | Run custom script after cleaning target | >= 2.0.1 | +| [after_package](#targetafter_package) | Run custom script after packaging target | >= 2.0.1 | +| [after_install](#targetafter_install) | Run custom script after installing target | >= 2.0.1 | +| [after_uninstall](#targetafter_uninstall) | Run custom script after uninstalling target | >= 2.0.1 | +| [after_run](#targetafter_run) | Run custom script after running target | >= 2.0.1 | +| [set_config_h](#targetset_config_h) | 设置自动生成的配置头文件路径 | >= 1.0.1 < 2.1.5 deprecated | +| [set_config_h_prefix](#targetset_config_h) | 设置自动生成的头文件中宏定义命名前缀 | >= 1.0.1 < 2.1.5 deprecated | +| [set_config_header](#targetset_config_header) | 设置自动生成的配置头文件路径和前缀 | >= 2.1.5 | +| [set_pcheader](#targetset_pcheader) | 设置c预编译头文件 | >= 2.1.5 | +| [set_pcxxheader](#targetset_pcxxheader) | 设置c++预编译头文件 | >= 2.1.5 | +| [add_deps](#targetadd_deps) | 添加子工程目标依赖 | >= 1.0.1 | +| [add_links](#targetadd_links) | 添加链接库名 | >= 1.0.1 | +| [add_files](#targetadd_files) | 添加源代码文件 | >= 1.0.1 | +| [del_files](#targetdel_files) | 从前面的源文件列表中删除指定文件 | >= 2.1.9 | +| [add_headers](#targetadd_headers) | 添加安装的头文件 | >= 1.0.1 | +| [add_linkdirs](#targetadd_linkdirs) | 添加链接库搜索目录 | >= 1.0.1 | +| [add_rpathdirs](#targetadd_rpathdirs) | 添加运行时候动态链接库搜索目录 | >= 2.1.3 | +| [add_includedirs](#targetadd_includedirs) | 添加头文件搜索目录 | >= 1.0.1 | +| [add_defines](#targetadd_defines) | 添加宏定义 | >= 1.0.1 | +| [add_undefines](#targetadd_undefines) | 取消宏定义 | >= 1.0.1 | +| [add_defines_h](#targetadd_defines_h) | 添加宏定义到头文件 | >= 1.0.1 | +| [add_undefines_h](#targetadd_undefines_h) | 取消宏定义到头文件 | >= 1.0.1 | +| [add_cflags](#targetadd_cflags) | 添加c编译选项 | >= 1.0.1 | +| [add_cxflags](#targetadd_cxflags) | 添加c/c++编译选项 | >= 1.0.1 | +| [add_cxxflags](#targetadd_cxxflags) | 添加c++编译选项 | >= 1.0.1 | +| [add_mflags](#targetadd_mflags) | 添加objc编译选项 | >= 1.0.1 | +| [add_mxflags](#targetadd_mxflags) | 添加objc/objc++编译选项 | >= 1.0.1 | +| [add_mxxflags](#targetadd_mxxflags) | 添加objc++编译选项 | >= 1.0.1 | +| [add_scflags](#targetadd_scflags) | 添加swift编译选项 | >= 2.0.1 | +| [add_asflags](#targetadd_asflags) | 添加汇编编译选项 | >= 2.0.1 | +| [add_gcflags](#targetadd_gcflags) | 添加go编译选项 | >= 2.1.1 | +| [add_ldflags](#targetadd_ldflags) | 添加链接选项 | >= 1.0.1 | +| [add_arflags](#targetadd_arflags) | 添加静态库归档选项 | >= 1.0.1 | +| [add_shflags](#targetadd_shflags) | 添加动态库链接选项 | >= 1.0.1 | +| [add_cfunc](#targetadd_cfunc) | 添加单个c库函数检测 | >= 2.0.1 | +| [add_cxxfunc](#targetadd_cxxfunc) | 添加单个c++库函数检测 | >= 2.0.1 | +| [add_cfuncs](#targetadd_cfuncs) | 添加c库函数检测 | >= 2.0.1 | +| [add_cxxfuncs](#targetadd_cxxfuncs) | 添加c++库函数接口 | >= 2.0.1 | +| [add_packages](#targetadd_packages) | 添加包依赖 | >= 2.0.1 | +| [add_options](#targetadd_options) | 添加关联选项 | >= 2.0.1 | +| [add_languages](#targetadd_languages) | 添加语言标准 | >= 1.0.1 | +| [add_vectorexts](#targetadd_vectorexts) | 添加向量扩展指令 | >= 1.0.1 | +| [add_frameworks](#targetadd_frameworks) | 添加链接框架 | >= 2.1.1 | +| [add_frameworkdirs](#targetadd_frameworkdirs) | 添加链接框架的搜索目录 | >= 2.1.5 | ##### target -###### 定义工程目标 +###### Define a project target 定义一个新的控制台工程目标，工程名为`test`，最后生成的目标名也是`test`。 @@ -600,7 +600,7 @@ target("test") ##### target_end -###### 结束定义工程目标 +###### End target definition 这是一个可选的api，如果不调用，那么`target("xxx")`之后的所有设置都是针对这个target进行的，除非进入其他`target`, `option`, `task`域。 @@ -633,7 +633,7 @@ target("test2") ##### target:set_kind -###### 设置目标编译类型 +###### Set target kind 设置目标类型，目前支持的类型有： @@ -650,7 +650,7 @@ target("demo") ##### target:set_strip -###### 设置是否strip信息 +###### Strip target symbols 设置当前目标的strip模式，目前支持一下模式： @@ -672,7 +672,7 @@ target("xxxx") ##### target:set_default -###### 设置是否为默认构建安装目标 +###### Mark as default target 这个接口用于设置给定工程目标是否作为默认构建，如果没有调用此接口进行设置，那么这个目标就是默认被构建的，例如： @@ -717,7 +717,7 @@ $ xmake install [-a|--all] ##### target:set_options -###### 设置关联选项 +###### Set configuartion options 添加选项依赖，如果通过[option](#option)接口自定义了一些选项，那么只有在指定`target`目标域下，添加此选项，才能进行关联生效。 @@ -739,7 +739,7 @@ target("test") ##### target:set_symbols -###### 设置符号信息 +###### Set symbol info 设置目标的符号模式，如果当前没有定义target，那么将会设置到全局状态中，影响所有后续的目标。 @@ -761,7 +761,7 @@ set_symbols("debug", "hidden") ##### target:set_basename -###### 设置目标文件名 +###### Set the base name for target file 默认情况下，生成的目标文件名基于`target("name")`中配置的值，例如： @@ -793,7 +793,7 @@ target("xxx") ##### target:set_warnings -###### 设置警告级别 +###### Set compilation warning level 设置当前目标的编译的警告级别，一般支持一下几个级别： @@ -816,7 +816,7 @@ set_warnings("all", "error") ##### target:set_optimize -###### 设置优化级别 +###### Set compilation optimization level 设置目标的编译优化等级，如果当前没有设置目标，那么将会设置到全局状态中，影响所有后续的目标。 @@ -840,7 +840,7 @@ set_optimize("fastest") ##### target:set_languages -###### 设置代码语言标准 +###### Set source code language standards 设置目标代码编译的语言标准，如果当前没有目标存在，将会设置到全局模式中。。。 @@ -882,7 +882,7 @@ windows下vs的编译器并不支持按c99的标准来编译c代码，只能支 ##### target:set_headerdir -###### 设置头文件安装目录 +###### Set output directories for header files 设置头文件的输出目录，默认输出到build目录中。 @@ -895,7 +895,7 @@ target("test") ##### target:set_targetdir -###### 设置生成目标文件目录 +###### Set output directories for target files 设置目标程序文件的输出目录，一般情况下，不需要设置，默认会输出在build目录下 @@ -920,7 +920,7 @@ target("test") ##### target:set_objectdir -###### 设置对象文件生成目录 +###### Set output directories for object files 设置目标target的对象文件(`*.o/obj`)的输出目录，例如: @@ -931,7 +931,7 @@ target("test") ##### target:add_imports -###### 为自定义脚本预先导入扩展模块 +###### Add imported modules for the custom script 通常，我们在[on_build](#targeton_build)等自定义脚本内部，可以通过`import("core.base.task")`的方式导入扩展模块， 但是对于自定义脚本比较多的情况下，每个自定义脚本都重复导入一遍，非常的繁琐，那么可以通过这个接口，实现预先导入，例如： @@ -976,7 +976,7 @@ target("test") ##### target:add_rules -###### 添加规则到目标 +###### Add custom compilation rule to target 我们可以通过预先设置规则支持的文件后缀，来扩展其他文件的构建支持： @@ -1003,7 +1003,7 @@ target("test") ##### target:on_load -###### 自定义目标加载脚本 +###### Run custom load target configuartion script 在target初始化加载的时候，将会执行此脚本，在里面可以做一些动态的目标配置，实现更灵活的目标描述定义，例如： @@ -1020,7 +1020,7 @@ target("test") ##### target:on_build -###### 自定义编译脚本 +###### Run custom build target script 覆盖target目标默认的构建行为，实现自定义的编译过程，一般情况下，并不需要这么做，除非确实需要做一些xmake默认没有提供的编译操作。 @@ -1061,7 +1061,7 @@ target("test") ##### target:on_clean -###### 自定义清理脚本 +###### Run custom clean files script 覆盖target目标的`xmake [c|clean}`的清理操作，实现自定义清理过程。 @@ -1093,7 +1093,7 @@ target("test") ##### target:on_package -###### 自定义打包脚本 +###### Run custom package target script 覆盖target目标的`xmake [p|package}`的打包操作，实现自定义打包过程，如果你想对指定target打包成自己想要的格式，可以通过这个接口自定义它。 @@ -1127,7 +1127,7 @@ target("demo") ##### target:on_install -###### 自定义安装脚本 +###### Run custom install target file script 覆盖target目标的`xmake [i|install}`的安装操作，实现自定义安装过程。 @@ -1146,7 +1146,7 @@ target("test") ##### target:on_uninstall -###### 自定义卸载脚本 +###### Run custom uninstall target file script 覆盖target目标的`xmake [u|uninstall}`的卸载操作，实现自定义卸载过程。 @@ -1159,7 +1159,7 @@ target("test") ##### target:on_run -###### 自定义运行脚本 +###### Run custom run target script 覆盖target目标的`xmake [r|run}`的运行操作，实现自定义运行过程。 @@ -1178,7 +1178,7 @@ target("test") ##### target:before_build -###### 在构建之前执行一些自定义脚本 +###### Run custom script before building target 并不会覆盖默认的构建操作，只是在构建之前增加一些自定义的操作。 @@ -1191,7 +1191,7 @@ target("test") ##### target:before_clean -###### 在清理之前执行一些自定义脚本 +###### Run custom script before cleaning target 并不会覆盖默认的清理操作，只是在清理之前增加一些自定义的操作。 @@ -1204,7 +1204,7 @@ target("test") ##### target:before_package -###### 在打包之前执行一些自定义脚本 +###### Run custom script before packaging target 并不会覆盖默认的打包操作，只是在打包之前增加一些自定义的操作。 @@ -1217,7 +1217,7 @@ target("test") ##### target:before_install -###### 在安装之前执行一些自定义脚本 +###### Run custom script before installing target 并不会覆盖默认的安装操作，只是在安装之前增加一些自定义的操作。 @@ -1230,7 +1230,7 @@ target("test") ##### target:before_uninstall -###### 在卸载之前执行一些自定义脚本 +###### Run custom script before uninstalling target 并不会覆盖默认的卸载操作，只是在卸载之前增加一些自定义的操作。 @@ -1243,7 +1243,7 @@ target("test") ##### target:before_run -###### 在运行之前执行一些自定义脚本 +###### Run custom script before running target 并不会覆盖默认的运行操作，只是在运行之前增加一些自定义的操作。 @@ -1256,7 +1256,7 @@ target("test") ##### target:after_build -###### 在构建之后执行一些自定义脚本 +###### Run custom script after building target 并不会覆盖默认的构建操作，只是在构建之后增加一些自定义的操作。 @@ -1271,7 +1271,7 @@ target("test") ##### target:after_clean -###### 在清理之后执行一些自定义脚本 +###### Run custom script after cleaning target 并不会覆盖默认的清理操作，只是在清理之后增加一些自定义的操作。 @@ -1286,7 +1286,7 @@ target("test") ##### target:after_package -###### 在打包之后执行一些自定义脚本 +###### Run custom script after packaging target 并不会覆盖默认的打包操作，只是在打包之后增加一些自定义的操作。 @@ -1299,7 +1299,7 @@ target("test") ##### target:after_install -###### 在安装之后执行一些自定义脚本 +###### Run custom script after installing target 并不会覆盖默认的安装操作，只是在安装之后增加一些自定义的操作。 @@ -1311,7 +1311,7 @@ target("test") ``` ##### target:after_uninstall -###### 在卸载之后执行一些自定义脚本 +###### Run custom script after uninstalling target 并不会覆盖默认的卸载操作，只是在卸载之后增加一些自定义的操作。 @@ -1324,7 +1324,7 @@ target("test") ##### target:after_run -###### 在运行之后执行一些自定义脚本 +###### Run custom script after running target 并不会覆盖默认的运行操作，只是在运行之后增加一些自定义的操作。 |