diff options
| author | spreis <spreis@yandex-team.ru> | 2022-02-10 16:47:13 +0300 |
|---|---|---|
| committer | Daniil Cherednik <dcherednik@yandex-team.ru> | 2022-02-10 16:47:13 +0300 |
| commit | b49848d6e361b76904f094b7d5e10d6edea75afe (patch) | |
| tree | 9814fbd1c3effac9b8377c5d604b367b14e2db55 /build/docs | |
| parent | bcd1126cbd5d445cd0665d295198aa39c6ab8cbe (diff) | |
| download | ydb-b49848d6e361b76904f094b7d5e10d6edea75afe.tar.gz | |
Restoring authorship annotation for <spreis@yandex-team.ru>. Commit 2 of 2.
Diffstat (limited to 'build/docs')
| -rw-r--r-- | build/docs/all.md | 3848 | ||||
| -rw-r--r-- | build/docs/readme.md | 3006 |
2 files changed, 3427 insertions, 3427 deletions
diff --git a/build/docs/all.md b/build/docs/all.md index fac9594281..50051b596c 100644 --- a/build/docs/all.md +++ b/build/docs/all.md @@ -1,14 +1,14 @@ *Do not edit, this file is generated from comments to macros definitions using `ya dump conf-docs -all`.* -# ya.make and core.conf commands - -General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles) - -## Table of contents - - * [Multimodules](#multimodules) +# ya.make and core.conf commands + +General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles) + +## Table of contents + + * [Multimodules](#multimodules) - Multimodule [DLL_JAVA](#multimodule_DLL_JAVA) - - Multimodule [DOCS](#multimodule_DOCS) + - Multimodule [DOCS](#multimodule_DOCS) - Multimodule [DYNAMIC_LIBRARY](#multimodule_DYNAMIC_LIBRARY) - Multimodule [FBS_LIBRARY](#multimodule_FBS_LIBRARY) - Multimodule [JAR_PROGRAM](#multimodule_JAR_PROGRAM) @@ -20,22 +20,22 @@ General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/Ho - Multimodule [JUNIT5](#multimodule_JUNIT5) - Multimodule [JUNIT5_YMAKE](#multimodule_JUNIT5_YMAKE) - Multimodule [MAPS_IDL_LIBRARY](#multimodule_MAPS_IDL_LIBRARY) - - Multimodule [PROTO_LIBRARY](#multimodule_PROTO_LIBRARY) - - Multimodule [PY23_LIBRARY](#multimodule_PY23_LIBRARY) - - Multimodule [PY23_NATIVE_LIBRARY](#multimodule_PY23_NATIVE_LIBRARY) + - Multimodule [PROTO_LIBRARY](#multimodule_PROTO_LIBRARY) + - Multimodule [PY23_LIBRARY](#multimodule_PY23_LIBRARY) + - Multimodule [PY23_NATIVE_LIBRARY](#multimodule_PY23_NATIVE_LIBRARY) - Multimodule [PY23_TEST](#multimodule_PY23_TEST) - Multimodule [PY3TEST](#multimodule_PY3TEST) - Multimodule [PY3_PROGRAM](#multimodule_PY3_PROGRAM) - Multimodule [SANDBOX_PY23_TASK](#multimodule_SANDBOX_PY23_TASK) - Multimodule [SANDBOX_PY3_TASK](#multimodule_SANDBOX_PY3_TASK) - - Multimodule [SANDBOX_TASK](#multimodule_SANDBOX_TASK) + - Multimodule [SANDBOX_TASK](#multimodule_SANDBOX_TASK) - Multimodule [SSQLS_LIBRARY](#multimodule_SSQLS_LIBRARY) - - Multimodule [YQL_UDF](#multimodule_YQL_UDF) - * [Modules](#modules) + - Multimodule [YQL_UDF](#multimodule_YQL_UDF) + * [Modules](#modules) - Module [AAR](#module_AAR) - Module [AAR_PROXY_LIBRARY](#module_AAR_PROXY_LIBRARY) - Module [ASRC_LIBRARY](#module_ASRC_LIBRARY) - - Module [BOOSTTEST](#module_BOOSTTEST) + - Module [BOOSTTEST](#module_BOOSTTEST) - Module [BOOSTTEST_WITH_MAIN](#module_BOOSTTEST_WITH_MAIN) - Module [CI_GROUP](#module_CI_GROUP) - Module [CONTAINER](#module_CONTAINER) @@ -43,41 +43,41 @@ General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/Ho - Module [CPP_STYLE_TEST](#module_CPP_STYLE_TEST) - Module [CUSTOM_BUILD_LIBRARY](#module_CUSTOM_BUILD_LIBRARY) - Module [DEFAULT_IOS_INTERFACE](#module_DEFAULT_IOS_INTERFACE) - - Module [DEV_DLL_PROXY](#module_DEV_DLL_PROXY) - - Module [DLL](#module_DLL) + - Module [DEV_DLL_PROXY](#module_DEV_DLL_PROXY) + - Module [DLL](#module_DLL) - Module [DLL_PROXY](#module_DLL_PROXY) - Module [DLL_PROXY_LIBRARY](#module_DLL_PROXY_LIBRARY) - Module [DLL_TOOL](#module_DLL_TOOL) - - Module [DLL_UNIT](#module_DLL_UNIT) - - Module [EXECTEST](#module_EXECTEST) - - Module [EXTERNAL_JAVA_LIBRARY](#module_EXTERNAL_JAVA_LIBRARY) - - Module [FAT_OBJECT](#module_FAT_OBJECT) - - Module [FUZZ](#module_FUZZ) + - Module [DLL_UNIT](#module_DLL_UNIT) + - Module [EXECTEST](#module_EXECTEST) + - Module [EXTERNAL_JAVA_LIBRARY](#module_EXTERNAL_JAVA_LIBRARY) + - Module [FAT_OBJECT](#module_FAT_OBJECT) + - Module [FUZZ](#module_FUZZ) - Module [GO_DLL](#module_GO_DLL) - - Module [GO_LIBRARY](#module_GO_LIBRARY) - - Module [GO_PROGRAM](#module_GO_PROGRAM) - - Module [GO_TEST](#module_GO_TEST) - - Module [GTEST](#module_GTEST) + - Module [GO_LIBRARY](#module_GO_LIBRARY) + - Module [GO_PROGRAM](#module_GO_PROGRAM) + - Module [GO_TEST](#module_GO_TEST) + - Module [GTEST](#module_GTEST) - Module [GTEST_UGLY](#module_GTEST_UGLY) - Module [G_BENCHMARK](#module_G_BENCHMARK) - Module [IOS_INTERFACE](#module_IOS_INTERFACE) - Module [JAR_LIBRARY](#module_JAR_LIBRARY) - Module [JAVA_CONTRIB](#module_JAVA_CONTRIB) - Module [JAVA_CONTRIB_PROXY](#module_JAVA_CONTRIB_PROXY) - - Module [JAVA_LIBRARY](#module_JAVA_LIBRARY) + - Module [JAVA_LIBRARY](#module_JAVA_LIBRARY) - Module [JSRC_LIBRARY](#module_JSRC_LIBRARY) - Module [JSRC_PROXY_MOBILE_LIBRARY](#module_JSRC_PROXY_MOBILE_LIBRARY) - - Module [LIBRARY](#module_LIBRARY) + - Module [LIBRARY](#module_LIBRARY) - Module [MCU_PROGRAM](#module_MCU_PROGRAM) - - Module [METAQUERY](#module_METAQUERY) + - Module [METAQUERY](#module_METAQUERY) - Module [MOBILE_BOOST_TEST_APK](#module_MOBILE_BOOST_TEST_APK) - Module [MOBILE_DLL](#module_MOBILE_DLL) - Module [MOBILE_LIBRARY](#module_MOBILE_LIBRARY) - Module [MOBILE_TEST_APK](#module_MOBILE_TEST_APK) - Module [NPM_CONTRIBS](#module_NPM_CONTRIBS) - - Module [PACKAGE](#module_PACKAGE) + - Module [PACKAGE](#module_PACKAGE) - Module [PREBUILT_PROGRAM](#module_PREBUILT_PROGRAM) - - Module [PROGRAM](#module_PROGRAM) + - Module [PROGRAM](#module_PROGRAM) - Module [PROTO_DESCRIPTIONS](#module_PROTO_DESCRIPTIONS) - Module [PROTO_REGISTRY](#module_PROTO_REGISTRY) - Module [PY2MODULE](#module_PY2MODULE) @@ -85,61 +85,61 @@ General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/Ho - Module [PY2_LIBRARY](#module_PY2_LIBRARY) - Module [PY2_PROGRAM](#module_PY2_PROGRAM) - Module [PY3MODULE](#module_PY3MODULE) - - Module [PY3TEST_BIN](#module_PY3TEST_BIN) - - Module [PY3_LIBRARY](#module_PY3_LIBRARY) + - Module [PY3TEST_BIN](#module_PY3TEST_BIN) + - Module [PY3_LIBRARY](#module_PY3_LIBRARY) - Module [PY3_PROGRAM_BIN](#module_PY3_PROGRAM_BIN) - Module [PYCR_PROGRAM](#module_PYCR_PROGRAM) - Module [PYTEST_BIN](#module_PYTEST_BIN) - - Module [PY_ANY_MODULE](#module_PY_ANY_MODULE) - - Module [PY_PACKAGE](#module_PY_PACKAGE) + - Module [PY_ANY_MODULE](#module_PY_ANY_MODULE) + - Module [PY_PACKAGE](#module_PY_PACKAGE) - Module [RECURSIVE_LIBRARY](#module_RECURSIVE_LIBRARY) - - Module [RESOURCES_LIBRARY](#module_RESOURCES_LIBRARY) - - Module [R_MODULE](#module_R_MODULE) - - Module [SO_PROGRAM](#module_SO_PROGRAM) + - Module [RESOURCES_LIBRARY](#module_RESOURCES_LIBRARY) + - Module [R_MODULE](#module_R_MODULE) + - Module [SO_PROGRAM](#module_SO_PROGRAM) - Module [TS_LIBRARY](#module_TS_LIBRARY) - - Module [UDF](#module_UDF) - - Module [UDF_BASE](#module_UDF_BASE) - - Module [UDF_LIB](#module_UDF_LIB) - - Module [UNION](#module_UNION) - - Module [UNITTEST](#module_UNITTEST) - - Module [UNITTEST_FOR](#module_UNITTEST_FOR) - - Module [UNITTEST_WITH_CUSTOM_ENTRY_POINT](#module_UNITTEST_WITH_CUSTOM_ENTRY_POINT) - - Module [YCR_PROGRAM](#module_YCR_PROGRAM) - - Module [YQL_PYTHON3_UDF](#module_YQL_PYTHON3_UDF) + - Module [UDF](#module_UDF) + - Module [UDF_BASE](#module_UDF_BASE) + - Module [UDF_LIB](#module_UDF_LIB) + - Module [UNION](#module_UNION) + - Module [UNITTEST](#module_UNITTEST) + - Module [UNITTEST_FOR](#module_UNITTEST_FOR) + - Module [UNITTEST_WITH_CUSTOM_ENTRY_POINT](#module_UNITTEST_WITH_CUSTOM_ENTRY_POINT) + - Module [YCR_PROGRAM](#module_YCR_PROGRAM) + - Module [YQL_PYTHON3_UDF](#module_YQL_PYTHON3_UDF) - Module [YQL_PYTHON3_UDF_TEST](#module_YQL_PYTHON3_UDF_TEST) - - Module [YQL_PYTHON_UDF](#module_YQL_PYTHON_UDF) + - Module [YQL_PYTHON_UDF](#module_YQL_PYTHON_UDF) - Module [YQL_PYTHON_UDF_PROGRAM](#module_YQL_PYTHON_UDF_PROGRAM) - - Module [YQL_PYTHON_UDF_TEST](#module_YQL_PYTHON_UDF_TEST) - - Module [YQL_UDF_MODULE](#module_YQL_UDF_MODULE) - - Module [YQL_UDF_TEST](#module_YQL_UDF_TEST) - - Module [YT_UNITTEST](#module_YT_UNITTEST) + - Module [YQL_PYTHON_UDF_TEST](#module_YQL_PYTHON_UDF_TEST) + - Module [YQL_UDF_MODULE](#module_YQL_UDF_MODULE) + - Module [YQL_UDF_TEST](#module_YQL_UDF_TEST) + - Module [YT_UNITTEST](#module_YT_UNITTEST) - Module [Y_BENCHMARK](#module_Y_BENCHMARK) - Module [_BARE_UNIT](#module__BARE_UNIT) - - Module [_BASE_PROGRAM](#module__BASE_PROGRAM) - - Module [_BASE_PY3_PROGRAM](#module__BASE_PY3_PROGRAM) + - Module [_BASE_PROGRAM](#module__BASE_PROGRAM) + - Module [_BASE_PY3_PROGRAM](#module__BASE_PY3_PROGRAM) - Module [_BASE_PYTEST](#module__BASE_PYTEST) - Module [_BASE_PY_PROGRAM](#module__BASE_PY_PROGRAM) - - Module [_BASE_UNIT](#module__BASE_UNIT) - - Module [_BASE_UNITTEST](#module__BASE_UNITTEST) + - Module [_BASE_UNIT](#module__BASE_UNIT) + - Module [_BASE_UNITTEST](#module__BASE_UNITTEST) - Module [_COMPILABLE_JAR_BASE](#module__COMPILABLE_JAR_BASE) - Module [_DLL_COMPATIBLE_JAVA_LIBRARY](#module__DLL_COMPATIBLE_JAVA_LIBRARY) - - Module [_DLL_COMPATIBLE_LIBRARY](#module__DLL_COMPATIBLE_LIBRARY) + - Module [_DLL_COMPATIBLE_LIBRARY](#module__DLL_COMPATIBLE_LIBRARY) - Module [_DOCS_BASE_UNIT](#module__DOCS_BASE_UNIT) - - Module [_GO_BASE_UNIT](#module__GO_BASE_UNIT) + - Module [_GO_BASE_UNIT](#module__GO_BASE_UNIT) - Module [_GO_DLL_BASE_UNIT](#module__GO_DLL_BASE_UNIT) - Module [_JAR_BASE](#module__JAR_BASE) - Module [_JAR_RUNABLE](#module__JAR_RUNABLE) - Module [_JAR_TEST](#module__JAR_TEST) - - Module [_JAVA_PLACEHOLDER](#module__JAVA_PLACEHOLDER) - - Module [_LIBRARY](#module__LIBRARY) - - Module [_LINK_UNIT](#module__LINK_UNIT) + - Module [_JAVA_PLACEHOLDER](#module__JAVA_PLACEHOLDER) + - Module [_LIBRARY](#module__LIBRARY) + - Module [_LINK_UNIT](#module__LINK_UNIT) - Module [_PROXY_LIBRARY](#module__PROXY_LIBRARY) - Module [_PY2_PROGRAM](#module__PY2_PROGRAM) - Module [_PY3_LIBRARY](#module__PY3_LIBRARY) - Module [_PY_PACKAGE](#module__PY_PACKAGE) - Module [_TS_BASE_UNIT](#module__TS_BASE_UNIT) - Module [_YQL_UDF_PROGRAM_BASE](#module__YQL_UDF_PROGRAM_BASE) - * [Macros](#macros) + * [Macros](#macros) - Macros [AARS](#macro_AARS) .. [AAR_LOCAL_MAVEN_REPO](#macro_AAR_LOCAL_MAVEN_REPO) - Macros [AAR_MANIFEST](#macro_AAR_MANIFEST) .. [ADD_COMPILABLE_TRANSLATE](#macro_ADD_COMPILABLE_TRANSLATE) - Macros [ADD_COMPILABLE_TRANSLIT](#macro_ADD_COMPILABLE_TRANSLIT) .. [ANNOTATION_PROCESSOR](#macro_ANNOTATION_PROCESSOR) @@ -208,8 +208,8 @@ General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/Ho - Macros [_SRC____xs](#macro__SRC____xs) .. [_SRC_lua_21](#macro__SRC_lua_21) - Macros [_SRC_m](#macro__SRC_m) .. [_TS_CONFIGURE](#macro__TS_CONFIGURE) - Macros [_UNITTEST](#macro__UNITTEST) .. [_YTEST](#macro__YTEST) -## Multimodules <a name="multimodules"></a> - +## Multimodules <a name="multimodules"></a> + ###### Multimodule [DLL\_JAVA][]() <a name="multimodule_DLL_JAVA"></a> DLL built using swig for Java. Produces dynamic library and a .jar. Dynamic library is treated the same as in the case of PEERDIR from Java to DLL. @@ -217,16 +217,16 @@ Dynamic library is treated the same as in the case of PEERDIR from Java to DLL. Documentation: https://wiki.yandex-team.ru/yatool/java/#integracijascpp/pythonsborkojj -###### Multimodule [DOCS][]() <a name="multimodule_DOCS"></a> -Documentation project multimodule. - -When built directly, via RECURSE, DEPENDS or BUNDLE the output artifact is docs.tar.gz with statically generated site (using mkdocs as builder). -When PEERDIRed from other DOCS() module behaves like a UNION (supplying own content and dependencies to build target). -Peerdirs from modules other than DOCS are not accepted. +###### Multimodule [DOCS][]() <a name="multimodule_DOCS"></a> +Documentation project multimodule. + +When built directly, via RECURSE, DEPENDS or BUNDLE the output artifact is docs.tar.gz with statically generated site (using mkdocs as builder). +When PEERDIRed from other DOCS() module behaves like a UNION (supplying own content and dependencies to build target). +Peerdirs from modules other than DOCS are not accepted. Most usual macros are not accepted, only used with the macros DOCS\_DIR(), DOCS\_CONFIG(), DOCS\_VARS(), DOCS\_BUILDER(). - + @see: [DOCS\_DIR()](#macro\_DOCS\_DIR), [DOCS\_CONFIG()](#macro\_DOCS\_CONFIG), [DOCS\_VARS()](#macro\_DOCS\_VARS), [DOCS\_BUILDER()](#macro\_DOCS\_BUILDER). - + ###### Multimodule [DYNAMIC\_LIBRARY][]() _# internal_ <a name="multimodule_DYNAMIC_LIBRARY"></a> The use of this module is strictly prohibited except LGPL-related opensourcing This provides linkable DLL module which brings its results to programs and tests @@ -278,44 +278,44 @@ The particular variant is selected based on where PEERDIR to IDL\_LIBRARY comes Now supported 2 variants: C++, Java Java version is not really a library but an archive of generated Java sources -###### Multimodule [PROTO\_LIBRARY][]() <a name="multimodule_PROTO_LIBRARY"></a> -Build some varian of protocol buffers library. - -The particular variant is selected based on where PEERDIR to PROTO\_LIBRARY comes from. - -Now supported 5 variants: C++, Java, Python 2.x, Python 3.x and Go. -When PEERDIR comes from module for particular language appropriate variant is selected. -PROTO\_LIBRARY also supports emission of GRPC code if GRPC() macro is specified. -Notes: -- Python versions emit C++ code in addition to Python as optimization. -- In some PROTO\_LIBRARY-es Java or Python versions are excluded via EXCLUDE\_TAGS macros due to incompatibilities. -- Use from DEPENDS or BUNDLE is not allowed - -Documentation: https://wiki.yandex-team.ru/yatool/proto\_library/ - -See: [GRPC()](#macro\_GRPC), [OPTIMIZE\_PY\_PROTOS()](#macro\_OPTIMIZE\_PY\_PROTOS), [INCLUDE\_TAGS()](#macro\_INCLUDE\_TAGS), [EXCLUDE\_TAGS()](#macro\_EXCLUDE\_TAGS) - -###### Multimodule [PY23\_LIBRARY][]([name]) <a name="multimodule_PY23_LIBRARY"></a> +###### Multimodule [PROTO\_LIBRARY][]() <a name="multimodule_PROTO_LIBRARY"></a> +Build some varian of protocol buffers library. + +The particular variant is selected based on where PEERDIR to PROTO\_LIBRARY comes from. + +Now supported 5 variants: C++, Java, Python 2.x, Python 3.x and Go. +When PEERDIR comes from module for particular language appropriate variant is selected. +PROTO\_LIBRARY also supports emission of GRPC code if GRPC() macro is specified. +Notes: +- Python versions emit C++ code in addition to Python as optimization. +- In some PROTO\_LIBRARY-es Java or Python versions are excluded via EXCLUDE\_TAGS macros due to incompatibilities. +- Use from DEPENDS or BUNDLE is not allowed + +Documentation: https://wiki.yandex-team.ru/yatool/proto\_library/ + +See: [GRPC()](#macro\_GRPC), [OPTIMIZE\_PY\_PROTOS()](#macro\_OPTIMIZE\_PY\_PROTOS), [INCLUDE\_TAGS()](#macro\_INCLUDE\_TAGS), [EXCLUDE\_TAGS()](#macro\_EXCLUDE\_TAGS) + +###### Multimodule [PY23\_LIBRARY][]([name]) <a name="multimodule_PY23_LIBRARY"></a> Build PY2\_LIBRARY or PY3\_LIBRARY depending on incoming PEERDIR. -Direct build or build by RECURSE creates both variants. -This multimodule doesn't define any final targets, so use from DEPENDS or BUNDLE is not allowed. - -Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs - -###### Multimodule [PY23\_NATIVE\_LIBRARY][]([name]) <a name="multimodule_PY23_NATIVE_LIBRARY"></a> +Direct build or build by RECURSE creates both variants. +This multimodule doesn't define any final targets, so use from DEPENDS or BUNDLE is not allowed. + +Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs + +###### Multimodule [PY23\_NATIVE\_LIBRARY][]([name]) <a name="multimodule_PY23_NATIVE_LIBRARY"></a> Build LIBRARY compatible with either Python 2.x or Python 3.x depending on incoming PEERDIR. - + This multimodule doesn't depend on Arcadia Python binary build. It is intended only for C++ code and cannot contain PY\_SRCS and USE\_PYTHON2 macros. Use these multimodule instead of PY23\_LIBRARY if the C++ extension defined in it will be used in PY2MODULE. While it doesn't bring Arcadia Python dependency itself, it is still compatible with Arcadia Python build and can be PEERDIR-ed from PY2\_LIBRARY and alikes. -Proper version will be selected according to Python version of the module PEERDIR comes from. - -This mulrtimodule doesn't define any final targets so cannot be used from DEPENDS or BUNDLE macros. - -For more information read https://wiki.yandex-team.ru/arcadia/python/pysrcs/#pysrcssrcsipy23nativelibrary - +Proper version will be selected according to Python version of the module PEERDIR comes from. + +This mulrtimodule doesn't define any final targets so cannot be used from DEPENDS or BUNDLE macros. + +For more information read https://wiki.yandex-team.ru/arcadia/python/pysrcs/#pysrcssrcsipy23nativelibrary + @see [LIBRARY()](#module\_LIBRARY), [PY2MODULE()](#module\_PY2MODULE) - + ###### Multimodule [PY23\_TEST][] <a name="multimodule_PY23_TEST"></a> Not documented yet. @@ -350,31 +350,31 @@ and will select multimodule variants accordingly. Documentation: https://wiki.yandex-team.ru/sandbox/tasks/binary -###### Multimodule [SANDBOX\_TASK][]([Name]) <a name="multimodule_SANDBOX_TASK"></a> -Multimodule describing Sandbox task (Python code that can be executed by Sandbox system). - +###### Multimodule [SANDBOX\_TASK][]([Name]) <a name="multimodule_SANDBOX_TASK"></a> +Multimodule describing Sandbox task (Python code that can be executed by Sandbox system). + When being a final target, this multimodule builds Sandbox binary task. It may PEERDIR other SANDBOX\_TASKs as libraries. The final artifact is provided when SANDBOX\_TASK is referred to by DEPENDS and BUNDLE macros. As PEERDIR target, it works like regular PY2\_LIBRARY with predefined dependencies on Sandbox SDK to allow code reuse among SANDBOX\_TASKs. - + Currently Sandbox supports only Python 2.x, so both variants will be compatible only with Python 2.x modules and will select multimodule variants accordingly. - -Documentation: https://wiki.yandex-team.ru/sandbox/tasks/binary - + +Documentation: https://wiki.yandex-team.ru/sandbox/tasks/binary + ###### Multimodule [SSQLS\_LIBRARY][] <a name="multimodule_SSQLS_LIBRARY"></a> Not documented yet. -###### Multimodule [YQL\_UDF][](name) <a name="multimodule_YQL_UDF"></a> -User-defined function for YQL - -Multimodule which is YQL\_UDF\_MODULE when built directly or referred by BUNDLE and DEPENDS macros. -If used by PEERDIRs it is usual static LIBRARY with default YQL dependencies, allowing code reuse between UDFs. - -@see: [YQL\_UDF\_MODULE()](#module\_YQL\_UDF\_MODULE) - -## Modules <a name="modules"></a> - +###### Multimodule [YQL\_UDF][](name) <a name="multimodule_YQL_UDF"></a> +User-defined function for YQL + +Multimodule which is YQL\_UDF\_MODULE when built directly or referred by BUNDLE and DEPENDS macros. +If used by PEERDIRs it is usual static LIBRARY with default YQL dependencies, allowing code reuse between UDFs. + +@see: [YQL\_UDF\_MODULE()](#module\_YQL\_UDF\_MODULE) + +## Modules <a name="modules"></a> + ###### Module [AAR][]() _# internal_ <a name="module_AAR"></a> Not documented yet. @@ -384,11 +384,11 @@ The use of this module is strictly prohibited!!! ###### Module [ASRC\_LIBRARY][]() _# internal_ <a name="module_ASRC_LIBRARY"></a> Not documented yet. -###### Module [BOOSTTEST][]([name]) _#deprecated_ <a name="module_BOOSTTEST"></a> -Test module based on boost/test/unit\_test.hpp. -As with entire boost library usage of this technology is deprecated in Arcadia and restricted with configuration error in most of projects. -No new module of this type should be introduced unless it is explicitly approved by C++ committee. - +###### Module [BOOSTTEST][]([name]) _#deprecated_ <a name="module_BOOSTTEST"></a> +Test module based on boost/test/unit\_test.hpp. +As with entire boost library usage of this technology is deprecated in Arcadia and restricted with configuration error in most of projects. +No new module of this type should be introduced unless it is explicitly approved by C++ committee. + ###### Module [BOOSTTEST\_WITH\_MAIN][]([name]) _#deprecated_ <a name="module_BOOSTTEST_WITH_MAIN"></a> Same as BOOSTTEST (see above), but comes with builtin int main(argc, argv) implementation @@ -413,18 +413,18 @@ Not documented yet. ###### Module [DEFAULT\_IOS\_INTERFACE][]: IOS\_INTERFACE <a name="module_DEFAULT_IOS_INTERFACE"></a> Not documented yet. -###### Module [DEV\_DLL\_PROXY][]() _# internal_ <a name="module_DEV_DLL_PROXY"></a> -The use of this module is strictly prohibited!!! -This is a temporary and project-specific solution. - -###### Module [DLL][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_DLL"></a> -Dynamic library module defintion. -1. major\_ver and minor\_ver must be integers. -2. EXPORTS allows you to explicitly specify the list of exported functions. This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files -3. PREFIX allows you to change the prefix of the output file (default DLL has the prefix "lib"). - -DLL cannot participate in linking to programs but can be used from Java or as final artifact (packaged and deployed). - +###### Module [DEV\_DLL\_PROXY][]() _# internal_ <a name="module_DEV_DLL_PROXY"></a> +The use of this module is strictly prohibited!!! +This is a temporary and project-specific solution. + +###### Module [DLL][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_DLL"></a> +Dynamic library module defintion. +1. major\_ver and minor\_ver must be integers. +2. EXPORTS allows you to explicitly specify the list of exported functions. This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files +3. PREFIX allows you to change the prefix of the output file (default DLL has the prefix "lib"). + +DLL cannot participate in linking to programs but can be used from Java or as final artifact (packaged and deployed). + ###### Module [DLL\_PROXY][]() _# internal_ <a name="module_DLL_PROXY"></a> The use of this module is strictly prohibited!!! This is a temporary and project-specific solution. @@ -435,78 +435,78 @@ The use of this module is strictly prohibited!!! ###### Module [DLL\_TOOL][] <a name="module_DLL_TOOL"></a> DLL\_TOOL is a DLL that can be used as a LD\_PRELOAD tool. -###### Module [DLL\_UNIT][] _# internal_ <a name="module_DLL_UNIT"></a> -Base module for all dynamically linked libraries as final artifacts. -Contains all general logic for such kind of modules. Supports versioning and export files. -Cannot participate in linking to programs, intended to be used as final artifact (packaged and deployed). - -###### Module [EXECTEST][]() <a name="module_EXECTEST"></a> -Module definition of generic test that executes a binary. -Use macro RUN to specify binary to run. - -@example: - - EXECTEST() - OWNER(g:yatool) - - RUN( - cat input.txt - ) - DATA( - arcadia/devtools/ya/test/tests/exectest/data - ) - DEPENDS( - devtools/dummy_arcadia/cat - ) - TEST_CWD(devtools/ya/test/tests/exectest/data) - END() - -More examples: https://wiki.yandex-team.ru/yatool/test/#exec-testy - -@see: [RUN()](#macro\_RUN) - -###### Module [EXTERNAL\_JAVA\_LIBRARY][]() _#internal_ <a name="module_EXTERNAL_JAVA_LIBRARY"></a> -EXTERNAL\_JAVA\_LIBRARY() is a module for creating a .jar file using non-Java code (generators etc.) +###### Module [DLL\_UNIT][] _# internal_ <a name="module_DLL_UNIT"></a> +Base module for all dynamically linked libraries as final artifacts. +Contains all general logic for such kind of modules. Supports versioning and export files. +Cannot participate in linking to programs, intended to be used as final artifact (packaged and deployed). + +###### Module [EXECTEST][]() <a name="module_EXECTEST"></a> +Module definition of generic test that executes a binary. +Use macro RUN to specify binary to run. + +@example: + + EXECTEST() + OWNER(g:yatool) + + RUN( + cat input.txt + ) + DATA( + arcadia/devtools/ya/test/tests/exectest/data + ) + DEPENDS( + devtools/dummy_arcadia/cat + ) + TEST_CWD(devtools/ya/test/tests/exectest/data) + END() + +More examples: https://wiki.yandex-team.ru/yatool/test/#exec-testy + +@see: [RUN()](#macro\_RUN) + +###### Module [EXTERNAL\_JAVA\_LIBRARY][]() _#internal_ <a name="module_EXTERNAL_JAVA_LIBRARY"></a> +EXTERNAL\_JAVA\_LIBRARY() is a module for creating a .jar file using non-Java code (generators etc.) Unlike regular JAVA\_LIBRARY this module doesn't produce .pom file, so it cannot be exported to Maven itself. -PEERDIR it from JAVA\_LIBRARY or JAVA\_PROGRAM for export to Maven. - -###### Module [FAT\_OBJECT][]() <a name="module_FAT_OBJECT"></a> -The "fat" object module. It will contain all its transitive dependencies reachable by PEERDIRs: -static libraries, local (from own SRCS) and global (from peers') object files. - -Designed for use in XCode projects for iOS. - -###### Module [FUZZ][]() <a name="module_FUZZ"></a> -In order to start using Fuzzing in Arcadia, you need to create a FUZZ module with the implementation of the function LLVMFuzzerTestOneInput(). -This module should be reachable by RECURSE from /autocheck project in order for the corpus to be regularly updated. -AFL and Libfuzzer are supported in Arcadia via a single interface, but the automatic fuzzing still works only through Libfuzzer. - -Example: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/re2/re2/fuzzing/re2\_fuzzer.cc?rev=2919463#L58 - -Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ - +PEERDIR it from JAVA\_LIBRARY or JAVA\_PROGRAM for export to Maven. + +###### Module [FAT\_OBJECT][]() <a name="module_FAT_OBJECT"></a> +The "fat" object module. It will contain all its transitive dependencies reachable by PEERDIRs: +static libraries, local (from own SRCS) and global (from peers') object files. + +Designed for use in XCode projects for iOS. + +###### Module [FUZZ][]() <a name="module_FUZZ"></a> +In order to start using Fuzzing in Arcadia, you need to create a FUZZ module with the implementation of the function LLVMFuzzerTestOneInput(). +This module should be reachable by RECURSE from /autocheck project in order for the corpus to be regularly updated. +AFL and Libfuzzer are supported in Arcadia via a single interface, but the automatic fuzzing still works only through Libfuzzer. + +Example: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/re2/re2/fuzzing/re2\_fuzzer.cc?rev=2919463#L58 + +Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ + ###### Module [GO\_DLL][](name major\_ver [minor\_ver] [PREFIX prefix]) <a name="module_GO_DLL"></a> Go ishared object module definition. Compile and link Go module to a shared object. Will select Go implementation on PEERDIR to PROTO\_LIBRARY. -###### Module [GO\_LIBRARY][]([name]) <a name="module_GO_LIBRARY"></a> -Go library module definition. -Compile Go module as a library suitable for PEERDIR from other Go modules. -Will select Go implementation on PEERDIR to PROTO\_LIBRARY. - -###### Module [GO\_PROGRAM][]([name]) <a name="module_GO_PROGRAM"></a> -Go program module definition. -Compile and link Go module to an executable program. -Will select Go implementation on PEERDIR to PROTO\_LIBRARY. - -###### Module [GO\_TEST][]([name]) <a name="module_GO_TEST"></a> -Go test module definition. -Compile and link Go module as a test suitable for running with Arcadia testing support. -All usual testing support macros like DATA, DEPENDS, SIZE, REQUIREMENTS etc. are supported. -Will select Go implementation on PEERDIR to PROTO\_LIBRARY. - -###### Module [GTEST][]([name]) <a name="module_GTEST"></a> +###### Module [GO\_LIBRARY][]([name]) <a name="module_GO_LIBRARY"></a> +Go library module definition. +Compile Go module as a library suitable for PEERDIR from other Go modules. +Will select Go implementation on PEERDIR to PROTO\_LIBRARY. + +###### Module [GO\_PROGRAM][]([name]) <a name="module_GO_PROGRAM"></a> +Go program module definition. +Compile and link Go module to an executable program. +Will select Go implementation on PEERDIR to PROTO\_LIBRARY. + +###### Module [GO\_TEST][]([name]) <a name="module_GO_TEST"></a> +Go test module definition. +Compile and link Go module as a test suitable for running with Arcadia testing support. +All usual testing support macros like DATA, DEPENDS, SIZE, REQUIREMENTS etc. are supported. +Will select Go implementation on PEERDIR to PROTO\_LIBRARY. + +###### Module [GTEST][]([name]) <a name="module_GTEST"></a> Unit test module based on library/cpp/testing/gtest. It is recommended not to specify the name. @@ -515,11 +515,11 @@ Documentation: https://docs.yandex-team.ru/arcadia-cpp/cpp\_test ###### Module [GTEST\_UGLY][]([name]) <a name="module_GTEST_UGLY"></a> Deprecated, do not use in new projects. Use GTEST instead. -The test module based on gtest (contrib/libs/gtest contrib/libs/gmock). -Use public documentation on gtest for details. - -Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ - +The test module based on gtest (contrib/libs/gtest contrib/libs/gmock). +Use public documentation on gtest for details. + +Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ + ###### Module [G\_BENCHMARK][]([benchmarkname]) <a name="module_G_BENCHMARK"></a> Benchmark test based on the google benchmark. @@ -527,7 +527,7 @@ For more details see: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/be ###### Module [IOS\_INTERFACE][]() <a name="module_IOS_INTERFACE"></a> iOS GUI module definition - + ###### Module [JAR\_LIBRARY][]() _#internal_ <a name="module_JAR_LIBRARY"></a> Reimplementation of the JAVA\_LIBRARY with ymake.core.conf and ymake based dependency management @@ -537,38 +537,38 @@ Not documented yet. ###### Module [JAVA\_CONTRIB\_PROXY][]: \_JAR\_BASE <a name="module_JAVA_CONTRIB_PROXY"></a> Not documented yet. -###### Module [JAVA\_LIBRARY][]() <a name="module_JAVA_LIBRARY"></a> -The module describing java library build. - -Documentation: https://wiki.yandex-team.ru/yatool/java/ - +###### Module [JAVA\_LIBRARY][]() <a name="module_JAVA_LIBRARY"></a> +The module describing java library build. + +Documentation: https://wiki.yandex-team.ru/yatool/java/ + ###### Module [JSRC\_LIBRARY][]() _# internal_ <a name="module_JSRC_LIBRARY"></a> Not documented yet. ###### Module [JSRC\_PROXY\_MOBILE\_LIBRARY][]() _# internal_ <a name="module_JSRC_PROXY_MOBILE_LIBRARY"></a> Not documented yet. -###### Module [LIBRARY][]() <a name="module_LIBRARY"></a> -The regular static library module. - -The LIBRARY() is intermediate module, so when built directly it won't build its dependencies. -It transitively provides its PEERDIRs to ultimate final target, where all LIBRARY() modules are built and linked together. - -This is C++ library, and it selects peers from multimodules accordingly. - -It makes little sense to mention LIBRARY in DEPENDS or BUNDLE, package and deploy it since it is not a standalone entity. -In order to use library in tests PEERDIR it to link into tests. -If you think you need to distribute static library please contact devtools@ for assistance. - +###### Module [LIBRARY][]() <a name="module_LIBRARY"></a> +The regular static library module. + +The LIBRARY() is intermediate module, so when built directly it won't build its dependencies. +It transitively provides its PEERDIRs to ultimate final target, where all LIBRARY() modules are built and linked together. + +This is C++ library, and it selects peers from multimodules accordingly. + +It makes little sense to mention LIBRARY in DEPENDS or BUNDLE, package and deploy it since it is not a standalone entity. +In order to use library in tests PEERDIR it to link into tests. +If you think you need to distribute static library please contact devtools@ for assistance. + ###### Module [MCU\_PROGRAM][]([progname]) <a name="module_MCU_PROGRAM"></a> Program module for microcontrollers. Converts binary to Intel HEX and Motorola S-record file formats. If name is not specified it will be generated from the name of the containing project directory. -###### Module [METAQUERY][]() _#deprecated_ <a name="module_METAQUERY"></a> -Project Definition - KIWI Meta query. (Objected) - -https://wiki.yandex-team.ru/robot/manual/kiwi/techdoc/design/metaquery/ - +###### Module [METAQUERY][]() _#deprecated_ <a name="module_METAQUERY"></a> +Project Definition - KIWI Meta query. (Objected) + +https://wiki.yandex-team.ru/robot/manual/kiwi/techdoc/design/metaquery/ + ###### Module [MOBILE\_BOOST\_TEST\_APK][]() _# internal_ <a name="module_MOBILE_BOOST_TEST_APK"></a> Not documented yet. @@ -588,24 +588,24 @@ Should be used only with `NODE\_MODULES` macro. @see [FROM\_NPM\_LOCKFILES()](#macro\_FROM\_NPM\_LOCKFILES) @see [NODE\_MODULES()](#macro\_NODE\_MODULES) -###### Module [PACKAGE][](name) <a name="module_PACKAGE"></a> -Module collects what is described directly inside it, builds and collects all its transitively available PEERDIRs. -As a result, build directory of the project gets the structure of the accessible part of Arcadia, where the build result of each PEERDIR is placed to relevant Arcadia subpath. +###### Module [PACKAGE][](name) <a name="module_PACKAGE"></a> +Module collects what is described directly inside it, builds and collects all its transitively available PEERDIRs. +As a result, build directory of the project gets the structure of the accessible part of Arcadia, where the build result of each PEERDIR is placed to relevant Arcadia subpath. The data can be optionally packed if macro PACK() is used. - -Is only used together with the macros FILES(), PEERDIR(), COPY(), FROM\_SANDBOX(), RUN\_PROGRAM or BUNDLE(). Don't use SRCS inside a PACKAGE. - -Documentation: https://wiki.yandex-team.ru/yatool/large-data/ - + +Is only used together with the macros FILES(), PEERDIR(), COPY(), FROM\_SANDBOX(), RUN\_PROGRAM or BUNDLE(). Don't use SRCS inside a PACKAGE. + +Documentation: https://wiki.yandex-team.ru/yatool/large-data/ + @see: [PACK()](#macro\_PACK) ###### Module [PREBUILT\_PROGRAM][]([programname]) _# internal_ <a name="module_PREBUILT_PROGRAM"></a> Program module which uses a prebuilt prgram as its output. -###### Module [PROGRAM][]([progname]) <a name="module_PROGRAM"></a> -Regular program module. -If name is not specified it will be generated from the name of the containing project directory. - +###### Module [PROGRAM][]([progname]) <a name="module_PROGRAM"></a> +Regular program module. +If name is not specified it will be generated from the name of the containing project directory. + ###### Module [PROTO\_DESCRIPTIONS][]: \_BARE\_UNIT <a name="module_PROTO_DESCRIPTIONS"></a> Not documented yet. @@ -662,68 +662,68 @@ Do not PEERDIR PY3\_LIBRARY or PY23\_LIBRARY: this will link Python in and rende Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ -###### Module [PY3TEST\_BIN][]() _#deprecated_ <a name="module_PY3TEST_BIN"></a> -Same as PY3TEST. Don't use this, use PY3TEST instead. - -###### Module [PY3\_LIBRARY][]() <a name="module_PY3_LIBRARY"></a> +###### Module [PY3TEST\_BIN][]() _#deprecated_ <a name="module_PY3TEST_BIN"></a> +Same as PY3TEST. Don't use this, use PY3TEST instead. + +###### Module [PY3\_LIBRARY][]() <a name="module_PY3_LIBRARY"></a> Python 3.x binary library. Builds sources from PY\_SRCS to data suitable for PY2\_PROGRAM -Adds dependencies to Python 2.x runtime library from Arcadia. -This module is only compatible with PYTHON3-tagged modules and selects those from multimodules. -This module is only compatible with Arcadia Python build. - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ - +Adds dependencies to Python 2.x runtime library from Arcadia. +This module is only compatible with PYTHON3-tagged modules and selects those from multimodules. +This module is only compatible with Arcadia Python build. + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ + ###### Module [PY3\_PROGRAM\_BIN][]([progname]) <a name="module_PY3_PROGRAM_BIN"></a> Use instead of PY3\_PROGRAM only if ya.make with PY3\_PROGRAM() included in another ya.make In all other cases use PY3\_PROGRAM - + ###### Module [PYCR\_PROGRAM][]([progname]) <a name="module_PYCR_PROGRAM"></a> pycare-specific program module. Generates pycare configs in addition to producing the program. If name is not specified it will be generated from the name of the containing project directory. ###### Module [PYTEST\_BIN][]() _#deprecated_ <a name="module_PYTEST_BIN"></a> Same as PY2TEST. Don't use this, use PY2TEST instead. - -###### Module [PY\_ANY\_MODULE][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_PY_ANY_MODULE"></a> -The Python external module for any versio of Arcadia or system Python. -1. major\_ver and minor\_ver must be integers. -2. The resulting .so will have the prefix "lib". -3. Processing EXPORTS and PREFIX is the same as for DLL module -This is native DLL, so it will select C++ version from PROTO\_LIBRARY. - -Note: Use PYTHON2\_MODULE()/PYTHON3\_MODULE() in order to PEERDIR proper version of PY23\_NATIVE\_LIBRARY. -Do not PEERDIR any PY\*\_LIBRARY: this will link Python in and render artifact unusable as Python module. - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ - -###### Module [PY\_PACKAGE][](name) _# internal, deprecated_ <a name="module_PY_PACKAGE"></a> -This is module created via PY\_PROTOS\_FOR() macro - + +###### Module [PY\_ANY\_MODULE][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_PY_ANY_MODULE"></a> +The Python external module for any versio of Arcadia or system Python. +1. major\_ver and minor\_ver must be integers. +2. The resulting .so will have the prefix "lib". +3. Processing EXPORTS and PREFIX is the same as for DLL module +This is native DLL, so it will select C++ version from PROTO\_LIBRARY. + +Note: Use PYTHON2\_MODULE()/PYTHON3\_MODULE() in order to PEERDIR proper version of PY23\_NATIVE\_LIBRARY. +Do not PEERDIR any PY\*\_LIBRARY: this will link Python in and render artifact unusable as Python module. + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ + +###### Module [PY\_PACKAGE][](name) _# internal, deprecated_ <a name="module_PY_PACKAGE"></a> +This is module created via PY\_PROTOS\_FOR() macro + ###### Module [RECURSIVE\_LIBRARY][]() <a name="module_RECURSIVE_LIBRARY"></a> The recursive ("fat") library module. It will contain all its transitive dependencies reachable by PEERDIRs: from static libraries, local (from own SRCS) and global (from peers') object files. Designed for use in XCode projects for iOS. -###### Module [RESOURCES\_LIBRARY][]() <a name="module_RESOURCES_LIBRARY"></a> -Definition of a module that brings its content from external source (Sandbox) via DECLARE\_EXTERNAL\_RESOURCE macro. -This can participate in PEERDIRs of others as library but it cannot have own sources and PEERDIRs. - -@see: [DECLARE\_EXTERNAL\_RESOURCE()](#macro\_DECLARE\_EXTERNAL\_RESOURCE) - -###### Module [R\_MODULE][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_R_MODULE"></a> -The external module for R language. -1. major\_ver and minor\_ver must be integers. -2. The resulting .so will have the prefix "lib". -3. Processing EXPORTS and PREFIX is the same as for DLL module -This is native DLL, so it will select C++ version from PROTO\_LIBRARY. - -###### Module [SO\_PROGRAM][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_SO_PROGRAM"></a> -Executable dynamic library module defintion. -1. major\_ver and minor\_ver must be integers. -2. EXPORTS allows you to explicitly specify the list of exported functions. This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files -3. PREFIX allows you to change the prefix of the output file. - +###### Module [RESOURCES\_LIBRARY][]() <a name="module_RESOURCES_LIBRARY"></a> +Definition of a module that brings its content from external source (Sandbox) via DECLARE\_EXTERNAL\_RESOURCE macro. +This can participate in PEERDIRs of others as library but it cannot have own sources and PEERDIRs. + +@see: [DECLARE\_EXTERNAL\_RESOURCE()](#macro\_DECLARE\_EXTERNAL\_RESOURCE) + +###### Module [R\_MODULE][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_R_MODULE"></a> +The external module for R language. +1. major\_ver and minor\_ver must be integers. +2. The resulting .so will have the prefix "lib". +3. Processing EXPORTS and PREFIX is the same as for DLL module +This is native DLL, so it will select C++ version from PROTO\_LIBRARY. + +###### Module [SO\_PROGRAM][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_SO_PROGRAM"></a> +Executable dynamic library module defintion. +1. major\_ver and minor\_ver must be integers. +2. EXPORTS allows you to explicitly specify the list of exported functions. This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files +3. PREFIX allows you to change the prefix of the output file. + ###### Module [TS\_LIBRARY][]([name]) <a name="module_TS_LIBRARY"></a> The TypeScript/JavaScript library module, compiles TypeScript sources to JavaScript. Build results are JavaScript files, typings and source mappings (depending on local tsconfig.json settings). @@ -736,56 +736,56 @@ Build results are JavaScript files, typings and source mappings (depending on lo NODE_MODULES() END() -###### Module [UDF][](name [EXPORTS symlist\_file] [PREFIX prefix]) _# deprecated_ <a name="module_UDF"></a> -The KiWi UDF module. -Processing EXPORTS and PREFIX is the same as for DLL. - -https://wiki.yandex-team.ru/robot/manual/kiwi/userguide/#polzovatelskiefunkciiudftriggerykwcalc - -###### Module [UDF\_BASE][](name [EXPORTS symlist\_file] [PREFIX prefix]) _#internal_ <a name="module_UDF_BASE"></a> +###### Module [UDF][](name [EXPORTS symlist\_file] [PREFIX prefix]) _# deprecated_ <a name="module_UDF"></a> +The KiWi UDF module. +Processing EXPORTS and PREFIX is the same as for DLL. + +https://wiki.yandex-team.ru/robot/manual/kiwi/userguide/#polzovatelskiefunkciiudftriggerykwcalc + +###### Module [UDF\_BASE][](name [EXPORTS symlist\_file] [PREFIX prefix]) _#internal_ <a name="module_UDF_BASE"></a> The base logic of all UDF extension modules (User-Defined Functions). -Processing EXPORTS and PREFIX is the same as for DLL. - -https://wiki.yandex-team.ru/robot/manual/kiwi/userguide/#polzovatelskiefunkciiudftriggerykwcalc - -###### Module [UDF\_LIB][]([name]) _# deprecated_ <a name="module_UDF_LIB"></a> -The LIBRARY module for KiWi UDF, so has default PEERDIR to yweb/robot/kiwi/kwcalc/udflib. - -###### Module [UNION][](name) <a name="module_UNION"></a> -Collection of PEERDIR dependencies, files and artifacts. -UNION doesn't build its peers, just provides those to modules depending on it. -When specied in DEPENDS() macro the UNION is transitively closed, building all its peers and providing those by own paths (without adding this module path like PACKAGE does). - -Is only used together with the macros like FILES(), PEERDIR(), COPY(), FROM\_SANDBOX(), RUN\_PROGRAM or BUNDLE(). Don't use SRCS inside a UNION. - -Documentation: https://wiki.yandex-team.ru/yatool/large-data/ - -###### Module [UNITTEST][]([name]) <a name="module_UNITTEST"></a> +Processing EXPORTS and PREFIX is the same as for DLL. + +https://wiki.yandex-team.ru/robot/manual/kiwi/userguide/#polzovatelskiefunkciiudftriggerykwcalc + +###### Module [UDF\_LIB][]([name]) _# deprecated_ <a name="module_UDF_LIB"></a> +The LIBRARY module for KiWi UDF, so has default PEERDIR to yweb/robot/kiwi/kwcalc/udflib. + +###### Module [UNION][](name) <a name="module_UNION"></a> +Collection of PEERDIR dependencies, files and artifacts. +UNION doesn't build its peers, just provides those to modules depending on it. +When specied in DEPENDS() macro the UNION is transitively closed, building all its peers and providing those by own paths (without adding this module path like PACKAGE does). + +Is only used together with the macros like FILES(), PEERDIR(), COPY(), FROM\_SANDBOX(), RUN\_PROGRAM or BUNDLE(). Don't use SRCS inside a UNION. + +Documentation: https://wiki.yandex-team.ru/yatool/large-data/ + +###### Module [UNITTEST][]([name]) <a name="module_UNITTEST"></a> Unit test module based on library/cpp/testing/unittest. -It is recommended not to specify the name. - -Documentation: https://wiki.yandex-team.ru/yatool/test/#opisanievya.make1 - -###### Module [UNITTEST\_FOR][](path/to/lib) <a name="module_UNITTEST_FOR"></a> -Convenience extension of UNITTEST module. -The UNINTTEST module with additional SRCDIR + ADDINCL + PEERDIR on path/to/lib. -path/to/lib is the path to the directory with the LIBRARY project. - -Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ - -###### Module [UNITTEST\_WITH\_CUSTOM\_ENTRY\_POINT][]([name]) <a name="module_UNITTEST_WITH_CUSTOM_ENTRY_POINT"></a> -Generic unit test module. - -###### Module [YCR\_PROGRAM][]([progname]) <a name="module_YCR_PROGRAM"></a> -yacare-specific program module. Generates yacare configs in addition to producing the program. -If name is not specified it will be generated from the name of the containing project directory. - -###### Module [YQL\_PYTHON3\_UDF][](name) <a name="module_YQL_PYTHON3_UDF"></a> -The extension module for YQL with Python 3.x UDF (User Defined Function for YQL). -Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. - -Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ - +It is recommended not to specify the name. + +Documentation: https://wiki.yandex-team.ru/yatool/test/#opisanievya.make1 + +###### Module [UNITTEST\_FOR][](path/to/lib) <a name="module_UNITTEST_FOR"></a> +Convenience extension of UNITTEST module. +The UNINTTEST module with additional SRCDIR + ADDINCL + PEERDIR on path/to/lib. +path/to/lib is the path to the directory with the LIBRARY project. + +Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ + +###### Module [UNITTEST\_WITH\_CUSTOM\_ENTRY\_POINT][]([name]) <a name="module_UNITTEST_WITH_CUSTOM_ENTRY_POINT"></a> +Generic unit test module. + +###### Module [YCR\_PROGRAM][]([progname]) <a name="module_YCR_PROGRAM"></a> +yacare-specific program module. Generates yacare configs in addition to producing the program. +If name is not specified it will be generated from the name of the containing project directory. + +###### Module [YQL\_PYTHON3\_UDF][](name) <a name="module_YQL_PYTHON3_UDF"></a> +The extension module for YQL with Python 3.x UDF (User Defined Function for YQL). +Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. + +Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ + ###### Module [YQL\_PYTHON3\_UDF\_TEST][](name) <a name="module_YQL_PYTHON3_UDF_TEST"></a> The Python test for Python 3.x YQL UDF (User Defined Function for YQL). The code should be a proper YQL\_PYTHON3\_UDF. @@ -795,43 +795,43 @@ Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ @see: [YQL\_PYTHON3\_UDF()](#module\_YQL\_PYTHON3\_UDF) -###### Module [YQL\_PYTHON\_UDF][](name) <a name="module_YQL_PYTHON_UDF"></a> -Definition of the extension module for YQL with Python 2.x UDF (User Defined Function for YQL). -Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. - -https://yql.yandex-team.ru/docs/yt/udf/python/ - +###### Module [YQL\_PYTHON\_UDF][](name) <a name="module_YQL_PYTHON_UDF"></a> +Definition of the extension module for YQL with Python 2.x UDF (User Defined Function for YQL). +Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. + +https://yql.yandex-team.ru/docs/yt/udf/python/ + ###### Module [YQL\_PYTHON\_UDF\_PROGRAM][](name) <a name="module_YQL_PYTHON_UDF_PROGRAM"></a> Definition of the extension module for YQL with Python 2.x UDF (User Defined Function for YQL). Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. https://yql.yandex-team.ru/docs/yt/udf/python/ -###### Module [YQL\_PYTHON\_UDF\_TEST][](name) <a name="module_YQL_PYTHON_UDF_TEST"></a> -The Python test for Python YQL UDF (Python User Defined Function for YQL). The code should be a proper YQL\_PYTHON\_UDF. - -This module will basically build itself as UDF and run as test using yql/tools/run\_python\_udf/run\_python\_udf tool. - -Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ - -@example: https://a.yandex-team.ru/arc/trunk/arcadia/yql/udfs/test/simple/ya.make - -@see: [YQL\_PYTHON\_UDF()](#module\_YQL\_PYTHON\_UDF) - -###### Module [YQL\_UDF\_MODULE][](name) <a name="module_YQL_UDF_MODULE"></a> -The extension module for YQL with C++ UDF (User Defined Function YQL) - -https://yql.yandex-team.ru/docs/yt/udf/cpp/ - -###### Module [YQL\_UDF\_TEST][]([name]) <a name="module_YQL_UDF_TEST"></a> -The module to test YQL C++ UDF. - -Documentation: https://yql.yandex-team.ru/docs/yt/libraries/testing/ -Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ - -###### Module [YT\_UNITTEST][]([name]) <a name="module_YT_UNITTEST"></a> -YT Unit test module based on mapreduce/yt/library/utlib - +###### Module [YQL\_PYTHON\_UDF\_TEST][](name) <a name="module_YQL_PYTHON_UDF_TEST"></a> +The Python test for Python YQL UDF (Python User Defined Function for YQL). The code should be a proper YQL\_PYTHON\_UDF. + +This module will basically build itself as UDF and run as test using yql/tools/run\_python\_udf/run\_python\_udf tool. + +Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ + +@example: https://a.yandex-team.ru/arc/trunk/arcadia/yql/udfs/test/simple/ya.make + +@see: [YQL\_PYTHON\_UDF()](#module\_YQL\_PYTHON\_UDF) + +###### Module [YQL\_UDF\_MODULE][](name) <a name="module_YQL_UDF_MODULE"></a> +The extension module for YQL with C++ UDF (User Defined Function YQL) + +https://yql.yandex-team.ru/docs/yt/udf/cpp/ + +###### Module [YQL\_UDF\_TEST][]([name]) <a name="module_YQL_UDF_TEST"></a> +The module to test YQL C++ UDF. + +Documentation: https://yql.yandex-team.ru/docs/yt/libraries/testing/ +Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ + +###### Module [YT\_UNITTEST][]([name]) <a name="module_YT_UNITTEST"></a> +YT Unit test module based on mapreduce/yt/library/utlib + ###### Module [Y\_BENCHMARK][]([benchmarkname]) <a name="module_Y_BENCHMARK"></a> Benchmark test based on the library/cpp/testing/benchmark. @@ -841,53 +841,53 @@ For more details see: https://wiki.yandex-team.ru/yatool/test/#zapuskbenchmark The base of all modules describing default bare minimum for all modules. To avoid surprises, all buildable modules are better to be inherited from it or its descendants. -###### Module [\_BASE\_PROGRAM][] _# internal_ <a name="module__BASE_PROGRAM"></a> -The base of all programs. It adds dependencies to make final artefact complete and runnable. - -###### Module \_BASE\_PY\_PROGRAM _#internal_ <a name="module__BASE_PY3_PROGRAM"></a> -The base module for all Python 3.x binary programs. Adds linking logic, relevant module properties and -dependency on Python 3.x interpreter. Also adds import tests on all sources including libraries. -Links all Python 3.x libraries and Python 3.x interpreter into itself to form regular executable. -This only compatible with PYTHON3-tagged modules and selects those from multimodules - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ - +###### Module [\_BASE\_PROGRAM][] _# internal_ <a name="module__BASE_PROGRAM"></a> +The base of all programs. It adds dependencies to make final artefact complete and runnable. + +###### Module \_BASE\_PY\_PROGRAM _#internal_ <a name="module__BASE_PY3_PROGRAM"></a> +The base module for all Python 3.x binary programs. Adds linking logic, relevant module properties and +dependency on Python 3.x interpreter. Also adds import tests on all sources including libraries. +Links all Python 3.x libraries and Python 3.x interpreter into itself to form regular executable. +This only compatible with PYTHON3-tagged modules and selects those from multimodules + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ + ###### Module [\_BASE\_PYTEST][] _# internal_ <a name="module__BASE_PYTEST"></a> -Base logic of Python 2.x py.test modules: common module properties and dependencies. - +Base logic of Python 2.x py.test modules: common module properties and dependencies. + ###### Module [\_BASE\_PY\_PROGRAM][] _#internal_ <a name="module__BASE_PY_PROGRAM"></a> -The base module for all Python 2.x binary programs. Adds linking logic, relevant module properties and -dependency on Python 2.x interpreter. Also adds import tests on all sources including PEERDIR'ed libraries. -Links all Python 2.x libraries and Python 2.x interpreter into itself to form regular executable. -This only compatible with PYTHON2-tagged modules and selects those from multimodules. - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ - -###### Module [\_BASE\_UNIT][] _# internal_ <a name="module__BASE_UNIT"></a> +The base module for all Python 2.x binary programs. Adds linking logic, relevant module properties and +dependency on Python 2.x interpreter. Also adds import tests on all sources including PEERDIR'ed libraries. +Links all Python 2.x libraries and Python 2.x interpreter into itself to form regular executable. +This only compatible with PYTHON2-tagged modules and selects those from multimodules. + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ + +###### Module [\_BASE\_UNIT][] _# internal_ <a name="module__BASE_UNIT"></a> The base of all LIBRARY/PROGRAM modules describing common logic for all modules. -To avoid surprises, all buildable modules are better to be inherited from it or its descendants. - -###### Module [\_BASE\_UNITTEST][] _# internal_ <a name="module__BASE_UNITTEST"></a> -Module with base logic for all unit-test modules: it makes code runnable as unit-test by Arcadia testing machinery. - +To avoid surprises, all buildable modules are better to be inherited from it or its descendants. + +###### Module [\_BASE\_UNITTEST][] _# internal_ <a name="module__BASE_UNITTEST"></a> +Module with base logic for all unit-test modules: it makes code runnable as unit-test by Arcadia testing machinery. + ###### Module [\_COMPILABLE\_JAR\_BASE][] : \_JAR\_BASE _#internal_ <a name="module__COMPILABLE_JAR_BASE"></a> Not documented yet. ###### Module [\_DLL\_COMPATIBLE\_JAVA\_LIBRARY][]: EXTERNAL\_JAVA\_LIBRARY _#internal_ <a name="module__DLL_COMPATIBLE_JAVA_LIBRARY"></a> Not documented yet. -###### Module [\_DLL\_COMPATIBLE\_LIBRARY][] _# internal_ <a name="module__DLL_COMPATIBLE_LIBRARY"></a> -Base module to place DLLs into multimodules back to back with libraries. -In order to function properly all modules in multimodule shall have the -same set of arguments. So this module is just library that accepts but -ignores all DLL arguments. - +###### Module [\_DLL\_COMPATIBLE\_LIBRARY][] _# internal_ <a name="module__DLL_COMPATIBLE_LIBRARY"></a> +Base module to place DLLs into multimodules back to back with libraries. +In order to function properly all modules in multimodule shall have the +same set of arguments. So this module is just library that accepts but +ignores all DLL arguments. + ###### Module [\_DOCS\_BASE\_UNIT][] _#internal_ <a name="module__DOCS_BASE_UNIT"></a> FIXME(snermolaev) -###### Module [\_GO\_BASE\_UNIT][] _# internal_ <a name="module__GO_BASE_UNIT"></a> +###### Module [\_GO\_BASE\_UNIT][] _# internal_ <a name="module__GO_BASE_UNIT"></a> The base module of all golang modules. Defines common properties, dependencies and rules for go build. - + ###### Module [\_GO\_DLL\_BASE\_UNIT][]: GO\_PROGRAM _#internal_ <a name="module__GO_DLL_BASE_UNIT"></a> Not documented yet. @@ -900,17 +900,17 @@ Not documented yet. ###### Module [\_JAR\_TEST][]: \_COMPILABLE\_JAR\_BASE _#internal_ <a name="module__JAR_TEST"></a> Not documented yet. -###### Module [\_JAVA\_PLACEHOLDER][] _#internal_ <a name="module__JAVA_PLACEHOLDER"></a> -The base module for all Java modules. Defines common properties and dependencies. - -###### Module [\_LIBRARY][] _# internal_ <a name="module__LIBRARY"></a> -Base module definition for all libraries. -Contains basic logic like module properties, default variable values etc. -All libraries similar to C++-libraries should be inherited from it. - -###### Module [\_LINK\_UNIT][] _# internal_ <a name="module__LINK_UNIT"></a> -The base of all linkable modules: programs, DLLs etc. Describes common linking logic. - +###### Module [\_JAVA\_PLACEHOLDER][] _#internal_ <a name="module__JAVA_PLACEHOLDER"></a> +The base module for all Java modules. Defines common properties and dependencies. + +###### Module [\_LIBRARY][] _# internal_ <a name="module__LIBRARY"></a> +Base module definition for all libraries. +Contains basic logic like module properties, default variable values etc. +All libraries similar to C++-libraries should be inherited from it. + +###### Module [\_LINK\_UNIT][] _# internal_ <a name="module__LINK_UNIT"></a> +The base of all linkable modules: programs, DLLs etc. Describes common linking logic. + ###### Module [\_PROXY\_LIBRARY][]() _# internal_ <a name="module__PROXY_LIBRARY"></a> The use of this module is strictly prohibited!!! @@ -929,8 +929,8 @@ Not documented yet. ###### Module [\_YQL\_UDF\_PROGRAM\_BASE][]: SO\_PROGRAM _#internal_ <a name="module__YQL_UDF_PROGRAM_BASE"></a> Not documented yet. -## Macros <a name="macros"></a> - +## Macros <a name="macros"></a> + ###### Macro [AARS][](Aars...) <a name="macro_AARS"></a> This macro is strictly prohibited to use outside of mapsmobi project @@ -971,73 +971,73 @@ Not documented yet. Not documented yet. ###### Macro [ACCELEO][](XSD{input}[], MTL{input}[], MTL\_ROOT="${MODDIR}", LANG{input}[], OUT{output}[], OUT\_NOAUTO{output}[], OUTPUT\_INCLUDES[], DEBUG?"stdout2stderr":"stderr2stdout") <a name="macro_ACCELEO"></a> -Not documented yet. - +Not documented yet. + ###### Macro [ADDINCL][]([FOR <lang>][GLOBAL dir]\* dirlist) _# builtin_ <a name="macro_ADDINCL"></a> The macro adds the directories to include/import search path to compilation flags of the current project. By default settings apply to C/C++ compilation namely sets -I<library path> flag, use FOR argument to change target command. -@params: +@params: `FOR <lang>` - adds inclues/import serach path for othe language. E.g. `FOR proto` adds import search path for .proto files processing. `GLOBAL` - extends the search for headers (-I) on the dependent projects. - + ###### Macro [ADDINCLSELF][]() <a name="macro_ADDINCLSELF"></a> The macro adds the -I<project source path> flag to the source compilation flags of the current project. - -###### Macro [ADD\_CHECK][] <a name="macro_ADD_CHECK"></a> -Not documented yet. - -###### Macro [ADD\_CHECK\_PY\_IMPORTS][] <a name="macro_ADD_CHECK_PY_IMPORTS"></a> -Not documented yet. - + +###### Macro [ADD\_CHECK][] <a name="macro_ADD_CHECK"></a> +Not documented yet. + +###### Macro [ADD\_CHECK\_PY\_IMPORTS][] <a name="macro_ADD_CHECK_PY_IMPORTS"></a> +Not documented yet. + ###### Macro [ADD\_CLANG\_TIDY][]() <a name="macro_ADD_CLANG_TIDY"></a> Not documented yet. -###### Macro [ADD\_COMPILABLE\_TRANSLATE][](Dict Name Options...) <a name="macro_ADD_COMPILABLE_TRANSLATE"></a> -Generate translation dictionary code to transdict.LOWER(Name).cpp that will than be compiled into library - -###### Macro [ADD\_COMPILABLE\_TRANSLIT][](TranslitTable NGrams Name Options...) <a name="macro_ADD_COMPILABLE_TRANSLIT"></a> -Generate transliteration dictionary code -This will emit both translit, untranslit and ngrams table codes those will be than further compiled into library - -###### Macro [ADD\_DLLS\_TO\_JAR][]() <a name="macro_ADD_DLLS_TO_JAR"></a> -Not documented yet. - -###### Macro [ADD\_PERL\_MODULE][](Dir ModuleName) <a name="macro_ADD_PERL_MODULE"></a> -Add dependency on specified Perl module to the library - +###### Macro [ADD\_COMPILABLE\_TRANSLATE][](Dict Name Options...) <a name="macro_ADD_COMPILABLE_TRANSLATE"></a> +Generate translation dictionary code to transdict.LOWER(Name).cpp that will than be compiled into library + +###### Macro [ADD\_COMPILABLE\_TRANSLIT][](TranslitTable NGrams Name Options...) <a name="macro_ADD_COMPILABLE_TRANSLIT"></a> +Generate transliteration dictionary code +This will emit both translit, untranslit and ngrams table codes those will be than further compiled into library + +###### Macro [ADD\_DLLS\_TO\_JAR][]() <a name="macro_ADD_DLLS_TO_JAR"></a> +Not documented yet. + +###### Macro [ADD\_PERL\_MODULE][](Dir ModuleName) <a name="macro_ADD_PERL_MODULE"></a> +Add dependency on specified Perl module to the library + ###### Macro [ADD\_PYTEST\_BIN][] <a name="macro_ADD_PYTEST_BIN"></a> -Not documented yet. - +Not documented yet. + ###### Macro [ADD\_PYTEST\_SCRIPT][] <a name="macro_ADD_PYTEST_SCRIPT"></a> -Not documented yet. - -###### Macro [ADD\_YTEST][] <a name="macro_ADD_YTEST"></a> -Not documented yet. - -###### Macro [ALLOCATOR][](Alloc) _# Default: LF_ <a name="macro_ALLOCATOR"></a> -Set memory allocator implementation for the PROGRAM()/DLL() module. -This may only be specified for programs and dlls, use in other modules leads to configuration errors. - +Not documented yet. + +###### Macro [ADD\_YTEST][] <a name="macro_ADD_YTEST"></a> +Not documented yet. + +###### Macro [ALLOCATOR][](Alloc) _# Default: LF_ <a name="macro_ALLOCATOR"></a> +Set memory allocator implementation for the PROGRAM()/DLL() module. +This may only be specified for programs and dlls, use in other modules leads to configuration errors. + Available allocators are: "LF", "LF\_YT", "LF\_DBG", "YT", "J", "B", "BM", "C", "TCMALLOC", "GOOGLE", "LOCKLESS", "SYSTEM", "FAKE", "MIM", "HU". - LF - lfalloc (https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/lfalloc) - LF\_YT - Allocator selection for YT (https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/lfalloc/yt/ya.make) - LF\_DBG - Debug allocator selection (https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/lfalloc/dbg/ya.make) - YT - The YTAlloc allocator (https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/ytalloc/impl/ya.make) - - J - The JEMalloc allocator (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/jemalloc) - - B - The balloc allocator named Pyotr Popov and Anton Samokhvalov - - Discussion: https://ironpeter.at.yandex-team.ru/replies.xml?item\_no=126 + - J - The JEMalloc allocator (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/jemalloc) + - B - The balloc allocator named Pyotr Popov and Anton Samokhvalov + - Discussion: https://ironpeter.at.yandex-team.ru/replies.xml?item\_no=126 - Code: https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/balloc - BM - The balloc for market (agri@ commits from july 2018 till November 2018 saved) - - C - Like B, but can be disabled for each thread to LF or SYSTEM one (B can be disabled only to SYSTEM) + - C - Like B, but can be disabled for each thread to LF or SYSTEM one (B can be disabled only to SYSTEM) - MIM - Microsoft's mimalloc (actual version) (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/mimalloc) - TCMALLOC - Google TCMalloc (actual version) (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/tcmalloc) - - GOOGLE - Google TCMalloc (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/galloc) - - LOCKLESS - Allocator based upon lockless queues (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/lockless) - - SYSTEM - Use target system allocator - - FAKE - Don't link with any allocator - -More about allocators in Arcadia: https://wiki.yandex-team.ru/arcadia/allocators/ - + - GOOGLE - Google TCMalloc (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/galloc) + - LOCKLESS - Allocator based upon lockless queues (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/lockless) + - SYSTEM - Use target system allocator + - FAKE - Don't link with any allocator + +More about allocators in Arcadia: https://wiki.yandex-team.ru/arcadia/allocators/ + ###### Macro [ALL\_PY\_SRCS][]([RECURSIVE] { | TOP\_LEVEL | NAMESPACE ns} [Dirs...]) <a name="macro_ALL_PY_SRCS"></a> Puts all .py-files from given Dirs (relative to projects') into PY\_SRCS of the current module. If Dirs is ommitted project directory is used @@ -1050,49 +1050,49 @@ Note: Macro is designed to reject any ya.make files in Dirs except current one @see [PY\_SRCS()](#macro\_PY\_SRCS) -###### Macro [ALL\_SRCS][]([GLOBAL] filenames...) <a name="macro_ALL_SRCS"></a> -Make all source files listed as GLOBAL or not depending on the keyword GLOBAL -Call to ALL\_SRCS macro is equivalent to call to GLOBAL\_SRCS macro when GLOBAL keyword is specified -as the first argument and is equivalent to call to SRCS macro otherwise. - -@example: - - LIBRARY() - SET(MAKE_IT_GLOBAL GLOBAL) - ALL_SRCS(${MAKE_IT_GLOBAL} foo.cpp bar.cpp) - END() - -@see: [GLOBAL\_SRCS()](#macro\_GLOBAL\_SRCS), [SRCS()](#macro\_SRCS) - -###### Macro [ANNOTATION\_PROCESSOR][](processors...) <a name="macro_ANNOTATION_PROCESSOR"></a> -The macro is in development. -Used to specify annotation processors to build JAVA\_PROGRAM() and JAVA\_LIBRARY(). - -###### Macro [ARCHIVE][](archive\_name [DONT\_COMPRESS] files...) <a name="macro_ARCHIVE"></a> -Add arbitrary data to a modules. Unlike RESOURCE macro the result should be futher processed by othet macros in the module. - -Example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a1ispolzujjtekomanduarchive - -###### Macro [ARCHIVE\_ASM][](NAME archive\_name files...) <a name="macro_ARCHIVE_ASM"></a> -Similar to the macro ARCHIVE, but: -1. works faster and it is better to use for large files. -2. Different syntax (see examples in codesearch or users/pg/tests/archive\_test) - -###### Macro [ARCHIVE\_BY\_KEYS][](archive\_name key [DONT\_COMPRESS] files...) <a name="macro_ARCHIVE_BY_KEYS"></a> -Add arbitrary data to a module be accessible by specified key. -Unlike RESOURCE macro the result should be futher processed by othet macros in the module. - -Example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a1ispolzujjtekomanduarchive - -###### Macro [ASM\_PREINCLUDE][](AsmFiles...) <a name="macro_ASM_PREINCLUDE"></a> -Supply additional .asm files to all assembler calls within a module - +###### Macro [ALL\_SRCS][]([GLOBAL] filenames...) <a name="macro_ALL_SRCS"></a> +Make all source files listed as GLOBAL or not depending on the keyword GLOBAL +Call to ALL\_SRCS macro is equivalent to call to GLOBAL\_SRCS macro when GLOBAL keyword is specified +as the first argument and is equivalent to call to SRCS macro otherwise. + +@example: + + LIBRARY() + SET(MAKE_IT_GLOBAL GLOBAL) + ALL_SRCS(${MAKE_IT_GLOBAL} foo.cpp bar.cpp) + END() + +@see: [GLOBAL\_SRCS()](#macro\_GLOBAL\_SRCS), [SRCS()](#macro\_SRCS) + +###### Macro [ANNOTATION\_PROCESSOR][](processors...) <a name="macro_ANNOTATION_PROCESSOR"></a> +The macro is in development. +Used to specify annotation processors to build JAVA\_PROGRAM() and JAVA\_LIBRARY(). + +###### Macro [ARCHIVE][](archive\_name [DONT\_COMPRESS] files...) <a name="macro_ARCHIVE"></a> +Add arbitrary data to a modules. Unlike RESOURCE macro the result should be futher processed by othet macros in the module. + +Example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a1ispolzujjtekomanduarchive + +###### Macro [ARCHIVE\_ASM][](NAME archive\_name files...) <a name="macro_ARCHIVE_ASM"></a> +Similar to the macro ARCHIVE, but: +1. works faster and it is better to use for large files. +2. Different syntax (see examples in codesearch or users/pg/tests/archive\_test) + +###### Macro [ARCHIVE\_BY\_KEYS][](archive\_name key [DONT\_COMPRESS] files...) <a name="macro_ARCHIVE_BY_KEYS"></a> +Add arbitrary data to a module be accessible by specified key. +Unlike RESOURCE macro the result should be futher processed by othet macros in the module. + +Example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a1ispolzujjtekomanduarchive + +###### Macro [ASM\_PREINCLUDE][](AsmFiles...) <a name="macro_ASM_PREINCLUDE"></a> +Supply additional .asm files to all assembler calls within a module + ###### Macro [ASSERT][] <a name="macro_ASSERT"></a> Not documented yet. -###### Macro [BASE\_CODEGEN][](tool\_path prefix) <a name="macro_BASE_CODEGEN"></a> -Generator ${prefix}.cpp + ${prefix}.h files based on ${prefix}.in. - +###### Macro [BASE\_CODEGEN][](tool\_path prefix) <a name="macro_BASE_CODEGEN"></a> +Generator ${prefix}.cpp + ${prefix}.h files based on ${prefix}.in. + ###### Macro [BPF][](Input Output Opts...) <a name="macro_BPF"></a> Emit eBPF bytecode from .c file. Note: Output name is used as is, no extension added. @@ -1101,36 +1101,36 @@ Note: Output name is used as is, no extension added. Emit eBPF bytecode from .c file. Note: Output name is used as is, no extension added. -###### Macro [BUILDWITH\_CYTHON\_C][](Src Options...) <a name="macro_BUILDWITH_CYTHON_C"></a> -Generates .c file from .pyx. - -###### Macro [BUILDWITH\_CYTHON\_CPP][](Src Options...) <a name="macro_BUILDWITH_CYTHON_CPP"></a> -Generates .cpp file from .pyx. - -###### Macro [BUILDWITH\_RAGEL6][](Src Options...) <a name="macro_BUILDWITH_RAGEL6"></a> -Compile .rl file using Ragel6. - +###### Macro [BUILDWITH\_CYTHON\_C][](Src Options...) <a name="macro_BUILDWITH_CYTHON_C"></a> +Generates .c file from .pyx. + +###### Macro [BUILDWITH\_CYTHON\_CPP][](Src Options...) <a name="macro_BUILDWITH_CYTHON_CPP"></a> +Generates .cpp file from .pyx. + +###### Macro [BUILDWITH\_RAGEL6][](Src Options...) <a name="macro_BUILDWITH_RAGEL6"></a> +Compile .rl file using Ragel6. + ###### Macro [BUILD\_CATBOOST][](cbmodel cbname) <a name="macro_BUILD_CATBOOST"></a> -Generate catboost model and access code. -cbmodel - CatBoost model file name (\*.cmb). -cbname - name for a variable (of NCatboostCalcer::TCatboostCalcer type) to be available in CPP code. -CatBoost specific macro. - -###### Macro [BUILD\_MN][]([CHECK] [PTR] [MULTI] mninfo mnname) _# matrixnet_ <a name="macro_BUILD_MN"></a> -Generate MatrixNet data and access code using single command. -Alternative macro BUILD\_MNS() works faster and better for large files. - -###### Macro [BUILD\_MNS][]([CHECK] NAME listname mninfos...) _# matrixnet_ <a name="macro_BUILD_MNS"></a> -Generate MatrixNet data and access code using separate commands for support code, interface and data. -Faster version of BUILD\_MN() macro for large files. - -###### Macro [BUILD\_ONLY\_IF][](variables) _# builtin_ <a name="macro_BUILD_ONLY_IF"></a> -Print warning if all variables are false. For example, BUILD\_ONLY\_IF(LINUX WIN32) - -###### Macro [BUILD\_PLNS][](Src...) <a name="macro_BUILD_PLNS"></a> -Generate interface header plnmodels.h for Relev model (PLN). -Relev specific macro. - +Generate catboost model and access code. +cbmodel - CatBoost model file name (\*.cmb). +cbname - name for a variable (of NCatboostCalcer::TCatboostCalcer type) to be available in CPP code. +CatBoost specific macro. + +###### Macro [BUILD\_MN][]([CHECK] [PTR] [MULTI] mninfo mnname) _# matrixnet_ <a name="macro_BUILD_MN"></a> +Generate MatrixNet data and access code using single command. +Alternative macro BUILD\_MNS() works faster and better for large files. + +###### Macro [BUILD\_MNS][]([CHECK] NAME listname mninfos...) _# matrixnet_ <a name="macro_BUILD_MNS"></a> +Generate MatrixNet data and access code using separate commands for support code, interface and data. +Faster version of BUILD\_MN() macro for large files. + +###### Macro [BUILD\_ONLY\_IF][](variables) _# builtin_ <a name="macro_BUILD_ONLY_IF"></a> +Print warning if all variables are false. For example, BUILD\_ONLY\_IF(LINUX WIN32) + +###### Macro [BUILD\_PLNS][](Src...) <a name="macro_BUILD_PLNS"></a> +Generate interface header plnmodels.h for Relev model (PLN). +Relev specific macro. + ###### Macro [BUILD\_YDL\_DESC][](Input Symbol Output) <a name="macro_BUILD_YDL_DESC"></a> Generate a descriptor for a Symbol located in a ydl module Input, and put it to the file Output. @@ -1142,12 +1142,12 @@ Generate a descriptor for a Symbol located in a ydl module Input, and put it to This will parse file ../types.ydl, generate a descriptor for a symbol Event defined in the said file, and put the descriptor to the Event.ydld. -###### Macro [BUNDLE][](<Dir [NAME Name]>...) <a name="macro_BUNDLE"></a> -Brings build artefact from module Dir under optional Name to the current module (e.g. UNION) -If NAME is not specified, the name of the Dir's build artefact will be preserved -It makes little sense to specify BUNDLE on non-final targets and so this may stop working without prior notice. -Bundle on multimodule will select final target among multimodule variants and will fail if there are none or more than one. - +###### Macro [BUNDLE][](<Dir [NAME Name]>...) <a name="macro_BUNDLE"></a> +Brings build artefact from module Dir under optional Name to the current module (e.g. UNION) +If NAME is not specified, the name of the Dir's build artefact will be preserved +It makes little sense to specify BUNDLE on non-final targets and so this may stop working without prior notice. +Bundle on multimodule will select final target among multimodule variants and will fail if there are none or more than one. + ###### Macro [BUNDLE\_AIDL\_SRCS][](dirname filenames...) _# internal_ <a name="macro_BUNDLE_AIDL_SRCS"></a> Not documented yet. @@ -1166,35 +1166,35 @@ Not documented yet. ###### Macro [CC\_REQUIREMENTS][]([cpu: <value>] [ram: <value>]) <a name="macro_CC_REQUIREMENTS"></a> Override CPU and RAM requirements for all C/C++ compilation commands in the module -###### Macro $[CFG\_VARS][] _# internal_ <a name="macro_CFG_VARS"></a> -Mark commands that embed Configuration variables into files - -###### Macro [CFLAGS][]([GLOBAL compiler\_flag]\* compiler\_flags) <a name="macro_CFLAGS"></a> -Add the specified flags to the compilation command of C and C++ files. -@params: GLOBAL - Propagates these flags to dependent projects -Note: remember about the incompatibility flags for clang and cl (to set flags specifically for cl.exe use MSVC\_FLAGS). - -###### Macro [CGO\_CFLAGS][](Flags...) <a name="macro_CGO_CFLAGS"></a> -Compiler flags specific to CGO compilation - -###### Macro [CGO\_LDFLAGS][](Files...) <a name="macro_CGO_LDFLAGS"></a> -Linker flags specific to CGO linking - -###### Macro [CGO\_SRCS][](Files...) <a name="macro_CGO_SRCS"></a> -.go sources to be built with CGO - -###### Macro [CHECK\_CONFIG\_H][](<conf\_header>) _# internal_ <a name="macro_CHECK_CONFIG_H"></a> +###### Macro $[CFG\_VARS][] _# internal_ <a name="macro_CFG_VARS"></a> +Mark commands that embed Configuration variables into files + +###### Macro [CFLAGS][]([GLOBAL compiler\_flag]\* compiler\_flags) <a name="macro_CFLAGS"></a> +Add the specified flags to the compilation command of C and C++ files. +@params: GLOBAL - Propagates these flags to dependent projects +Note: remember about the incompatibility flags for clang and cl (to set flags specifically for cl.exe use MSVC\_FLAGS). + +###### Macro [CGO\_CFLAGS][](Flags...) <a name="macro_CGO_CFLAGS"></a> +Compiler flags specific to CGO compilation + +###### Macro [CGO\_LDFLAGS][](Files...) <a name="macro_CGO_LDFLAGS"></a> +Linker flags specific to CGO linking + +###### Macro [CGO\_SRCS][](Files...) <a name="macro_CGO_SRCS"></a> +.go sources to be built with CGO + +###### Macro [CHECK\_CONFIG\_H][](<conf\_header>) _# internal_ <a name="macro_CHECK_CONFIG_H"></a> This internal macro adds checking code for configuration header in external (contrib) library. -The check is needed to avoid conflicts on certain types and functions available in arcadia. - -@see https://a.yandex-team.ru/arc/trunk/arcadia/build/scripts/check\_config\_h.py for exact details - +The check is needed to avoid conflicts on certain types and functions available in arcadia. + +@see https://a.yandex-team.ru/arc/trunk/arcadia/build/scripts/check\_config\_h.py for exact details + ###### Macro [CHECK\_CONTRIB\_CREDITS][] <a name="macro_CHECK_CONTRIB_CREDITS"></a> Not documented yet. ###### Macro [CHECK\_DEPENDENT\_DIRS][](DENY|ALLOW\_ONLY ([ALL|PEERDIRS|GLOB] dir)...) <a name="macro_CHECK_DEPENDENT_DIRS"></a> Specify project transitive dependencies constraints. - + @params: 1. DENY: current module can not depend on module from any specified directory neither directly nor transitively. 2. ALLOW\_ONLY: current module can not depend on module from a dir not specified in the directory list neither directly nor transitively. @@ -1208,15 +1208,15 @@ Direcory constraints added before either ALL or PEERDIRS modifier is used are tr Note: Can be used multiple times on the same module all specified constraints will be checked. All macro invocation for the same module must use same constraints type (DENY or ALLOW\_ONLY) -###### Macro [CHECK\_JAVA\_DEPS][](<yes|no>) <a name="macro_CHECK_JAVA_DEPS"></a> -Check for different classes with duplicate name in classpath. - -Documentation: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [CLANG\_EMIT\_AST\_CXX][](Input Output Opts...) <a name="macro_CLANG_EMIT_AST_CXX"></a> +###### Macro [CHECK\_JAVA\_DEPS][](<yes|no>) <a name="macro_CHECK_JAVA_DEPS"></a> +Check for different classes with duplicate name in classpath. + +Documentation: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [CLANG\_EMIT\_AST\_CXX][](Input Output Opts...) <a name="macro_CLANG_EMIT_AST_CXX"></a> Emit Clang AST from .cpp file. CXXFLAGS and LLVM\_OPTS are passed in, while CFLAGS and C\_FLAGS\_PLATFORM are not. -Note: Output name is used as is, no extension added. - +Note: Output name is used as is, no extension added. + ###### Macro [COLLECT\_FRONTEND\_FILES][](Varname, Dir) <a name="macro_COLLECT_FRONTEND_FILES"></a> Recursively collect files with typical frontend extensions from Dir and save the result into variable Varname @@ -1227,9 +1227,9 @@ stores result in the variable with mane specified by first parameter. ###### Macro [COLLECT\_YDB\_API\_SPECS\_LEGACY][](VarName Paths...) _#deprecated_ <a name="macro_COLLECT_YDB_API_SPECS_LEGACY"></a> This macro is ugly hack for legacy YDB go API codegen, any other uses are prohibited -###### Macro [COMPILE\_C\_AS\_CXX][]() <a name="macro_COMPILE_C_AS_CXX"></a> -Compile .c files as .cpp ones within a module. - +###### Macro [COMPILE\_C\_AS\_CXX][]() <a name="macro_COMPILE_C_AS_CXX"></a> +Compile .c files as .cpp ones within a module. + ###### Macro [COMPILE\_LUA][](Src, [NAME <import\_name>]) <a name="macro_COMPILE_LUA"></a> Compile LUA source file to object code using LUA 2.0 Optionally override import name which is by default reflects Src name @@ -1243,27 +1243,27 @@ Generate and compile .nlg templates (Jinja2-based) and interface for megamind ru Alice-specific macro -###### Macro [COMPILE\_SWIFT\_MODULE][](SRCS{input}[], BRIDGE\_HEADER{input}="", Flags...) <a name="macro_COMPILE_SWIFT_MODULE"></a> -Not documented yet. - -###### Macro [CONFIGURE\_FILE][](from to) <a name="macro_CONFIGURE_FILE"></a> -Copy file with the replacement of configuration variables in form of @ANY\_CONF\_VAR@ with their values. +###### Macro [COMPILE\_SWIFT\_MODULE][](SRCS{input}[], BRIDGE\_HEADER{input}="", Flags...) <a name="macro_COMPILE_SWIFT_MODULE"></a> +Not documented yet. + +###### Macro [CONFIGURE\_FILE][](from to) <a name="macro_CONFIGURE_FILE"></a> +Copy file with the replacement of configuration variables in form of @ANY\_CONF\_VAR@ with their values. The values are collected during configure stage, while replacement itself happens during build stage. -Used implicitly for .in-files processing. - +Used implicitly for .in-files processing. + ###### Macro [CONFTEST\_LOAD\_POLICY\_LOCAL][]() <a name="macro_CONFTEST_LOAD_POLICY_LOCAL"></a> Loads conftest.py files in a way that pytest does it -###### Macro [CONLYFLAGS][]([GLOBAL compiler\_flag]\* compiler\_flags) <a name="macro_CONLYFLAGS"></a> -Add the specified flags to the compilation command of .c (but not .cpp) files. -@params: GLOBAL - Distributes these flags on dependent projects - -###### Macro [COPY][] <a name="macro_COPY"></a> -Not documented yet. - +###### Macro [CONLYFLAGS][]([GLOBAL compiler\_flag]\* compiler\_flags) <a name="macro_CONLYFLAGS"></a> +Add the specified flags to the compilation command of .c (but not .cpp) files. +@params: GLOBAL - Distributes these flags on dependent projects + +###### Macro [COPY][] <a name="macro_COPY"></a> +Not documented yet. + ###### Macro [COPY\_FILE][](File Destination [AUTO] [OUTPUT\_INCLUDES Deps...]) <a name="macro_COPY_FILE"></a> -Copy file to build root. It is possible to change both location and the name. - +Copy file to build root. It is possible to change both location and the name. + Parameters: - File - Source file name. - Destination - Output file name. @@ -1298,141 +1298,141 @@ using Tool. Extra dependencies are passed via DEPS. Define protoc plugin for C++ with given Name that emits code into 2 extra outputs using Tool. Extra dependencies are passed via DEPS. -###### Macro [CREATE\_BUILDINFO\_FOR][](GenHdr) <a name="macro_CREATE_BUILDINFO_FOR"></a> -Creates header file to access some information about build specified via configuration variables. -Unlike CREATE\_SVNVERSION\_FOR() it doesn't take revion information from VCS, it uses revision and SandboxTaskId passed via -D options to ya make - -###### Macro [CREATE\_INIT\_PY\_STRUCTURE][] <a name="macro_CREATE_INIT_PY_STRUCTURE"></a> -Not documented yet. - +###### Macro [CREATE\_BUILDINFO\_FOR][](GenHdr) <a name="macro_CREATE_BUILDINFO_FOR"></a> +Creates header file to access some information about build specified via configuration variables. +Unlike CREATE\_SVNVERSION\_FOR() it doesn't take revion information from VCS, it uses revision and SandboxTaskId passed via -D options to ya make + +###### Macro [CREATE\_INIT\_PY\_STRUCTURE][] <a name="macro_CREATE_INIT_PY_STRUCTURE"></a> +Not documented yet. + ###### Macro [CREDITS\_DISCLAIMER][] <a name="macro_CREDITS_DISCLAIMER"></a> Not documented yet. -###### Macro [CTEMPLATE\_VARNAMES][](File) <a name="macro_CTEMPLATE_VARNAMES"></a> -Generate File.varnames.h using contrib/libs/ctemplate/make\_tpl\_varnames\_h - -Documentation: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/ctemplate/README.md - -###### Macro [CUDA\_NVCC\_FLAGS][](compiler flags) <a name="macro_CUDA_NVCC_FLAGS"></a> -Add the specified flags to the compile line .cu-files. - +###### Macro [CTEMPLATE\_VARNAMES][](File) <a name="macro_CTEMPLATE_VARNAMES"></a> +Generate File.varnames.h using contrib/libs/ctemplate/make\_tpl\_varnames\_h + +Documentation: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/ctemplate/README.md + +###### Macro [CUDA\_NVCC\_FLAGS][](compiler flags) <a name="macro_CUDA_NVCC_FLAGS"></a> +Add the specified flags to the compile line .cu-files. + ###### Macro [CUSTOM\_LINK\_STEP\_SCRIPT][](name) <a name="macro_CUSTOM_LINK_STEP_SCRIPT"></a> Specifies name of a script for custom link step. The scripts should be placed in the build/scripts directory and are subject to review by devtools@. -###### Macro [CXXFLAGS][](compiler\_flags) <a name="macro_CXXFLAGS"></a> -Add the specified flags to the compilation command of .cpp (but not .c) files. - -###### Macro [DARWIN\_SIGNED\_RESOURCE][](Resource, Relpath) <a name="macro_DARWIN_SIGNED_RESOURCE"></a> -Not documented yet. - -###### Macro [DARWIN\_STRINGS\_RESOURCE][](Resource, Relpath) <a name="macro_DARWIN_STRINGS_RESOURCE"></a> -Not documented yet. - -###### Macro [DATA][]([path...]) <a name="macro_DATA"></a> -Specifies the path to the data necessary test. -Valid values are: arcadia/<path> , arcadia\_tests\_data/<path> and sbr://<resource\_id>. -In the latter case resource will be brought to the working directory of the test before it is started - -Used only inside TEST modules. - -Documentation: https://wiki.yandex-team.ru/yatool/test/#dannyeizrepozitorija - -###### Macro [DEB\_VERSION][](File) <a name="macro_DEB_VERSION"></a> -Creates a header file DebianVersion.h define the DEBIAN\_VERSION taken from the File. - -###### Macro [DECIMAL\_MD5\_LOWER\_32\_BITS][](<fileName> [FUNCNAME funcName] [inputs...]) <a name="macro_DECIMAL_MD5_LOWER_32_BITS"></a> -Generates .cpp file <fileName> with one defined function 'const char\* <funcName>() { return "<calculated\_md5\_hash>"; }'. -<calculated\_md5\_hash> will be md5 hash for all inputs passed to this macro. - -###### Macro [DECLARE\_EXTERNAL\_HOST\_RESOURCES\_BUNDLE][](name sbr:id FOR platform1 sbr:id FOR platform2...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_HOST_RESOURCES_BUNDLE"></a> -Associate name with sbr-id on platform. - -Ask devtools@yandex-team.ru if you need more information - -###### Macro [DECLARE\_EXTERNAL\_HOST\_RESOURCES\_PACK][](RESOURCE\_NAME name sbr:id FOR platform1 sbr:id FOR platform2... RESOURCE\_NAME name1 sbr:id1 FOR platform1...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_HOST_RESOURCES_PACK"></a> -Associate name with sbr-id on platform. - -Ask devtools@yandex-team.ru if you need more information - -###### Macro [DECLARE\_EXTERNAL\_RESOURCE][](name sbr:id name1 sbr:id1...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_RESOURCE"></a> -Associate name with sbr-id. - -Ask devtools@yandex-team.ru if you need more information - -###### Macro [DEFAULT][](varname value) _#builtin_ <a name="macro_DEFAULT"></a> -Sets varname to value if value is not set yet - -###### Macro [DEPENDENCY\_MANAGEMENT][](path/to/lib1 path/to/lib2 ...) <a name="macro_DEPENDENCY_MANAGEMENT"></a> -Lock version of the library from the contrib/java at some point, so that all unversioned PEERDIRs to this library refer to the specified version. - -For example, if the moduse has PEERDIR (contrib/java/junit/junit), and - 1. specifies DEPENDENCY\_MANAGEMENT(contrib/java/junit/junit/4.12), - the PEERDIR is automatically replaced by contrib/java/junit/junit/4.12; - 2. doesn't specify DEPENDENCY\_MANAGEMENT, PEERDIR automatically replaced - with the default from contrib/java/junit/junit/ya.make. - These defaults are always there and are supported by maven-import, which puts - there the maximum version available in contrib/java. - -The property is transitive. That is, if module A PEERDIRs module B, and B has PEERDIR(contrib/java/junit/junit), and this junit was replaced by junit-4.12, then junit-4.12 will come to A through B. - -If some module has both DEPENDENCY\_MANAGEMENT(contrib/java/junit/junit/4.12) and PERDIR(contrib/java/junit/junit/4.11), the PEERDIR wins. - -Documentation: https://wiki.yandex-team.ru/yatool/java/ - -###### Macro [DEPENDS][](path1 [path2...]) _# builtin_ <a name="macro_DEPENDS"></a> +###### Macro [CXXFLAGS][](compiler\_flags) <a name="macro_CXXFLAGS"></a> +Add the specified flags to the compilation command of .cpp (but not .c) files. + +###### Macro [DARWIN\_SIGNED\_RESOURCE][](Resource, Relpath) <a name="macro_DARWIN_SIGNED_RESOURCE"></a> +Not documented yet. + +###### Macro [DARWIN\_STRINGS\_RESOURCE][](Resource, Relpath) <a name="macro_DARWIN_STRINGS_RESOURCE"></a> +Not documented yet. + +###### Macro [DATA][]([path...]) <a name="macro_DATA"></a> +Specifies the path to the data necessary test. +Valid values are: arcadia/<path> , arcadia\_tests\_data/<path> and sbr://<resource\_id>. +In the latter case resource will be brought to the working directory of the test before it is started + +Used only inside TEST modules. + +Documentation: https://wiki.yandex-team.ru/yatool/test/#dannyeizrepozitorija + +###### Macro [DEB\_VERSION][](File) <a name="macro_DEB_VERSION"></a> +Creates a header file DebianVersion.h define the DEBIAN\_VERSION taken from the File. + +###### Macro [DECIMAL\_MD5\_LOWER\_32\_BITS][](<fileName> [FUNCNAME funcName] [inputs...]) <a name="macro_DECIMAL_MD5_LOWER_32_BITS"></a> +Generates .cpp file <fileName> with one defined function 'const char\* <funcName>() { return "<calculated\_md5\_hash>"; }'. +<calculated\_md5\_hash> will be md5 hash for all inputs passed to this macro. + +###### Macro [DECLARE\_EXTERNAL\_HOST\_RESOURCES\_BUNDLE][](name sbr:id FOR platform1 sbr:id FOR platform2...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_HOST_RESOURCES_BUNDLE"></a> +Associate name with sbr-id on platform. + +Ask devtools@yandex-team.ru if you need more information + +###### Macro [DECLARE\_EXTERNAL\_HOST\_RESOURCES\_PACK][](RESOURCE\_NAME name sbr:id FOR platform1 sbr:id FOR platform2... RESOURCE\_NAME name1 sbr:id1 FOR platform1...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_HOST_RESOURCES_PACK"></a> +Associate name with sbr-id on platform. + +Ask devtools@yandex-team.ru if you need more information + +###### Macro [DECLARE\_EXTERNAL\_RESOURCE][](name sbr:id name1 sbr:id1...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_RESOURCE"></a> +Associate name with sbr-id. + +Ask devtools@yandex-team.ru if you need more information + +###### Macro [DEFAULT][](varname value) _#builtin_ <a name="macro_DEFAULT"></a> +Sets varname to value if value is not set yet + +###### Macro [DEPENDENCY\_MANAGEMENT][](path/to/lib1 path/to/lib2 ...) <a name="macro_DEPENDENCY_MANAGEMENT"></a> +Lock version of the library from the contrib/java at some point, so that all unversioned PEERDIRs to this library refer to the specified version. + +For example, if the moduse has PEERDIR (contrib/java/junit/junit), and + 1. specifies DEPENDENCY\_MANAGEMENT(contrib/java/junit/junit/4.12), + the PEERDIR is automatically replaced by contrib/java/junit/junit/4.12; + 2. doesn't specify DEPENDENCY\_MANAGEMENT, PEERDIR automatically replaced + with the default from contrib/java/junit/junit/ya.make. + These defaults are always there and are supported by maven-import, which puts + there the maximum version available in contrib/java. + +The property is transitive. That is, if module A PEERDIRs module B, and B has PEERDIR(contrib/java/junit/junit), and this junit was replaced by junit-4.12, then junit-4.12 will come to A through B. + +If some module has both DEPENDENCY\_MANAGEMENT(contrib/java/junit/junit/4.12) and PERDIR(contrib/java/junit/junit/4.11), the PEERDIR wins. + +Documentation: https://wiki.yandex-team.ru/yatool/java/ + +###### Macro [DEPENDS][](path1 [path2...]) _# builtin_ <a name="macro_DEPENDS"></a> Buildable targets that should be brought to the test run. This dependency isonly used when tests run is requested. It will build the specified modules andbring them to the working directory of the test (in their Arcadia paths). Itis reasonable to specify only final targets her (like programs, DLLs orpackages). DEPENDS to UNION is the only exception: UNIONs aretransitively closed at DEPENDS bringing all dependencies to the test. - + DEPENDS on multimodule will select and bring single final target. If more noneor more than one final target available in multimodule DEPENDS to it willproduce configuration error. ###### Macro [DIRECT\_DEPS\_ONLY][] <a name="macro_DIRECT_DEPS_ONLY"></a> Add direct PEERDIR's only in java compile classpath -###### Macro [DISABLE][](varname) _#builtin_ <a name="macro_DISABLE"></a> +###### Macro [DISABLE][](varname) _#builtin_ <a name="macro_DISABLE"></a> Sets varname to 'no' - + ###### Macro [DISABLE\_DATA\_VALIDATION][]() <a name="macro_DISABLE_DATA_VALIDATION"></a> Not documented yet. -###### Macro [DLL\_FOR][](path/to/lib [libname] [major\_ver [minor\_ver]] [EXPORTS symlist\_file]) _#builtin_ <a name="macro_DLL_FOR"></a> -DLL module definition based on specified LIBRARY - +###### Macro [DLL\_FOR][](path/to/lib [libname] [major\_ver [minor\_ver]] [EXPORTS symlist\_file]) _#builtin_ <a name="macro_DLL_FOR"></a> +DLL module definition based on specified LIBRARY + ###### Macro [DOCS\_BUILDER][](tool) <a name="macro_DOCS_BUILDER"></a> Specify docs builder tool. Avalialbe tools: mkdocs and yfm (by default). @see: [DOCS](#multimodule\_DOCS) -###### Macro [DOCS\_CONFIG][](path) <a name="macro_DOCS_CONFIG"></a> +###### Macro [DOCS\_CONFIG][](path) <a name="macro_DOCS_CONFIG"></a> Specify path to config file for DOCS multimodule if it differs from default path. If [DOCS\_BUILDER()](#macro\_DOCS\_BUILDER) is set to "mkdocs" the default path is "%%project\_directory%%/mkdocs.yml". If [DOCS\_BUILDER()](#macro\_DOCS\_BUILDER) is not set or set to "yfm" the default path is "%%project\_directory%%/.yfm". Path must be either Arcadia root relative. - -@see: [DOCS](#multimodule\_DOCS) - -###### Macro [DOCS\_DIR][](path) <a name="macro_DOCS_DIR"></a> -Specify directory with source .md files for DOCS multimodule if it differs from project directory. -Path must be Arcadia root relative. - -@see: [DOCS](#multimodule\_DOCS) - + +@see: [DOCS](#multimodule\_DOCS) + +###### Macro [DOCS\_DIR][](path) <a name="macro_DOCS_DIR"></a> +Specify directory with source .md files for DOCS multimodule if it differs from project directory. +Path must be Arcadia root relative. + +@see: [DOCS](#multimodule\_DOCS) + ###### Macro [DOCS\_INCLUDE\_SOURCES][](path...) <a name="macro_DOCS_INCLUDE_SOURCES"></a> Specify a list of paths to source code files which will be used as text includes in a documentation project. Paths must be Arcadia root relative. @see: [DOCS](#multimodule\_DOCS) -###### Macro [DOCS\_VARS][](variable1=value1 variable2=value2 ...) <a name="macro_DOCS_VARS"></a> -Specify a set of default values of template variables for DOCS multimodule. -There must be no spaces around "=". Values will be treated as strings. - -@see: [DOCS](#multimodule\_DOCS) - -###### Macro [DUMPERF\_CODEGEN][](Prefix) <a name="macro_DUMPERF_CODEGEN"></a> -A special case BASE\_CODEGEN, in which the extsearch/images/robot/tools/dumperf/codegen tool is used - +###### Macro [DOCS\_VARS][](variable1=value1 variable2=value2 ...) <a name="macro_DOCS_VARS"></a> +Specify a set of default values of template variables for DOCS multimodule. +There must be no spaces around "=". Values will be treated as strings. + +@see: [DOCS](#multimodule\_DOCS) + +###### Macro [DUMPERF\_CODEGEN][](Prefix) <a name="macro_DUMPERF_CODEGEN"></a> +A special case BASE\_CODEGEN, in which the extsearch/images/robot/tools/dumperf/codegen tool is used + ###### Macro [DYNAMIC\_DEPS][](Path...) _# internal, temporary_ <a name="macro_DYNAMIC_DEPS"></a> Enlist paths to all DYNAMIC\_LIBRARY dependencies of the DYNAMIC\_LIBRARY This it needed to transfer their outputs through the library to PROGRAM @@ -1444,57 +1444,57 @@ Note: this is temporary solution until support of `super-global` variables come ###### Macro [DYNAMIC\_LIBRARY\_FROM][](Paths) <a name="macro_DYNAMIC_LIBRARY_FROM"></a> Use specified libraries as sources of DLL -###### Macro IF(condition) .. [ELSE][]IF(other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_ELSE"></a> -Apply macros if none of previous conditions hold - -###### Macro IF(condition) .. [ELSEIF][](other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_ELSEIF"></a> -Apply macros if other\_condition holds while none of previous conditions hold - +###### Macro IF(condition) .. [ELSE][]IF(other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_ELSE"></a> +Apply macros if none of previous conditions hold + +###### Macro IF(condition) .. [ELSEIF][](other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_ELSEIF"></a> +Apply macros if other\_condition holds while none of previous conditions hold + ###### Macro [EMBED\_JAVA\_VCS\_INFO][]() <a name="macro_EMBED_JAVA_VCS_INFO"></a> Embed manifest with vcs info into `EXTERNAL\_JAVA\_LIBRARY` By default this is disabled. -###### Macro [ENABLE][](varname) _#builtin_ <a name="macro_ENABLE"></a> +###### Macro [ENABLE][](varname) _#builtin_ <a name="macro_ENABLE"></a> Sets varname to 'yes' - + ###### Macro [ENABLE\_PREVIEW][]() <a name="macro_ENABLE_PREVIEW"></a> Enable java preview features. -###### Macro [END][]() _# builtin_ <a name="macro_END"></a> -The end of the module - -###### Macro IF(condition) .. ELSEIF(other\_condition) .. ELSE() .. [ENDIF][]() _#builtin_ <a name="macro_ENDIF"></a> -End of conditional construct - -###### Macro [ENV][](key[=value]) <a name="macro_ENV"></a> -Sets env variable key to value (gets value from system env by default). - -###### Macro [EXCLUDE][] <a name="macro_EXCLUDE"></a> -EXCLUDE(prefixes) - -The macro is in development. -Specifies which libraries should be excluded from the classpath. - -###### Macro [EXCLUDE\_TAGS][](tags...) _# builtin_ <a name="macro_EXCLUDE_TAGS"></a> -Instantiate from multimodule all variants except ones with tags listed - -###### Macro [EXPORTS\_SCRIPT][](exports\_file) <a name="macro_EXPORTS_SCRIPT"></a> +###### Macro [END][]() _# builtin_ <a name="macro_END"></a> +The end of the module + +###### Macro IF(condition) .. ELSEIF(other\_condition) .. ELSE() .. [ENDIF][]() _#builtin_ <a name="macro_ENDIF"></a> +End of conditional construct + +###### Macro [ENV][](key[=value]) <a name="macro_ENV"></a> +Sets env variable key to value (gets value from system env by default). + +###### Macro [EXCLUDE][] <a name="macro_EXCLUDE"></a> +EXCLUDE(prefixes) + +The macro is in development. +Specifies which libraries should be excluded from the classpath. + +###### Macro [EXCLUDE\_TAGS][](tags...) _# builtin_ <a name="macro_EXCLUDE_TAGS"></a> +Instantiate from multimodule all variants except ones with tags listed + +###### Macro [EXPORTS\_SCRIPT][](exports\_file) <a name="macro_EXPORTS_SCRIPT"></a> Specify exports script within PROGRAM, DLL and DLL-derived modules. -This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files. +This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files. The other option use EXPORTS parameter of the DLL module itself. - -@see: [DLL](#module\_DLL) - + +@see: [DLL](#module\_DLL) + ###### Macro [EXPORT\_ALL\_DYNAMIC\_SYMBOLS][]() <a name="macro_EXPORT_ALL_DYNAMIC_SYMBOLS"></a> Export all non-hidden symbols as dynamic when linking a PROGRAM. -###### Macro [EXPORT\_MAPKIT\_PROTO][]() _# internal deprecated_ <a name="macro_EXPORT_MAPKIT_PROTO"></a> -This macro is a temporary one and should be changed to EXPORT\_YMAPS\_PROTO -when transition of mapsmobi to arcadia is finished - -###### Macro [EXPORT\_YMAPS\_PROTO][]() _# maps-specific_ <a name="macro_EXPORT_YMAPS_PROTO"></a> -Maps-specific .proto handling: IMPORT\_YMAPS\_PROTO() + maps protobuf namespace. - +###### Macro [EXPORT\_MAPKIT\_PROTO][]() _# internal deprecated_ <a name="macro_EXPORT_MAPKIT_PROTO"></a> +This macro is a temporary one and should be changed to EXPORT\_YMAPS\_PROTO +when transition of mapsmobi to arcadia is finished + +###### Macro [EXPORT\_YMAPS\_PROTO][]() _# maps-specific_ <a name="macro_EXPORT_YMAPS_PROTO"></a> +Maps-specific .proto handling: IMPORT\_YMAPS\_PROTO() + maps protobuf namespace. + ###### Macro [EXPOSE][](OutputsToExport...) <a name="macro_EXPOSE"></a> Allows to mark outputs of macro command as unused in the current module but intended to be used in modules consuming current via PEERDIR. @@ -1503,22 +1503,22 @@ TODO(DEVTOOLS-9000) proper implementation needed ###### Macro [EXTERNAL\_JAR][] <a name="macro_EXTERNAL_JAR"></a> Not documented yet. - -###### Macro [EXTERNAL\_RESOURCE][](...) _#builtin, deprecated_ <a name="macro_EXTERNAL_RESOURCE"></a> -Don't use this. Use RESOURCE\_LIBRARY or FROM\_SANDBOX instead - + +###### Macro [EXTERNAL\_RESOURCE][](...) _#builtin, deprecated_ <a name="macro_EXTERNAL_RESOURCE"></a> +Don't use this. Use RESOURCE\_LIBRARY or FROM\_SANDBOX instead + ###### Macro [EXTRADIR][](...) _#builtin, deprecated_ <a name="macro_EXTRADIR"></a> -Ignored - -###### Macro [EXTRALIBS][](liblist) _# builtin_ <a name="macro_EXTRALIBS"></a> -Add external dynamic libraries during program linkage stage - -###### Macro [EXTRALIBS\_STATIC][](Libs...) <a name="macro_EXTRALIBS_STATIC"></a> -Add the specified external static libraries to the program link - -###### Macro [FAT\_RESOURCE][] <a name="macro_FAT_RESOURCE"></a> -Not documented yet. - +Ignored + +###### Macro [EXTRALIBS][](liblist) _# builtin_ <a name="macro_EXTRALIBS"></a> +Add external dynamic libraries during program linkage stage + +###### Macro [EXTRALIBS\_STATIC][](Libs...) <a name="macro_EXTRALIBS_STATIC"></a> +Add the specified external static libraries to the program link + +###### Macro [FAT\_RESOURCE][] <a name="macro_FAT_RESOURCE"></a> +Not documented yet. + ###### Macro [FBS\_NAMESPACE][](NAMESPACE, PATH...) <a name="macro_FBS_NAMESPACE"></a> Not documented yet. @@ -1527,46 +1527,46 @@ Create a tar archive of .py files generated by flatc for Python. Output tar archive will have .fbs.pysrc extension. This .fbs.pysrc extension is specially processed when --add-flatbuf-result flag is specified on the command line for 'ya make ...' (tar archive is extracted to output directory). - + ###### Macro [FILES][] <a name="macro_FILES"></a> Not documented yet. ###### Macro [FLATC\_FLAGS][](flags...) <a name="macro_FLATC_FLAGS"></a> Add flags to flatc command line -###### Macro [FLAT\_JOIN\_SRCS\_GLOBAL][](Out Src...) <a name="macro_FLAT_JOIN_SRCS_GLOBAL"></a> -Join set of sources into single file named Out and send it for further processing as if it were listed as SRCS(GLOBAL Out). -This macro places all files into single file, so will work with any sources. +###### Macro [FLAT\_JOIN\_SRCS\_GLOBAL][](Out Src...) <a name="macro_FLAT_JOIN_SRCS_GLOBAL"></a> +Join set of sources into single file named Out and send it for further processing as if it were listed as SRCS(GLOBAL Out). +This macro places all files into single file, so will work with any sources. You should specify file name with the extension as Out. Further processing will be done according to this extension. - -###### Macro [FORK\_SUBTESTS][]() <a name="macro_FORK_SUBTESTS"></a> -Splits the test run in chunks on subtests. -The number of chunks can be overridden using the macro SPLIT\_FACTOR. - + +###### Macro [FORK\_SUBTESTS][]() <a name="macro_FORK_SUBTESTS"></a> +Splits the test run in chunks on subtests. +The number of chunks can be overridden using the macro SPLIT\_FACTOR. + Allows to run tests in parallel. Supported in UNITTEST, JTEST/JUNIT5 and PY2TEST/PY3TEST modules. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [FORK\_TESTS][]() <a name="macro_FORK_TESTS"></a> -Splits a test run on chunks by test classes. -The number of chunks can be overridden using the macro SPLIT\_FACTOR. - + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [FORK\_TESTS][]() <a name="macro_FORK_TESTS"></a> +Splits a test run on chunks by test classes. +The number of chunks can be overridden using the macro SPLIT\_FACTOR. + Allows to run tests in parallel. Supported in UNITTEST, JTEST/JUNIT5 and PY2TEST/PY3TEST modules. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [FORK\_TEST\_FILES][]() <a name="macro_FORK_TEST_FILES"></a> + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [FORK\_TEST\_FILES][]() <a name="macro_FORK_TEST_FILES"></a> Only for PY2TEST and PY3TEST: splits a file executable with the tests on chunks in the files listed in TEST\_SRCS -Compatible with FORK\_(SUB)TESTS. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - +Compatible with FORK\_(SUB)TESTS. + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + ###### Macro [FROM\_ARCHIVE][](Src [RENAME <resource files>] OUT\_[NOAUTO] <output files> [EXECUTABLE]) <a name="macro_FROM_ARCHIVE"></a> Process file archive as [FROM\_SANDBOX()](#macro\_FROM\_SANDBOX). ###### Macro [FROM\_MDS][]([FILE] key [RENAME <resource files>] OUT\_[NOAUTO] <output files> [EXECUTABLE]) <a name="macro_FROM_MDS"></a> Download resource from MDS with the specified key and process like [FROM\_SANDBOX()](#macro\_FROM\_SANDBOX). - + ###### Macro [FROM\_NPM][](NAME VERSION SKY\_ID INTEGRITY INTEGRITY\_ALGO TARBALL\_PATH) <a name="macro_FROM_NPM"></a> Not documented yet. @@ -1578,10 +1578,10 @@ Defines lockfile list for `NPM\_CONTRIBS` module. ###### Macro [FROM\_SANDBOX][]([FILE] resource\_id [AUTOUPDATED script] [RENAME <resource files>] OUT\_[NOAUTO] <output files> [EXECUTABLE] [OUTPUT\_INCLUDES <include files>]) <a name="macro_FROM_SANDBOX"></a> Download the resource from the Sandbox, unpack (if not explicitly specified word FILE) and add OUT files to the build. EXECUTABLE makes them executable. You may specify extra dependencies that output files bring using OUTPUT\_INCLUDES. The change of these may e.g. lead to recompilation of .cpp files extracted from resource. -If there is no default processing for OUT files or you need process them specially use OUT\_NOAUTO instead of OUT. - -It is disallowed to specify directory as OUT/OUT\_NOAUTO since all outputs of commands shall be known to build system. - +If there is no default processing for OUT files or you need process them specially use OUT\_NOAUTO instead of OUT. + +It is disallowed to specify directory as OUT/OUT\_NOAUTO since all outputs of commands shall be known to build system. + RENAME renames files to the corresponding OUT and OUT\_NOAUTO outputs: FROM\_SANDBOX(resource\_id RENAME in\_file1 in\_file2 OUT out\_file1 out\_file2 out\_file3) FROM\_SANDBOX(resource\_id RENAME in\_file1 OUT out\_file1 RENAME in\_file2 OUT out\_file2) @@ -1589,127 +1589,127 @@ FROM\_SANDBOX(FILE resource\_id RENAME resource\_file OUT out\_name) RENAME RESOURCE allows to rename the resource without specifying its file name. -If AUTOUPDATED is specified than macro will be regularly updated according to autoupdate script. The dedicated Sandbox task scans the arcadia and +If AUTOUPDATED is specified than macro will be regularly updated according to autoupdate script. The dedicated Sandbox task scans the arcadia and changes resource\_ids in such macros if newer resource of specified type is available. Note that the task seeks AUTOUPDATED in specific position, -so you shall place it immediately after resource\_id. - -###### Macro [FUZZ\_DICTS][](path1 [path2...]) <a name="macro_FUZZ_DICTS"></a> -Allows you to specify dictionaries, relative to the root of Arcadia, which will be used in Fuzzing. -Libfuzzer and AFL use a single syntax for dictionary descriptions. -Should only be used in FUZZ modules. - -Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ - -###### Macro [FUZZ\_OPTS][](opt1 [Opt2...]) <a name="macro_FUZZ_OPTS"></a> -Overrides or adds options to the corpus mining and fuzzer run. -Currently supported only Libfuzzer, so you should use the options for it. -Should only be used in FUZZ modules. - -@example: - - FUZZ_OPTS ( - -max_len=1024 - -rss_limit_mb=8192 - ) - -Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ - -###### Macro [GENERATED\_SRCS][](srcs... PARSE\_META\_FROM cpp\_srcs... [OUTPUT\_INCLUDES output\_includes...] [OPTIONS]) <a name="macro_GENERATED_SRCS"></a> -Generate sources using Jinja 2 template engine. - -srcs... - list of text files which will be generated during build time by templates. Each template must be - placed to the place in source tree where corresponding source file should be generated. Name of +so you shall place it immediately after resource\_id. + +###### Macro [FUZZ\_DICTS][](path1 [path2...]) <a name="macro_FUZZ_DICTS"></a> +Allows you to specify dictionaries, relative to the root of Arcadia, which will be used in Fuzzing. +Libfuzzer and AFL use a single syntax for dictionary descriptions. +Should only be used in FUZZ modules. + +Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ + +###### Macro [FUZZ\_OPTS][](opt1 [Opt2...]) <a name="macro_FUZZ_OPTS"></a> +Overrides or adds options to the corpus mining and fuzzer run. +Currently supported only Libfuzzer, so you should use the options for it. +Should only be used in FUZZ modules. + +@example: + + FUZZ_OPTS ( + -max_len=1024 + -rss_limit_mb=8192 + ) + +Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ + +###### Macro [GENERATED\_SRCS][](srcs... PARSE\_META\_FROM cpp\_srcs... [OUTPUT\_INCLUDES output\_includes...] [OPTIONS]) <a name="macro_GENERATED_SRCS"></a> +Generate sources using Jinja 2 template engine. + +srcs... - list of text files which will be generated during build time by templates. Each template must be + placed to the place in source tree where corresponding source file should be generated. Name of template must be "<name\_of\_src\_file>.markettemplate". For example if you want to generate file "example.cpp" then template should be named "example.cpp.markettemplate". -PARSE\_META\_FROM cpp\_srcs... - list of C++ source files (.cpp, .h) which will be parsed using clang library - and metainformation extracted from the files will be made available for templates. Example of - template code fragment using metainformation: {{ meta.objects["@N@std@S@string"].name }} -OUTPUT\_INCLUDES output\_includes... - in cases when build system parser fails to determine all headers - which generated files include, you can specify additional headers here. In a normal situation this should - not be needed and this feature could be removed in the future. -OPTIONS - additional options for code\_generator utility - -Examples of templates can be found in directory market/tools/code\_generator/templates. -Metainformation does not contain entries for every object declared in C++ files specified in PARSE\_META\_FROM -parameter. To include some object into consideration you need to mark it by attribute. Attributes can -automatically add more attributes to dependent objects. This behavior depends on attribute definition. - -More information will be available (eventually:) here: https://wiki.yandex-team.ru/Users/denisk/codegenerator/ - -###### Macro [GENERATE\_ENUM\_SERIALIZATION][](File.h) <a name="macro_GENERATE_ENUM_SERIALIZATION"></a> -Create serialization support for enumeration members defined in the header (String <-> Enum conversions) and compile it into the module. - -Documentation: https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles/ - -###### Macro [GENERATE\_ENUM\_SERIALIZATION\_WITH\_HEADER][](File.h) <a name="macro_GENERATE_ENUM_SERIALIZATION_WITH_HEADER"></a> -Create serialization support for enumeration members defined in the header (String <-> Enum conversions) and compile it into the module -Provide access to serialization functions via generated header File\_serialized.h - -Documentation: https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles/ - -###### Macro [GENERATE\_PY\_PROTOS][](ProtoFiles...) _# deprecated_ <a name="macro_GENERATE_PY_PROTOS"></a> -Generate python bindings for protobuf files. -Macro is obsolete and not recommended for use! - -###### Macro [GENERATE\_SCRIPT][] <a name="macro_GENERATE_SCRIPT"></a> -heretic@ promised to make tutorial here -Don't forget -Feel free to remind - -###### Macro [GEN\_SCHEEME2][](scheeme\_name from\_file dependent\_files...) <a name="macro_GEN_SCHEEME2"></a> -Generates a C++ description for structure(contains the field RecordSig) in the specified file (and connected). - -1. ${scheeme\_name}.inc - the name of the generated file. -2. Use an environment variable - DATAWORK\_SCHEEME\_EXPORT\_FLAGS that allows to specify flags to tools/structparser - -@example: - - SET(DATAWORK_SCHEEME_EXPORT_FLAGS --final_only -m "::") - -all options are passed to structparser (in this example --final\_only - do not export heirs with public base that contains the required field,,- m "::" only from the root namespace) -sets in extra option - -@example: - - SET(EXTRACT_STRUCT_INFO_FLAGS -f \"const static ui32 RecordSig\" - -u \"RecordSig\" -n${scheeme_name}SchemeInfo ----gcc44_no_typename no_complex_overloaded_func_export - ${DATAWORK_SCHEEME_EXPORT_FLAGS}) - -for compatibility with C++ compiler and the external environment. -See tools/structparser for more details. - -###### Macro [GLOBAL\_SRCS][](filenames...) <a name="macro_GLOBAL_SRCS"></a> -Make all source files listed as GLOBAL. -Call to GLOBAL\_SRCS macro is equivalent to call to SRCS macro when each source file is marked with GLOBAL keyword. -Arcadia root relative or project dir relative paths are supported for filenames arguments. GLOBAL keyword is not -recognized for GLOBAL\_SRCS in contrast to SRCS macro. - -@example: -Consider the file to ya.make: - - LIBRARY() - GLOBAL_SRCS(foo.cpp bar.cpp) - END() - -@see: [SRCS()](#macro\_SRCS) - -###### Macro [GO\_ASM\_FLAGS][](flags) <a name="macro_GO_ASM_FLAGS"></a> +PARSE\_META\_FROM cpp\_srcs... - list of C++ source files (.cpp, .h) which will be parsed using clang library + and metainformation extracted from the files will be made available for templates. Example of + template code fragment using metainformation: {{ meta.objects["@N@std@S@string"].name }} +OUTPUT\_INCLUDES output\_includes... - in cases when build system parser fails to determine all headers + which generated files include, you can specify additional headers here. In a normal situation this should + not be needed and this feature could be removed in the future. +OPTIONS - additional options for code\_generator utility + +Examples of templates can be found in directory market/tools/code\_generator/templates. +Metainformation does not contain entries for every object declared in C++ files specified in PARSE\_META\_FROM +parameter. To include some object into consideration you need to mark it by attribute. Attributes can +automatically add more attributes to dependent objects. This behavior depends on attribute definition. + +More information will be available (eventually:) here: https://wiki.yandex-team.ru/Users/denisk/codegenerator/ + +###### Macro [GENERATE\_ENUM\_SERIALIZATION][](File.h) <a name="macro_GENERATE_ENUM_SERIALIZATION"></a> +Create serialization support for enumeration members defined in the header (String <-> Enum conversions) and compile it into the module. + +Documentation: https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles/ + +###### Macro [GENERATE\_ENUM\_SERIALIZATION\_WITH\_HEADER][](File.h) <a name="macro_GENERATE_ENUM_SERIALIZATION_WITH_HEADER"></a> +Create serialization support for enumeration members defined in the header (String <-> Enum conversions) and compile it into the module +Provide access to serialization functions via generated header File\_serialized.h + +Documentation: https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles/ + +###### Macro [GENERATE\_PY\_PROTOS][](ProtoFiles...) _# deprecated_ <a name="macro_GENERATE_PY_PROTOS"></a> +Generate python bindings for protobuf files. +Macro is obsolete and not recommended for use! + +###### Macro [GENERATE\_SCRIPT][] <a name="macro_GENERATE_SCRIPT"></a> +heretic@ promised to make tutorial here +Don't forget +Feel free to remind + +###### Macro [GEN\_SCHEEME2][](scheeme\_name from\_file dependent\_files...) <a name="macro_GEN_SCHEEME2"></a> +Generates a C++ description for structure(contains the field RecordSig) in the specified file (and connected). + +1. ${scheeme\_name}.inc - the name of the generated file. +2. Use an environment variable - DATAWORK\_SCHEEME\_EXPORT\_FLAGS that allows to specify flags to tools/structparser + +@example: + + SET(DATAWORK_SCHEEME_EXPORT_FLAGS --final_only -m "::") + +all options are passed to structparser (in this example --final\_only - do not export heirs with public base that contains the required field,,- m "::" only from the root namespace) +sets in extra option + +@example: + + SET(EXTRACT_STRUCT_INFO_FLAGS -f \"const static ui32 RecordSig\" + -u \"RecordSig\" -n${scheeme_name}SchemeInfo ----gcc44_no_typename no_complex_overloaded_func_export + ${DATAWORK_SCHEEME_EXPORT_FLAGS}) + +for compatibility with C++ compiler and the external environment. +See tools/structparser for more details. + +###### Macro [GLOBAL\_SRCS][](filenames...) <a name="macro_GLOBAL_SRCS"></a> +Make all source files listed as GLOBAL. +Call to GLOBAL\_SRCS macro is equivalent to call to SRCS macro when each source file is marked with GLOBAL keyword. +Arcadia root relative or project dir relative paths are supported for filenames arguments. GLOBAL keyword is not +recognized for GLOBAL\_SRCS in contrast to SRCS macro. + +@example: +Consider the file to ya.make: + + LIBRARY() + GLOBAL_SRCS(foo.cpp bar.cpp) + END() + +@see: [SRCS()](#macro\_SRCS) + +###### Macro [GO\_ASM\_FLAGS][](flags) <a name="macro_GO_ASM_FLAGS"></a> Add the specified flags to the go asm compile command line. - + ###### Macro [GO\_BENCH\_TIMEOUT][](x) <a name="macro_GO_BENCH_TIMEOUT"></a> Sets timeout in seconds for 1 Benchmark in go benchmark suite Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ -###### Macro [GO\_CGO1\_FLAGS][](flags) <a name="macro_GO_CGO1_FLAGS"></a> -Add the specified flags to the go cgo compile command line. - -###### Macro [GO\_CGO2\_FLAGS][](flags) <a name="macro_GO_CGO2_FLAGS"></a> -Add the specified flags to the go cgo compile command line. - -###### Macro [GO\_COMPILE\_FLAGS][](flags) <a name="macro_GO_COMPILE_FLAGS"></a> -Add the specified flags to the go compile command line. - +###### Macro [GO\_CGO1\_FLAGS][](flags) <a name="macro_GO_CGO1_FLAGS"></a> +Add the specified flags to the go cgo compile command line. + +###### Macro [GO\_CGO2\_FLAGS][](flags) <a name="macro_GO_CGO2_FLAGS"></a> +Add the specified flags to the go cgo compile command line. + +###### Macro [GO\_COMPILE\_FLAGS][](flags) <a name="macro_GO_COMPILE_FLAGS"></a> +Add the specified flags to the go compile command line. + ###### Macro [GO\_EMBED\_DIR][](DIR) <a name="macro_GO_EMBED_DIR"></a> Define an embed directory DIR. @@ -1722,21 +1722,21 @@ Define an embed directory DIR for internal go tests. ###### Macro GO\_XTEST\_EMBED\_DIR(DIR) <a name="macro_GO_EMBED_XTEST_DIR"></a> Define an embed directory DIR for external go tests. -###### Macro [GO\_FAKE\_OUTPUT][](go-src-files...) <a name="macro_GO_FAKE_OUTPUT"></a> -Not documented yet. - +###### Macro [GO\_FAKE\_OUTPUT][](go-src-files...) <a name="macro_GO_FAKE_OUTPUT"></a> +Not documented yet. + ###### Macro [GO\_GRPC\_GATEWAY\_SRCS][]() <a name="macro_GO_GRPC_GATEWAY_SRCS"></a> Use of grpc-gateway plugin (Supported for Go only). ###### Macro [GO\_GRPC\_GATEWAY\_SWAGGER\_SRCS][]() <a name="macro_GO_GRPC_GATEWAY_SWAGGER_SRCS"></a> Use of grpc-gateway plugin w/ swagger emission (Supported for Go only). -###### Macro [GO\_LDFLAGS][](Flags...) <a name="macro_GO_LDFLAGS"></a> -Link flags for GO\_PROGRAM linking from .go sources - -###### Macro [GO\_LINK\_FLAGS][](flags) <a name="macro_GO_LINK_FLAGS"></a> -Add the specified flags to the go link command line. - +###### Macro [GO\_LDFLAGS][](Flags...) <a name="macro_GO_LDFLAGS"></a> +Link flags for GO\_PROGRAM linking from .go sources + +###### Macro [GO\_LINK\_FLAGS][](flags) <a name="macro_GO_LINK_FLAGS"></a> +Add the specified flags to the go link command line. + ###### Macro [GO\_MOCKGEN\_FROM][](Path) <a name="macro_GO_MOCKGEN_FROM"></a> Not documented yet. @@ -1749,9 +1749,9 @@ Not documented yet. ###### Macro [GO\_MOCKGEN\_TYPES][](First, Rest...) <a name="macro_GO_MOCKGEN_TYPES"></a> Not documented yet. -###### Macro [GO\_PACKAGE\_NAME][](Name) <a name="macro_GO_PACKAGE_NAME"></a> -Override name of a Go package. - +###### Macro [GO\_PACKAGE\_NAME][](Name) <a name="macro_GO_PACKAGE_NAME"></a> +Override name of a Go package. + ###### Macro [GO\_PROTO\_PLUGIN][](Name Ext Tool [DEPS dependencies...]) <a name="macro_GO_PROTO_PLUGIN"></a> Define protoc plugin for GO with given Name that emits extra output with provided extension Ext using Tool. Extra dependencies are passed via DEPS. @@ -1763,29 +1763,29 @@ NB! Subtests are not taken into account! ###### Macro [GO\_TEST\_EMBED\_PATTERN][](PATTERN) <a name="macro_GO_TEST_EMBED_PATTERN"></a> Define an embed pattern for internal go tests. -###### Macro [GO\_TEST\_FOR][](path/to/module) _#builtin_ <a name="macro_GO_TEST_FOR"></a> -Produces go test for specified module - -###### Macro [GO\_TEST\_SRCS][](Files...) <a name="macro_GO_TEST_SRCS"></a> -.go sources for internal tests of a module - +###### Macro [GO\_TEST\_FOR][](path/to/module) _#builtin_ <a name="macro_GO_TEST_FOR"></a> +Produces go test for specified module + +###### Macro [GO\_TEST\_SRCS][](Files...) <a name="macro_GO_TEST_SRCS"></a> +.go sources for internal tests of a module + ###### Macro [GO\_XTEST\_EMBED\_PATTERN][](PATTERN) <a name="macro_GO_XTEST_EMBED_PATTERN"></a> Define an embed pattern for external go tests. -###### Macro [GO\_XTEST\_SRCS][](Files...) <a name="macro_GO_XTEST_SRCS"></a> -.go sources for external tests of a module - +###### Macro [GO\_XTEST\_SRCS][](Files...) <a name="macro_GO_XTEST_SRCS"></a> +.go sources for external tests of a module + ###### Macro [GRADLE\_FLAGS][](flags...) _# internal_ <a name="macro_GRADLE_FLAGS"></a> SEt additional flags for gradle -###### Macro [GRPC][]() <a name="macro_GRPC"></a> -Emit GRPC code for all .proto files in a PROTO\_LIBRARY. -This works for all available PROTO\_LIBRARY versions (C++, Python 2.x, Pyton 3.x, Java and Go). - -###### Macro [IDEA\_EXCLUDE\_DIRS][](<excluded dirs>) <a name="macro_IDEA_EXCLUDE_DIRS"></a> -Exclude specified directories from an idea project generated by ya ide idea -Have no effect on regular build. - +###### Macro [GRPC][]() <a name="macro_GRPC"></a> +Emit GRPC code for all .proto files in a PROTO\_LIBRARY. +This works for all available PROTO\_LIBRARY versions (C++, Python 2.x, Pyton 3.x, Java and Go). + +###### Macro [IDEA\_EXCLUDE\_DIRS][](<excluded dirs>) <a name="macro_IDEA_EXCLUDE_DIRS"></a> +Exclude specified directories from an idea project generated by ya ide idea +Have no effect on regular build. + ###### Macro [IDEA\_JAR\_SRCS][](Args...) <a name="macro_IDEA_JAR_SRCS"></a> Not documented yet. @@ -1793,36 +1793,36 @@ Not documented yet. Set module name in an idea project generated by ya ide idea Have no effect on regular build. -###### Macro [IDEA\_RESOURCE\_DIRS][](<additional dirs>) <a name="macro_IDEA_RESOURCE_DIRS"></a> -Set specified resource directories in an idea project generated by ya ide idea -Have no effect on regular build. - -###### Macro [IF][](condition) .. ELSEIF(other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_IF"></a> -Apply macros if condition holds - -###### Macro [INCLUDE][](filename) _#builtin_ <a name="macro_INCLUDE"></a> -Include file textually and process it as a part of the ya.make - -###### Macro [INCLUDE\_TAGS][](tags...) _# builtin_ <a name="macro_INCLUDE_TAGS"></a> -Additionally instantiate from multimodule all variants with tags listed (overrides default) - -###### Macro [INDUCED\_DEPS][](Extension Path...) _#builtin_ <a name="macro_INDUCED_DEPS"></a> +###### Macro [IDEA\_RESOURCE\_DIRS][](<additional dirs>) <a name="macro_IDEA_RESOURCE_DIRS"></a> +Set specified resource directories in an idea project generated by ya ide idea +Have no effect on regular build. + +###### Macro [IF][](condition) .. ELSEIF(other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_IF"></a> +Apply macros if condition holds + +###### Macro [INCLUDE][](filename) _#builtin_ <a name="macro_INCLUDE"></a> +Include file textually and process it as a part of the ya.make + +###### Macro [INCLUDE\_TAGS][](tags...) _# builtin_ <a name="macro_INCLUDE_TAGS"></a> +Additionally instantiate from multimodule all variants with tags listed (overrides default) + +###### Macro [INDUCED\_DEPS][](Extension Path...) _#builtin_ <a name="macro_INDUCED_DEPS"></a> States that files wih the Extension generated by the PROGRAM will depend on files in Path. This only useful in PROGRAM and similar modules. It will be applied if the PROGRAM is used in RUN\_PROGRAM macro. All Paths specified must be absolute arcadia paths i.e. start with ${ARCADIA\_ROOT} ${ARCADIA\_BUILD\_ROOT}, ${CURDIR} or ${BINDIR}. - -###### Macro [IOS\_APP\_ASSETS\_FLAGS][](Flags...) <a name="macro_IOS_APP_ASSETS_FLAGS"></a> -Not documented yet. - -###### Macro [IOS\_APP\_COMMON\_FLAGS][](Flags...) <a name="macro_IOS_APP_COMMON_FLAGS"></a> -Not documented yet. - -###### Macro [IOS\_APP\_SETTINGS][] <a name="macro_IOS_APP_SETTINGS"></a> -Not documented yet. - -###### Macro [IOS\_ASSETS][] <a name="macro_IOS_ASSETS"></a> -Not documented yet. - + +###### Macro [IOS\_APP\_ASSETS\_FLAGS][](Flags...) <a name="macro_IOS_APP_ASSETS_FLAGS"></a> +Not documented yet. + +###### Macro [IOS\_APP\_COMMON\_FLAGS][](Flags...) <a name="macro_IOS_APP_COMMON_FLAGS"></a> +Not documented yet. + +###### Macro [IOS\_APP\_SETTINGS][] <a name="macro_IOS_APP_SETTINGS"></a> +Not documented yet. + +###### Macro [IOS\_ASSETS][] <a name="macro_IOS_ASSETS"></a> +Not documented yet. + ###### Macro [JAR\_ANNOTATION\_PROCESSOR][](Classes...) <a name="macro_JAR_ANNOTATION_PROCESSOR"></a> Not documented yet. @@ -1837,9 +1837,9 @@ Filter .jar file content: keep only matched files ###### Macro [JAR\_RESOURCE][](Id) <a name="macro_JAR_RESOURCE"></a> Not documented yet. -###### Macro [JAVAC\_FLAGS][](Args...) <a name="macro_JAVAC_FLAGS"></a> -Set additional Java compilation flags. - +###### Macro [JAVAC\_FLAGS][](Args...) <a name="macro_JAVAC_FLAGS"></a> +Set additional Java compilation flags. + ###### Macro [JAVA\_DEPENDENCIES\_CONFIGURATION][](Vetos...) <a name="macro_JAVA_DEPENDENCIES_CONFIGURATION"></a> Validate contrib/java dependencies Valid arguments @@ -1853,12 +1853,12 @@ REQUIRE\_DM - all dependencies must be specified in DEPENDENCY\_MANAGEMENT (tran ###### Macro [JAVA\_EXTERNAL\_DEPENDENCIES][](file1 file2 ...) <a name="macro_JAVA_EXTERNAL_DEPENDENCIES"></a> Add non-source java external build dependency (like lombok config file) -###### Macro [JAVA\_IGNORE\_CLASSPATH\_CLASH\_FOR][]([classes]) <a name="macro_JAVA_IGNORE_CLASSPATH_CLASH_FOR"></a> -Ignore classpath clash test fails for classes - -###### Macro [JAVA\_MODULE][] <a name="macro_JAVA_MODULE"></a> -Not documented yet. - +###### Macro [JAVA\_IGNORE\_CLASSPATH\_CLASH\_FOR][]([classes]) <a name="macro_JAVA_IGNORE_CLASSPATH_CLASH_FOR"></a> +Ignore classpath clash test fails for classes + +###### Macro [JAVA\_MODULE][] <a name="macro_JAVA_MODULE"></a> +Not documented yet. + ###### Macro [JAVA\_PROTO\_PLUGIN][](Name Tool DEPS <Dependencies>) <a name="macro_JAVA_PROTO_PLUGIN"></a> Define protoc plugin for Java with given Name that emits extra outputs using Tool. Extra dependencies are passed via DEPS @@ -1869,57 +1869,57 @@ Override CPU and RAM requirements for all C/C++ compilation commands in the modu ###### Macro [JAVA\_RESOURCE][](JAR, SOURCES="") <a name="macro_JAVA_RESOURCE"></a> Not documented yet. -###### Macro [JAVA\_SRCS][](srcs) <a name="macro_JAVA_SRCS"></a> -Specify java source files and resources. A macro can be contained in any of four java modules. -Keywords: -1. X SRCDIR - specify the directory x is performed relatively to search the source code for these patterns. If there is no SRCDIR, the source will be searched relative to the module directory. -2. PACKAGE\_PREFIX x - use if source paths relative to the SRCDIR does not coincide with the full class names. For example, if all sources of module are in the same package, you can create a directory package/name , and just put the source code in the SRCDIR and specify PACKAGE\_PREFIX package.name. - -@example: - - example/ya.make - - JAVA_PROGRAM() - JAVA_SRCS(SRCDIR src/main/java **/*) - END() - - - example/src/main/java/ru/yandex/example/HelloWorld.java - - package ru.yandex.example; - public class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } - } - -Documentation: https://wiki.yandex-team.ru/yatool/java/#javasrcs - -###### Macro [JAVA\_TEST][] <a name="macro_JAVA_TEST"></a> -Not documented yet. - -###### Macro [JAVA\_TEST\_DEPS][] <a name="macro_JAVA_TEST_DEPS"></a> -Not documented yet. - +###### Macro [JAVA\_SRCS][](srcs) <a name="macro_JAVA_SRCS"></a> +Specify java source files and resources. A macro can be contained in any of four java modules. +Keywords: +1. X SRCDIR - specify the directory x is performed relatively to search the source code for these patterns. If there is no SRCDIR, the source will be searched relative to the module directory. +2. PACKAGE\_PREFIX x - use if source paths relative to the SRCDIR does not coincide with the full class names. For example, if all sources of module are in the same package, you can create a directory package/name , and just put the source code in the SRCDIR and specify PACKAGE\_PREFIX package.name. + +@example: + - example/ya.make + + JAVA_PROGRAM() + JAVA_SRCS(SRCDIR src/main/java **/*) + END() + + - example/src/main/java/ru/yandex/example/HelloWorld.java + + package ru.yandex.example; + public class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + +Documentation: https://wiki.yandex-team.ru/yatool/java/#javasrcs + +###### Macro [JAVA\_TEST][] <a name="macro_JAVA_TEST"></a> +Not documented yet. + +###### Macro [JAVA\_TEST\_DEPS][] <a name="macro_JAVA_TEST_DEPS"></a> +Not documented yet. + ###### Macro MODULE\_JDK(Version) <a name="macro_JDK_VERSION"></a> Specify JDK version for module -###### Macro [JOINSRC][]() _# deprecated, does-nothing_ <a name="macro_JOINSRC"></a> -This macro currently does nothing. Use JOIN\_SRCS and similar macros to make one file of set of sources. - -###### Macro [JOIN\_SRCS][](Out Src...) <a name="macro_JOIN_SRCS"></a> -Join set of sources into single file named Out and send it for further processing. -This macro doesn't place all file into Out, it emits #include<Src>... Use the for C++ source files only. -You should specify file name with the extension as Out. Futher processing will be done according this extension. - -###### Macro [JOIN\_SRCS\_GLOBAL][](Out Src...) <a name="macro_JOIN_SRCS_GLOBAL"></a> -Join set of sources into single file named Out and send it for further processing as if it were listed as SRCS(GLOBAL Out). -This macro doesn't place all file into Out, it emits #include<Src>... Use the for C++ source files only. +###### Macro [JOINSRC][]() _# deprecated, does-nothing_ <a name="macro_JOINSRC"></a> +This macro currently does nothing. Use JOIN\_SRCS and similar macros to make one file of set of sources. + +###### Macro [JOIN\_SRCS][](Out Src...) <a name="macro_JOIN_SRCS"></a> +Join set of sources into single file named Out and send it for further processing. +This macro doesn't place all file into Out, it emits #include<Src>... Use the for C++ source files only. +You should specify file name with the extension as Out. Futher processing will be done according this extension. + +###### Macro [JOIN\_SRCS\_GLOBAL][](Out Src...) <a name="macro_JOIN_SRCS_GLOBAL"></a> +Join set of sources into single file named Out and send it for further processing as if it were listed as SRCS(GLOBAL Out). +This macro doesn't place all file into Out, it emits #include<Src>... Use the for C++ source files only. You should specify file name with the extension as Out. Further processing will be done according to this extension. - -###### Macro [JVM\_ARGS][](Args...) <a name="macro_JVM_ARGS"></a> -Arguments to run Java programs in tests. - -Documentation: https://wiki.yandex-team.ru/yatool/test/ - + +###### Macro [JVM\_ARGS][](Args...) <a name="macro_JVM_ARGS"></a> +Arguments to run Java programs in tests. + +Documentation: https://wiki.yandex-team.ru/yatool/test/ + ###### Macro [KOTLINC\_FLAGS][](-flags) <a name="macro_KOTLINC_FLAGS"></a> Set additional Kotlin compilation flags. @@ -1928,23 +1928,23 @@ Use large file ether from working copy or from remote storage via placeholder <F If <File> is present locally (and not a symlink!) it will be copied to build directory. Otherwise macro will try to locate <File>.external, parse it retrieve ot during build phase. -###### Macro [LDFLAGS][](LinkerFlags...) <a name="macro_LDFLAGS"></a> -Add flags to the link command line of executable or shared library/dll. -Note: LDFLAGS are always global. When set in the LIBRARY module they will affect all programs/dlls/tests the library is linked into. -Note: remember about the incompatibility of flags for gcc and cl. - +###### Macro [LDFLAGS][](LinkerFlags...) <a name="macro_LDFLAGS"></a> +Add flags to the link command line of executable or shared library/dll. +Note: LDFLAGS are always global. When set in the LIBRARY module they will affect all programs/dlls/tests the library is linked into. +Note: remember about the incompatibility of flags for gcc and cl. + ###### Macro [LD\_REQUIREMENTS][]([cpu: <value>] [ram: <value>]) <a name="macro_LD_REQUIREMENTS"></a> Override CPU and RAM requirements for link command in the module ###### Macro [LIB\_REQUIREMENTS][]([cpu: <value>] [ram: <value>]) <a name="macro_LIB_REQUIREMENTS"></a> Override CPU and RAM requirements for library creation comand of a x\_LIBRARY modules -###### Macro [LICENSE][](licenses...) <a name="macro_LICENSE"></a> +###### Macro [LICENSE][](licenses...) <a name="macro_LICENSE"></a> Specify the licenses of the module, separated by spaces. Specifying multiple licenses interpreted as permission to use this library satisfying all conditions of any of the listed licenses. - -A license must be prescribed for contribs - + +A license must be prescribed for contribs + ###### Macro [LICENSE\_TEXTS][](File) <a name="macro_LICENSE_TEXTS"></a> This macro specifies the filename with all library licenses texts @@ -1957,38 +1957,38 @@ $usage: LINK\_EXEC\_DYN\_LIB\_IMPL(peers...) # internal ###### Macro [LINK\_EXE\_IMPL][] <a name="macro_LINK_EXE_IMPL"></a> $usage: LINK\_EXE\_IMPL(peers...) # internal -###### Macro [LINT][](<none|base|strict>) <a name="macro_LINT"></a> -Set linting levem for sources of the module - -###### Macro [LJ\_21\_ARCHIVE][](NAME Name LuaFiles...) _# deprecated_ <a name="macro_LJ_21_ARCHIVE"></a> -Precompile .lua files using LuaJIT 2.1 and archive both sources and results using sources names as keys - -###### Macro [LJ\_ARCHIVE][](NAME Name LuaFiles...) <a name="macro_LJ_ARCHIVE"></a> -Precompile .lua files using LuaJIT and archive both sources and results using sources names as keys - -###### Macro [LLVM\_BC][] <a name="macro_LLVM_BC"></a> -Not documented yet. - -###### Macro [LLVM\_COMPILE\_C][](Input Output Opts...) <a name="macro_LLVM_COMPILE_C"></a> +###### Macro [LINT][](<none|base|strict>) <a name="macro_LINT"></a> +Set linting levem for sources of the module + +###### Macro [LJ\_21\_ARCHIVE][](NAME Name LuaFiles...) _# deprecated_ <a name="macro_LJ_21_ARCHIVE"></a> +Precompile .lua files using LuaJIT 2.1 and archive both sources and results using sources names as keys + +###### Macro [LJ\_ARCHIVE][](NAME Name LuaFiles...) <a name="macro_LJ_ARCHIVE"></a> +Precompile .lua files using LuaJIT and archive both sources and results using sources names as keys + +###### Macro [LLVM\_BC][] <a name="macro_LLVM_BC"></a> +Not documented yet. + +###### Macro [LLVM\_COMPILE\_C][](Input Output Opts...) <a name="macro_LLVM_COMPILE_C"></a> Emit LLVM bytecode from .c file. BC\_CFLAGS, LLVM\_OPTS and C\_FLAGS\_PLATFORM are passed in, while CFLAGS are not. -Note: Output name is used as is, no extension added. - -###### Macro [LLVM\_COMPILE\_CXX][](Input Output Opts...) <a name="macro_LLVM_COMPILE_CXX"></a> +Note: Output name is used as is, no extension added. + +###### Macro [LLVM\_COMPILE\_CXX][](Input Output Opts...) <a name="macro_LLVM_COMPILE_CXX"></a> Emit LLVM bytecode from .cpp file. BC\_CXXFLAGS, LLVM\_OPTS and C\_FLAGS\_PLATFORM are passed in, while CFLAGS are not. -Note: Output name is used as is, no extension added. - -###### Macro [LLVM\_COMPILE\_LL][](Input Output Opts...) <a name="macro_LLVM_COMPILE_LL"></a> -Compile LLVM bytecode to object representation. -Note: Output name is used as is, no extension added. - -###### Macro [LLVM\_LINK][](Output Inputs...) <a name="macro_LLVM_LINK"></a> -Call llvm-link on set of Inputs to produce Output. -Note: Unlike many other macros output argument goes first. Output name is used as is, no extension added. - -###### Macro [LLVM\_OPT][](Input Output Opts...) <a name="macro_LLVM_OPT"></a> -Call llvm-opt with set of Opts on Input to produce Output. -Note: Output name is used as is, no extension added. - +Note: Output name is used as is, no extension added. + +###### Macro [LLVM\_COMPILE\_LL][](Input Output Opts...) <a name="macro_LLVM_COMPILE_LL"></a> +Compile LLVM bytecode to object representation. +Note: Output name is used as is, no extension added. + +###### Macro [LLVM\_LINK][](Output Inputs...) <a name="macro_LLVM_LINK"></a> +Call llvm-link on set of Inputs to produce Output. +Note: Unlike many other macros output argument goes first. Output name is used as is, no extension added. + +###### Macro [LLVM\_OPT][](Input Output Opts...) <a name="macro_LLVM_OPT"></a> +Call llvm-opt with set of Opts on Input to produce Output. +Note: Output name is used as is, no extension added. + ###### Macro [LOCAL\_JAR][](File) <a name="macro_LOCAL_JAR"></a> Not documented yet. @@ -1996,46 +1996,46 @@ Not documented yet. Not documented yet. ###### Macro [LUA][](script\_path args... [CWD dir] [ENV key=value...] [TOOL tools...] [IN inputs...] [OUT[\_NOAUTO] outputs...] [STDOUT[\_NOAUTO] output] [OUTPUT\_INCLUDES output\_includes...][ REQUIREMENTS reqs]) <a name="macro_LUA"></a> -Run a lua script. +Run a lua script. These macros are similar: RUN\_PROGRAM, LUA, PYTHON. - -Parameters: + +Parameters: - script\_path - Path to the script.3 -- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. -- CWD dir - Absolute path of the working directory. -- ENV key=value... - Environment variables. -- TOOL tools... - Auxiliary tool directories. -- IN inputs... - Input files. -- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. -- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. -- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. +- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. +- CWD dir - Absolute path of the working directory. +- ENV key=value... - Environment variables. +- TOOL tools... - Auxiliary tool directories. +- IN inputs... - Input files. +- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. +- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. +- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. - REQUIREMENTS - Override default requirements for CPU and RAM - -For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or -${CURDIR} and ${BINDIR} which are expanded where the outputs are used. - -###### Macro [MACROS\_WITH\_ERROR][] <a name="macro_MACROS_WITH_ERROR"></a> -Not documented yet. - -###### Macro [MAPKITIDL][](idl-file-name... <a name="macro_MAPKITIDL"></a> -[OUT\_DIR output-dir] -[IDL\_INCLUDES idl-dirs...] -[FILTER filters...]) -[FILTER\_OUT filters...]) -[GLOBAL\_OUTPUTS] -Generate bindings to target platform language. -(Used for mobile MapKit project) -1. idl-file-name... - a list of \*.idl files to process -2. output-dir - a base root of output directory -3. idl-dirs - a list of directories where to search for imported \*.idl files + +For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or +${CURDIR} and ${BINDIR} which are expanded where the outputs are used. + +###### Macro [MACROS\_WITH\_ERROR][] <a name="macro_MACROS_WITH_ERROR"></a> +Not documented yet. + +###### Macro [MAPKITIDL][](idl-file-name... <a name="macro_MAPKITIDL"></a> +[OUT\_DIR output-dir] +[IDL\_INCLUDES idl-dirs...] +[FILTER filters...]) +[FILTER\_OUT filters...]) +[GLOBAL\_OUTPUTS] +Generate bindings to target platform language. +(Used for mobile MapKit project) +1. idl-file-name... - a list of \*.idl files to process +2. output-dir - a base root of output directory +3. idl-dirs - a list of directories where to search for imported \*.idl files 4. filters - a list of extensions used to filter outputs and output includes - -###### Macro [MAPKIT\_ADDINCL][](Dirs...) <a name="macro_MAPKIT_ADDINCL"></a> -Not documented yet. - -###### Macro [MAPKIT\_ENABLE\_WHOLE\_ARCHIVE][]() _# internal deprecated_ <a name="macro_MAPKIT_ENABLE_WHOLE_ARCHIVE"></a> + +###### Macro [MAPKIT\_ADDINCL][](Dirs...) <a name="macro_MAPKIT_ADDINCL"></a> +Not documented yet. + +###### Macro [MAPKIT\_ENABLE\_WHOLE\_ARCHIVE][]() _# internal deprecated_ <a name="macro_MAPKIT_ENABLE_WHOLE_ARCHIVE"></a> This macro is strictly prohibited to use outside of mapsmobi project - + ###### Macro [MAPSMOBI\_COLLECT\_AIDL\_FILES][](varname [dir]) _# internal_ <a name="macro_MAPSMOBI_COLLECT_AIDL_FILES"></a> This macro is strictly prohibited to use outside of mapsmobi project @@ -2054,16 +2054,16 @@ This macro is strictly prohibited to use outside of mapsmobi project ###### Macro [MAPSMOBI\_COLLECT\_TPL\_FILES][](varname [dir]) _# internal_ <a name="macro_MAPSMOBI_COLLECT_TPL_FILES"></a> This macro is strictly prohibited to use outside of mapsmobi project -###### Macro [MAPSMOBI\_SRCS][](filenames...) _# internal_ <a name="macro_MAPSMOBI_SRCS"></a> -Make all source files listed as GLOBAL or not (depending on the value of -MAPSMOBI\_USE\_SRCS\_GLOBAL). Be careful since the value of -MAPSMOBI\_USE\_SRCS\_GLOBAL matters! If the value of this variable is equal to -GLOBAL then call to MAPSMOBI\_SRCS() macro behaves like call to -GLOBAL\_SRCS() macro otherwise the value of MAPSMOBI\_USE\_SRCS\_GLOBAL is -treated as a file name and a call to MAPSMOBI\_SRCS() macro behaves like a +###### Macro [MAPSMOBI\_SRCS][](filenames...) _# internal_ <a name="macro_MAPSMOBI_SRCS"></a> +Make all source files listed as GLOBAL or not (depending on the value of +MAPSMOBI\_USE\_SRCS\_GLOBAL). Be careful since the value of +MAPSMOBI\_USE\_SRCS\_GLOBAL matters! If the value of this variable is equal to +GLOBAL then call to MAPSMOBI\_SRCS() macro behaves like call to +GLOBAL\_SRCS() macro otherwise the value of MAPSMOBI\_USE\_SRCS\_GLOBAL is +treated as a file name and a call to MAPSMOBI\_SRCS() macro behaves like a call to SRCS() macro with additional argument which is the value of -MAPSMOBI\_USE\_SRCS\_GLOBAL variable - +MAPSMOBI\_USE\_SRCS\_GLOBAL variable + ###### Macro [MAPS\_GARDEN\_COLLECT\_MODULE\_TRAITS][](varnamei dir) _# internal_ <a name="macro_MAPS_GARDEN_COLLECT_MODULE_TRAITS"></a> This macro is strictly prohibited to use outside of maps/garden project @@ -2076,19 +2076,19 @@ Warpper for MAPKITIDL macro which is used for mobile mapkit build ###### Macro [MAPS\_IDL\_SRCS][](filenames...) _# internal_ <a name="macro_MAPS_IDL_SRCS"></a> Warpper for MAPKITIDL macro which is used for mobile mapkit build -###### Macro [MASMFLAGS][](compiler flags) <a name="macro_MASMFLAGS"></a> -Add the specified flags to the compilation command of .masm files. - -###### Macro [MAVEN\_GROUP\_ID][](group\_id\_for\_maven\_export) <a name="macro_MAVEN_GROUP_ID"></a> -Set maven export group id for JAVA\_PROGRAM() and JAVA\_LIBRARY(). -Have no effect on regular build. - -###### Macro [MESSAGE][]([severity] message) _# builtin_ <a name="macro_MESSAGE"></a> -Print message with given severity level (STATUS, FATAL\_ERROR) - -###### Macro [METAQUERYFILES][](filenames...) _#deprecated_ <a name="macro_METAQUERYFILES"></a> +###### Macro [MASMFLAGS][](compiler flags) <a name="macro_MASMFLAGS"></a> +Add the specified flags to the compilation command of .masm files. + +###### Macro [MAVEN\_GROUP\_ID][](group\_id\_for\_maven\_export) <a name="macro_MAVEN_GROUP_ID"></a> +Set maven export group id for JAVA\_PROGRAM() and JAVA\_LIBRARY(). +Have no effect on regular build. + +###### Macro [MESSAGE][]([severity] message) _# builtin_ <a name="macro_MESSAGE"></a> +Print message with given severity level (STATUS, FATAL\_ERROR) + +###### Macro [METAQUERYFILES][](filenames...) _#deprecated_ <a name="macro_METAQUERYFILES"></a> This macro does nothing and will be removed - + ###### Macro [MOBILE\_TEST\_APK\_AAR\_AARS][](filenames...) _# internal_ <a name="macro_MOBILE_TEST_APK_AAR_AARS"></a> Not documented yet. @@ -2108,19 +2108,19 @@ Not documented yet. Add the specified flags to the compilation line of C/C++files. Flags apply only if the compiler used is MSVC (cl.exe) -###### Macro [MX\_FORMULAS][](BinFiles...) _# deprecated, matrixnet_ <a name="macro_MX_FORMULAS"></a> -Create MatrixNet formulas archive - -###### Macro [NEED\_CHECK][]() <a name="macro_NEED_CHECK"></a> -Commits to the project marked with this macro will be blocked by pre-commit check and then will be -automatically merged to trunk only if there is no new broken build targets in check results. -The use of this macro is disabled by default. - -###### Macro [NEED\_REVIEW][]() _# deprecated_ <a name="macro_NEED_REVIEW"></a> -Mark the project as needing review. -Reviewers are listed in the macro OWNER. The use of this macro is disabled by default. -Details can be found here: https://clubs.at.yandex-team.ru/arcadia/6104 - +###### Macro [MX\_FORMULAS][](BinFiles...) _# deprecated, matrixnet_ <a name="macro_MX_FORMULAS"></a> +Create MatrixNet formulas archive + +###### Macro [NEED\_CHECK][]() <a name="macro_NEED_CHECK"></a> +Commits to the project marked with this macro will be blocked by pre-commit check and then will be +automatically merged to trunk only if there is no new broken build targets in check results. +The use of this macro is disabled by default. + +###### Macro [NEED\_REVIEW][]() _# deprecated_ <a name="macro_NEED_REVIEW"></a> +Mark the project as needing review. +Reviewers are listed in the macro OWNER. The use of this macro is disabled by default. +Details can be found here: https://clubs.at.yandex-team.ru/arcadia/6104 + ###### Macro [NGINX\_MODULES][](Modules...) <a name="macro_NGINX_MODULES"></a> Not documented yet. @@ -2129,27 +2129,27 @@ Materializes `node\_modules.tar` bundle according to the module's lockfile. @see [NPM\_CONTRIBS()](#module\_NPM\_CONTRIBS) -###### Macro [NO\_BUILD\_IF][](variables) _# builtin_ <a name="macro_NO_BUILD_IF"></a> -Print warning if some variable is true - -###### Macro [NO\_CHECK\_IMPORTS][]([patterns]) <a name="macro_NO_CHECK_IMPORTS"></a> -Do not run checks on imports of Python modules. -Optional parameter mask patterns describes the names of the modules that do not need to check. - -###### Macro [NO\_CLANG\_COVERAGE][]() <a name="macro_NO_CLANG_COVERAGE"></a> -Disable heavyweight clang coverage for the module - +###### Macro [NO\_BUILD\_IF][](variables) _# builtin_ <a name="macro_NO_BUILD_IF"></a> +Print warning if some variable is true + +###### Macro [NO\_CHECK\_IMPORTS][]([patterns]) <a name="macro_NO_CHECK_IMPORTS"></a> +Do not run checks on imports of Python modules. +Optional parameter mask patterns describes the names of the modules that do not need to check. + +###### Macro [NO\_CLANG\_COVERAGE][]() <a name="macro_NO_CLANG_COVERAGE"></a> +Disable heavyweight clang coverage for the module + ###### Macro [NO\_CLANG\_TIDY][]() <a name="macro_NO_CLANG_TIDY"></a> Not documented yet. ###### Macro [NO\_CODENAVIGATION][]() _# internal_ <a name="macro_NO_CODENAVIGATION"></a> -Disable codenaviagtion for a module. Needed to avoid PEERDIR loops in codenavigation support. -Most probably you'll never need this. If you think you need, please contact devtools@ for assistance. - -###### Macro [NO\_COMPILER\_WARNINGS][]() <a name="macro_NO_COMPILER_WARNINGS"></a> +Disable codenaviagtion for a module. Needed to avoid PEERDIR loops in codenavigation support. +Most probably you'll never need this. If you think you need, please contact devtools@ for assistance. + +###### Macro [NO\_COMPILER\_WARNINGS][]() <a name="macro_NO_COMPILER_WARNINGS"></a> Disable all compiler warnings in the module. -Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. - +Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. + ###### Macro [NO\_CPU\_CHECK][]() <a name="macro_NO_CPU_CHECK"></a> Compile module without startup CPU features check @@ -2157,9 +2157,9 @@ Compile module without startup CPU features check Disable cython and cythonized python coverage (CYTHONIZE\_PY) Implies NO\_CLANG\_COVERAGE() - right now, we can't disable instrumentation for .py.cpp files, but enable for .cpp -###### Macro [NO\_DEBUG\_INFO][]() <a name="macro_NO_DEBUG_INFO"></a> -Compile files without debug info collection. - +###### Macro [NO\_DEBUG\_INFO][]() <a name="macro_NO_DEBUG_INFO"></a> +Compile files without debug info collection. + ###### Macro [NO\_DOCTESTS][]() <a name="macro_NO_DOCTESTS"></a> Disable doctests in PY[|3|23\_]TEST @@ -2174,162 +2174,162 @@ Anyway, preferred way is to move such files into separate dir and don't use this Also see: https://docs.yandex-team.ru/ya-make/manual/python/vars#y\_python\_extended\_source\_search for details -###### Macro [NO\_JOIN\_SRC][]() _# deprecated, does-nothing_ <a name="macro_NO_JOIN_SRC"></a> +###### Macro [NO\_JOIN\_SRC][]() _# deprecated, does-nothing_ <a name="macro_NO_JOIN_SRC"></a> This macro currently does nothing. This is default behavior which cannot be overridden at module level. - -###### Macro [NO\_LIBC][]() <a name="macro_NO_LIBC"></a> -Exclude dependencies on C++ and C runtimes (including util, musl and libeatmydata). -Note: use this with care. libc most likely will be linked into executable anyway, -so using libc headers/functions may not be detected at build time and may lead to unpredictable behavors at configure time. - -###### Macro [NO\_LINT][]() <a name="macro_NO_LINT"></a> -Do not check for style files included in PY\_SRCS, TEST\_SRCS, JAVA\_SRCS. - + +###### Macro [NO\_LIBC][]() <a name="macro_NO_LIBC"></a> +Exclude dependencies on C++ and C runtimes (including util, musl and libeatmydata). +Note: use this with care. libc most likely will be linked into executable anyway, +so using libc headers/functions may not be detected at build time and may lead to unpredictable behavors at configure time. + +###### Macro [NO\_LINT][]() <a name="macro_NO_LINT"></a> +Do not check for style files included in PY\_SRCS, TEST\_SRCS, JAVA\_SRCS. + ###### Macro [NO\_MYPY][]() <a name="macro_NO_MYPY"></a> Not documented yet. -###### Macro [NO\_NEED\_CHECK][]() <a name="macro_NO_NEED_CHECK"></a> -Commits to the project marked with this macro will not be affected by higher-level NEED\_CHECK macro. - -###### Macro [NO\_OPTIMIZE][]() <a name="macro_NO_OPTIMIZE"></a> -Build code without any optimizations (-O0 mode). - +###### Macro [NO\_NEED\_CHECK][]() <a name="macro_NO_NEED_CHECK"></a> +Commits to the project marked with this macro will not be affected by higher-level NEED\_CHECK macro. + +###### Macro [NO\_OPTIMIZE][]() <a name="macro_NO_OPTIMIZE"></a> +Build code without any optimizations (-O0 mode). + ###### Macro [NO\_OPTIMIZE\_PY\_PROTOS][]() <a name="macro_NO_OPTIMIZE_PY_PROTOS"></a> -Disable Python proto optimization using embedding corresponding C++ code into binary. -Python protobuf runtime will use C++ implementation instead of Python one if former is available. -This is default mode only for some system libraries. - -###### Macro [NO\_PLATFORM][]() <a name="macro_NO_PLATFORM"></a> -Exclude dependencies on C++ and C runtimes (including util, musl and libeatmydata) and set NO\_PLATFORM variable for special processing. -Note: use this with care. libc most likely will be linked into executable anyway, -so using libc headers/functions may not be detected at build time and may lead to unpredictable behavors at configure time. - +Disable Python proto optimization using embedding corresponding C++ code into binary. +Python protobuf runtime will use C++ implementation instead of Python one if former is available. +This is default mode only for some system libraries. + +###### Macro [NO\_PLATFORM][]() <a name="macro_NO_PLATFORM"></a> +Exclude dependencies on C++ and C runtimes (including util, musl and libeatmydata) and set NO\_PLATFORM variable for special processing. +Note: use this with care. libc most likely will be linked into executable anyway, +so using libc headers/functions may not be detected at build time and may lead to unpredictable behavors at configure time. + ###### Macro [NO\_PLATFORM\_RESOURCES][]() _# internal_ <a name="macro_NO_PLATFORM_RESOURCES"></a> Exclude dependency on platform resources libraries. -Most probably you'll never need this. If you think you need, please contact devtools@ for assistance. - +Most probably you'll never need this. If you think you need, please contact devtools@ for assistance. + ###### Macro [NO\_PYTHON\_COVERAGE][]() <a name="macro_NO_PYTHON_COVERAGE"></a> Disable python coverage for module -###### Macro [NO\_PYTHON\_INCLUDES][]() _# internal_ <a name="macro_NO_PYTHON_INCLUDES"></a> -Disable dependencies on libraries providing Python headers. -This is only used in Python libraries themselves to avoid PEERDIR loops. - -###### Macro [NO\_RUNTIME][]() <a name="macro_NO_RUNTIME"></a> -This macro: -1. Sets the ENABLE(NOUTIL) + DISABLE(USE\_INTERNAL\_STL); -2. If the project that contains the macro NO\_RUNTIME(), peerdir-it project does not contain NO\_RUNTIME() => Warning. -Note: use this with care. Arcadia STL most likely will be linked into executable anyway, so using STL headers/functions/classes -may not be detected at build time and may lead to unpredictable behavors at configure time. - -###### Macro [NO\_SANITIZE][]() <a name="macro_NO_SANITIZE"></a> -Disable all sanitizers for the module. - -###### Macro [NO\_SANITIZE\_COVERAGE][]() <a name="macro_NO_SANITIZE_COVERAGE"></a> -Disable lightweight coverage (-fsanitize-coverage) for the module. - -###### Macro [NO\_SSE4][]() <a name="macro_NO_SSE4"></a> -Compile module without SSE4 - -###### Macro [NO\_UTIL][]() <a name="macro_NO_UTIL"></a> -Build module without dependency on util. -Note: use this with care. Util most likely will be linked into executable anyway, -so using util headers/functions/classes may not be detected at build time and may lead to unpredictable behavors at configure time. - -###### Macro [NO\_WERROR][]() <a name="macro_NO_WERROR"></a> -Override WERROR() behavior -Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. - -###### Macro [NO\_WSHADOW][]() <a name="macro_NO_WSHADOW"></a> -Disable C++ shadowing warnings. - +###### Macro [NO\_PYTHON\_INCLUDES][]() _# internal_ <a name="macro_NO_PYTHON_INCLUDES"></a> +Disable dependencies on libraries providing Python headers. +This is only used in Python libraries themselves to avoid PEERDIR loops. + +###### Macro [NO\_RUNTIME][]() <a name="macro_NO_RUNTIME"></a> +This macro: +1. Sets the ENABLE(NOUTIL) + DISABLE(USE\_INTERNAL\_STL); +2. If the project that contains the macro NO\_RUNTIME(), peerdir-it project does not contain NO\_RUNTIME() => Warning. +Note: use this with care. Arcadia STL most likely will be linked into executable anyway, so using STL headers/functions/classes +may not be detected at build time and may lead to unpredictable behavors at configure time. + +###### Macro [NO\_SANITIZE][]() <a name="macro_NO_SANITIZE"></a> +Disable all sanitizers for the module. + +###### Macro [NO\_SANITIZE\_COVERAGE][]() <a name="macro_NO_SANITIZE_COVERAGE"></a> +Disable lightweight coverage (-fsanitize-coverage) for the module. + +###### Macro [NO\_SSE4][]() <a name="macro_NO_SSE4"></a> +Compile module without SSE4 + +###### Macro [NO\_UTIL][]() <a name="macro_NO_UTIL"></a> +Build module without dependency on util. +Note: use this with care. Util most likely will be linked into executable anyway, +so using util headers/functions/classes may not be detected at build time and may lead to unpredictable behavors at configure time. + +###### Macro [NO\_WERROR][]() <a name="macro_NO_WERROR"></a> +Override WERROR() behavior +Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. + +###### Macro [NO\_WSHADOW][]() <a name="macro_NO_WSHADOW"></a> +Disable C++ shadowing warnings. + ###### Macro [NVCC\_DEVICE\_LINK][](file.cu...) <a name="macro_NVCC_DEVICE_LINK"></a> Run nvcc --device-link on objects compiled from srcs with --device-c. This generates a stub object devlink.o that supplies missing pieces for the host linker to link relocatable device objects into the final executable. -###### Macro [ONLY\_TAGS][](tags...) _# builtin_ <a name="macro_ONLY_TAGS"></a> -Instantiate from multimodule only variants with tags listed - +###### Macro [ONLY\_TAGS][](tags...) _# builtin_ <a name="macro_ONLY_TAGS"></a> +Instantiate from multimodule only variants with tags listed + ###### Macro [OPENSOURCE\_EXPORT\_REPLACEMENT][](CMAKE PkgName CMAKE\_TARGET PkgName::PkgTarget CONAN ConanRef CMAKE\_COMPONENT OptCmakePkgComponent) <a name="macro_OPENSOURCE_EXPORT_REPLACEMENT"></a> Use specified conan/system pacakcge when exporting cmake build scripts for arcadia C++ project for opensource publication. -###### Macro [OPTIMIZE\_PY\_PROTOS][]() _# internal_ <a name="macro_OPTIMIZE_PY_PROTOS"></a> -Enable Python proto optimization by embedding corresponding C++ code into binary. -Python protobuf runtime will use C++ implementation instead of Python one if former is available. +###### Macro [OPTIMIZE\_PY\_PROTOS][]() _# internal_ <a name="macro_OPTIMIZE_PY_PROTOS"></a> +Enable Python proto optimization by embedding corresponding C++ code into binary. +Python protobuf runtime will use C++ implementation instead of Python one if former is available. This is default mode for most PROTO\_LIBRARY's and PY2\_LIBRARY's, some system ones being exceptions. - + ###### Macro [ORIGINAL\_SOURCE][](Source) <a name="macro_ORIGINAL_SOURCE"></a> This macro specifies the source repository for contrib Does nothing now (just a placeholder for future functionality) See https://st.yandex-team.ru/DTCC-316 -###### Macro [OWNER][](owners...) _# builtin_ <a name="macro_OWNER"></a> -Add reviewers/responsibles of the code. -In the OWNER macro you can use: -1. login-s from staff.yandex-team.ru -2. Review group (to specify the Code-review group need to use the prefix g:) - -Ask devtools@yandex-team.ru if you need more information - -###### Macro [PACK][](archive\_type) <a name="macro_PACK"></a> +###### Macro [OWNER][](owners...) _# builtin_ <a name="macro_OWNER"></a> +Add reviewers/responsibles of the code. +In the OWNER macro you can use: +1. login-s from staff.yandex-team.ru +2. Review group (to specify the Code-review group need to use the prefix g:) + +Ask devtools@yandex-team.ru if you need more information + +###### Macro [PACK][](archive\_type) <a name="macro_PACK"></a> When placed inside the PACKAGE module, packs the build results tree to the archive with specified extension. Currently supported extensions are `tar` and `tar.gz` - + Is not allowed other module types than PACKAGE(). @see: [PACKAGE()](#module\_PACKAGE) -###### Macro [PACKAGE\_STRICT][]() <a name="macro_PACKAGE_STRICT"></a> -Not documented yet. - +###### Macro [PACKAGE\_STRICT][]() <a name="macro_PACKAGE_STRICT"></a> +Not documented yet. + ###### Macro [PACK\_GLOBALS\_IN\_LIBRARY][]() <a name="macro_PACK_GLOBALS_IN_LIBRARY"></a> Not documented yet. -###### Macro [PARTITIONED\_RECURSE][]([BALANCING\_CONFIG config] [LOCAL] dirs...) _# builtin_ <a name="macro_PARTITIONED_RECURSE"></a> -Add directories to the build -All projects must be reachable from the root chain RECURSE() for monorepo continuous integration functionality. -Arguments are processed in chunks - -###### Macro [PARTITIONED\_RECURSE\_FOR\_TESTS][]([BALANCING\_CONFIG config] [LOCAL] dirs...) _# builtin_ <a name="macro_PARTITIONED_RECURSE_FOR_TESTS"></a> -Add directories to the build if tests are demanded. -Arguments are processed in chunks - -###### Macro [PARTITIONED\_RECURSE\_ROOT\_RELATIVE][]([BALANCING\_CONFIG config] dirlist) _# builtin_ <a name="macro_PARTITIONED_RECURSE_ROOT_RELATIVE"></a> -In comparison with RECURSE(), in dirlist there must be a directory relative to the root (${ARCADIA\_ROOT}). -Arguments are processed in chunks - -###### Macro [PEERDIR][](dirs...) _# builtin_ <a name="macro_PEERDIR"></a> -Specify project dependencies -Indicates that the project depends on all of the projects from the list of dirs. -Libraries from these directories will be collected and linked to the current target if the target is executable or sharedlib/dll. -If the current target is a static library, the specified directories will not be built, but they will be linked to any executable target that will link the current library. -@params: +###### Macro [PARTITIONED\_RECURSE][]([BALANCING\_CONFIG config] [LOCAL] dirs...) _# builtin_ <a name="macro_PARTITIONED_RECURSE"></a> +Add directories to the build +All projects must be reachable from the root chain RECURSE() for monorepo continuous integration functionality. +Arguments are processed in chunks + +###### Macro [PARTITIONED\_RECURSE\_FOR\_TESTS][]([BALANCING\_CONFIG config] [LOCAL] dirs...) _# builtin_ <a name="macro_PARTITIONED_RECURSE_FOR_TESTS"></a> +Add directories to the build if tests are demanded. +Arguments are processed in chunks + +###### Macro [PARTITIONED\_RECURSE\_ROOT\_RELATIVE][]([BALANCING\_CONFIG config] dirlist) _# builtin_ <a name="macro_PARTITIONED_RECURSE_ROOT_RELATIVE"></a> +In comparison with RECURSE(), in dirlist there must be a directory relative to the root (${ARCADIA\_ROOT}). +Arguments are processed in chunks + +###### Macro [PEERDIR][](dirs...) _# builtin_ <a name="macro_PEERDIR"></a> +Specify project dependencies +Indicates that the project depends on all of the projects from the list of dirs. +Libraries from these directories will be collected and linked to the current target if the target is executable or sharedlib/dll. +If the current target is a static library, the specified directories will not be built, but they will be linked to any executable target that will link the current library. +@params: 1. As arguments PEERDIR you can only use the LIBRARY directory (the directory with the PROGRAM/DLL and derived from them are prohibited to use as arguments PEERDIR). -2. ADDINCL Keyword ADDINCL (written before the specified directory), adds the flag -I<path to library> the flags to compile the source code of the current project. -Perhaps it may be removed in the future (in favor of a dedicated ADDINCL) - +2. ADDINCL Keyword ADDINCL (written before the specified directory), adds the flag -I<path to library> the flags to compile the source code of the current project. +Perhaps it may be removed in the future (in favor of a dedicated ADDINCL) + ###### Macro [PIRE\_INLINE][](FILES...) <a name="macro_PIRE_INLINE"></a> Not documented yet. - + ###### Macro [PIRE\_INLINE\_CMD][](SRC) <a name="macro_PIRE_INLINE_CMD"></a> Not documented yet. - + ###### Macro [PRIMARY\_OUTPUT][]\_VALUE(Output) _# internal_ <a name="macro_PRIMARY_OUTPUT"></a> The use of this module is strictly prohibited!!! -###### Macro [PRINT\_MODULE\_TYPE][] <a name="macro_PRINT_MODULE_TYPE"></a> -Not documented yet. - -###### Macro [PROCESS\_DOCS][] <a name="macro_PROCESS_DOCS"></a> -Not documented yet. - +###### Macro [PRINT\_MODULE\_TYPE][] <a name="macro_PRINT_MODULE_TYPE"></a> +Not documented yet. + +###### Macro [PROCESS\_DOCS][] <a name="macro_PROCESS_DOCS"></a> +Not documented yet. + ###### Macro PROGURAD\_RULES(ProguardRuleFiles...) <a name="macro_PROGUARD_RULES"></a> This macro is strictly prohibited to use outside of mapsmobi project -###### Macro [PROTO2FBS][](InputProto) <a name="macro_PROTO2FBS"></a> +###### Macro [PROTO2FBS][](InputProto) <a name="macro_PROTO2FBS"></a> Produce flatbuf schema out of protobuf description. - + ###### Macro [PROTO\_ADDINCL][]([GLOBAL] [WITH\_GEN] Path) <a name="macro_PROTO_ADDINCL"></a> This macro introduces proper ADDINCLs for .proto-files found in sources and .cpp/.h generated files, supplying them to appropriate commands and allowing @@ -2349,29 +2349,29 @@ PROTO\_LIBRARY with PROTO\_NAMESPACE(GLOBAL ) is enough at user side to correctl If generated .proto files are going to be used for building a module than use of WITH\_GEN parameter will add appropriate dir from the build root for .proto files search. -###### Macro [PROVIDES][](Name...) <a name="macro_PROVIDES"></a> -Specifies provided features. The names must be correct C identifiers. -This prevents different libraries providing the same features to be linked into one program. - +###### Macro [PROVIDES][](Name...) <a name="macro_PROVIDES"></a> +Specifies provided features. The names must be correct C identifiers. +This prevents different libraries providing the same features to be linked into one program. + ###### Macro [PYTHON][](script\_path args... [CWD dir] [ENV key=value...] [TOOL tools...] [IN inputs...] [OUT[\_NOAUTO] outputs...] [STDOUT[\_NOAUTO] output] [OUTPUT\_INCLUDES output\_includes...] [REQUIREMENTS reqs]) <a name="macro_PYTHON"></a> Run a python script with $(PYTHON)/python built from devtools/huge\_python. These macros are similar: RUN\_PROGRAM, LUA, PYTHON. - -Parameters: -- script\_path - Path to the script. -- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. -- CWD dir - Absolute path of the working directory. -- ENV key=value... - Environment variables. -- TOOL tools... - Auxiliary tool directories. -- IN inputs... - Input files. -- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. -- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. -- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. + +Parameters: +- script\_path - Path to the script. +- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. +- CWD dir - Absolute path of the working directory. +- ENV key=value... - Environment variables. +- TOOL tools... - Auxiliary tool directories. +- IN inputs... - Input files. +- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. +- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. +- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. - REQUIREMENTS - Override default requirements for CPU and RAM - -For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or -${CURDIR} and ${BINDIR} which are expanded where the outputs are used. - + +For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or +${CURDIR} and ${BINDIR} which are expanded where the outputs are used. + ###### Macro [PYTHON2\_ADDINCL][]() <a name="macro_PYTHON2_ADDINCL"></a> This macro adds include path for Python headers (Python 2.x variant) without PEERDIR. This should be used in 2 cases only: @@ -2383,35 +2383,35 @@ Never use this macro in PY2\_PROGRAM, PY2\_LIBRARY and PY23\_LIBRARY: they have Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs -###### Macro [PYTHON2\_MODULE][]() <a name="macro_PYTHON2_MODULE"></a> -Use in PY\_ANY\_MODULE to set it up for Python 2.x. - -###### Macro [PYTHON3\_ADDINCL][]() <a name="macro_PYTHON3_ADDINCL"></a> -This macro adds include path for Python headers (Python 3.x variant). -This should be used in 2 cases only: +###### Macro [PYTHON2\_MODULE][]() <a name="macro_PYTHON2_MODULE"></a> +Use in PY\_ANY\_MODULE to set it up for Python 2.x. + +###### Macro [PYTHON3\_ADDINCL][]() <a name="macro_PYTHON3_ADDINCL"></a> +This macro adds include path for Python headers (Python 3.x variant). +This should be used in 2 cases only: - In PY2MODULE since it compiles into .so and uses external Python runtime; -- In system Python libraries themselves since peerdir there may create a loop; -In all other cases use USE\_PYTHON3() macro instead. - -Never use this macro in PY3\_PROGRAM and PY3\_LIBRARY and PY23\_LIBRARY: they have everything by default. - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs - -###### Macro [PYTHON3\_MODULE][]() <a name="macro_PYTHON3_MODULE"></a> -Use in PY\_ANY\_MODULE to set it up for Python 3.x. - -###### Macro [PYTHON\_PATH][](Path) <a name="macro_PYTHON_PATH"></a> -Set path to Python that will be used to runs scripts in tests - +- In system Python libraries themselves since peerdir there may create a loop; +In all other cases use USE\_PYTHON3() macro instead. + +Never use this macro in PY3\_PROGRAM and PY3\_LIBRARY and PY23\_LIBRARY: they have everything by default. + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs + +###### Macro [PYTHON3\_MODULE][]() <a name="macro_PYTHON3_MODULE"></a> +Use in PY\_ANY\_MODULE to set it up for Python 3.x. + +###### Macro [PYTHON\_PATH][](Path) <a name="macro_PYTHON_PATH"></a> +Set path to Python that will be used to runs scripts in tests + ###### Macro [PY\_CONSTRUCTOR][](package.module[:func]) <a name="macro_PY_CONSTRUCTOR"></a> Specifies the module or function which will be started before python's main() init() is expected in the target module if no function is specified Can be considered as \_\_attribute\_\_((constructor)) for python -###### Macro PY\_DOCTEST(Packages...) <a name="macro_PY_DOCTESTS"></a> -Add to the test doctests for specified Python packages -The packages should be part of a test (listed as sources of the test or its PEERDIRs). - +###### Macro PY\_DOCTEST(Packages...) <a name="macro_PY_DOCTESTS"></a> +Add to the test doctests for specified Python packages +The packages should be part of a test (listed as sources of the test or its PEERDIRs). + ###### Macro [PY\_ENUMS\_SERIALIZATION][] <a name="macro_PY_ENUMS_SERIALIZATION"></a> Not documented yet. @@ -2419,19 +2419,19 @@ Not documented yet. Add extra Python files for linting. This macro allows adding Python files which has no .py extension. -###### Macro [PY\_MAIN][](package.module[:func]) <a name="macro_PY_MAIN"></a> -Specifies the module or function from which to start executing a python program - -Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#modulipyprogrampy3programimakrospymain - -###### Macro [PY\_NAMESPACE][](prefix) <a name="macro_PY_NAMESPACE"></a> -Sets default Python namespace for all python sources in the module. -Especially suitable in PROTO\_LIBRARY where Python sources are generated and there is no PY\_SRCS to place NAMESPACE parameter. - -###### Macro [PY\_PROTOS\_FOR][](path/to/module) _#builtin, deprecated_ <a name="macro_PY_PROTOS_FOR"></a> -Use PROTO\_LIBRARY() in order to have .proto compiled into Python. -Generates pb2.py files out of .proto files and saves those into PACKAGE module - +###### Macro [PY\_MAIN][](package.module[:func]) <a name="macro_PY_MAIN"></a> +Specifies the module or function from which to start executing a python program + +Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#modulipyprogrampy3programimakrospymain + +###### Macro [PY\_NAMESPACE][](prefix) <a name="macro_PY_NAMESPACE"></a> +Sets default Python namespace for all python sources in the module. +Especially suitable in PROTO\_LIBRARY where Python sources are generated and there is no PY\_SRCS to place NAMESPACE parameter. + +###### Macro [PY\_PROTOS\_FOR][](path/to/module) _#builtin, deprecated_ <a name="macro_PY_PROTOS_FOR"></a> +Use PROTO\_LIBRARY() in order to have .proto compiled into Python. +Generates pb2.py files out of .proto files and saves those into PACKAGE module + ###### Macro [PY\_PROTO\_PLUGIN][](Name Ext Tool DEPS <Dependencies>) <a name="macro_PY_PROTO_PLUGIN"></a> Define protoc plugin for python with given Name that emits extra output with provided Extension using Tool. Extra dependencies are passed via DEPS @@ -2441,45 +2441,45 @@ Define protoc plugin for python with given Name that emits 2 extra outputs with using Tool. Extra dependencies are passed via DEPS ###### Macro [PY\_REGISTER][]([package.]module\_name) <a name="macro_PY_REGISTER"></a> -Python knows about which built-ins can be imported, due to their registration in the Assembly or at the start of the interpreter. -All modules from the sources listed in PY\_SRCS() are registered automatically. -To register the modules from the sources in the SRCS(), you need to use PY\_REGISTER(). - -PY\_REGISTER(module\_name) initializes module globally via call to initmodule\_name() +Python knows about which built-ins can be imported, due to their registration in the Assembly or at the start of the interpreter. +All modules from the sources listed in PY\_SRCS() are registered automatically. +To register the modules from the sources in the SRCS(), you need to use PY\_REGISTER(). + +PY\_REGISTER(module\_name) initializes module globally via call to initmodule\_name() PY\_REGISTER(package.module\_name) initializes module in the specified package It renames its init function with CFLAGS(-Dinitmodule\_name=init7package11module\_name) or CFLAGS(-DPyInit\_module\_name=PyInit\_7package11module\_name) - -Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#makrospyregister - + +Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#makrospyregister + ###### Macro [PY\_REQUIREMENTS][]([cpu: <value>] [ram: <value>]) <a name="macro_PY_REQUIREMENTS"></a> Override CPU and RAM requirements for all Python build commands -###### Macro [PY\_SRCS][]({| CYTHON\_C} { | TOP\_LEVEL | NAMESPACE ns} Files...) <a name="macro_PY_SRCS"></a> +###### Macro [PY\_SRCS][]({| CYTHON\_C} { | TOP\_LEVEL | NAMESPACE ns} Files...) <a name="macro_PY_SRCS"></a> Build specified Python sources according to Arcadia binary Python build. Basically creates precompiled and source resources keyed with module paths. -The resources eventually are linked into final program and can be accessed as regular Python modules. -This custom loader linked into the program will add them to sys.meta\_path. - -PY\_SRCS also support .proto, .ev, .pyx and .swg files. The .proto and .ev are compiled to .py-code by protoc and than handled as usual .py files. -.pyx and .swg lead to C/C++ Python extensions generation, that are automatically registered in Python as built-in modules. - -By default .pyx files are built as C++-extensions. Use CYTHON\_C to build them as C (similar to BUILDWITH\_CYTHON\_C, but with the ability to specify namespace). - -\_\_init\_\_.py never required, but if present (and specified in PY\_SRCS), it will be imported when you import package modules with \_\_init\_\_.py Oh. - -@example - +The resources eventually are linked into final program and can be accessed as regular Python modules. +This custom loader linked into the program will add them to sys.meta\_path. + +PY\_SRCS also support .proto, .ev, .pyx and .swg files. The .proto and .ev are compiled to .py-code by protoc and than handled as usual .py files. +.pyx and .swg lead to C/C++ Python extensions generation, that are automatically registered in Python as built-in modules. + +By default .pyx files are built as C++-extensions. Use CYTHON\_C to build them as C (similar to BUILDWITH\_CYTHON\_C, but with the ability to specify namespace). + +\_\_init\_\_.py never required, but if present (and specified in PY\_SRCS), it will be imported when you import package modules with \_\_init\_\_.py Oh. + +@example + PY2_LIBRARY(mymodule) - PY_SRCS(a.py sub/dir/b.py e.proto sub/dir/f.proto c.pyx sub/dir/d.pyx g.swg sub/dir/h.swg) - END() - -PY\_SRCS honors Python2 and Python3 differences and adjusts itself to Python version of a current module. -PY\_SRCS can be used in any Arcadia Python build modules like PY\*\_LIBRARY, PY\*\_PROGRAM, PY\*TEST. + PY_SRCS(a.py sub/dir/b.py e.proto sub/dir/f.proto c.pyx sub/dir/d.pyx g.swg sub/dir/h.swg) + END() + +PY\_SRCS honors Python2 and Python3 differences and adjusts itself to Python version of a current module. +PY\_SRCS can be used in any Arcadia Python build modules like PY\*\_LIBRARY, PY\*\_PROGRAM, PY\*TEST. PY\_SRCS in LIBRARY or PROGRAM effectively converts these into PY2\_LIBRARY and PY2\_PROGRAM respectively. -It is strongly advised to make this conversion explicit. Never use PY\_SRCS in a LIBRARY if you plan to use it from external Python extension module. - -Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#modulipylibrarypy3libraryimakrospysrcs - +It is strongly advised to make this conversion explicit. Never use PY\_SRCS in a LIBRARY if you plan to use it from external Python extension module. + +Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#modulipylibrarypy3libraryimakrospysrcs + ###### Macro [PY\_SSQLS\_SRCS][](Srcs...) <a name="macro_PY_SSQLS_SRCS"></a> Not documented yet. @@ -2492,28 +2492,28 @@ $usage: REAL\_LINK\_EXEC\_DYN\_LIB\_IMPL(peers...) # internal ###### Macro [REAL\_LINK\_EXE\_IMPL][] <a name="macro_REAL_LINK_EXE_IMPL"></a> $usage: REAL\_LINK\_EXE\_IMPL(peers...) # internal -###### Macro [RECURSE][]([LOCAL] dirs...) _# builtin_ <a name="macro_RECURSE"></a> -Add directories to the build -All projects must be reachable from the root chain RECURSE() for monorepo continuous integration functionality - -###### Macro [RECURSE\_FOR\_TESTS][]([LOCAL] dirs...) _# builtin_ <a name="macro_RECURSE_FOR_TESTS"></a> +###### Macro [RECURSE][]([LOCAL] dirs...) _# builtin_ <a name="macro_RECURSE"></a> +Add directories to the build +All projects must be reachable from the root chain RECURSE() for monorepo continuous integration functionality + +###### Macro [RECURSE\_FOR\_TESTS][]([LOCAL] dirs...) _# builtin_ <a name="macro_RECURSE_FOR_TESTS"></a> Add directories to the build if tests are demanded. Use --force-build-depends flag if you want to build testing modules without tests running - -###### Macro [RECURSE\_ROOT\_RELATIVE][](dirlist) _# builtin_ <a name="macro_RECURSE_ROOT_RELATIVE"></a> -In comparison with RECURSE(), in dirlist there must be a directory relative to the root (${ARCADIA\_ROOT}) - + +###### Macro [RECURSE\_ROOT\_RELATIVE][](dirlist) _# builtin_ <a name="macro_RECURSE_ROOT_RELATIVE"></a> +In comparison with RECURSE(), in dirlist there must be a directory relative to the root (${ARCADIA\_ROOT}) + ###### Macro [REGISTER\_SANDBOX\_IMPORT][] <a name="macro_REGISTER_SANDBOX_IMPORT"></a> Not documented yet. -###### Macro [REGISTER\_YQL\_PYTHON\_UDF][] <a name="macro_REGISTER_YQL_PYTHON_UDF"></a> -Not documented yet. - -###### Macro [REQUIREMENTS][]([cpu:<count>] [disk\_usage:<size>] [ram:<size>] [ram\_disk:<size>] [container:<id>] [network:<restricted|full>] [dns:dns64]) <a name="macro_REQUIREMENTS"></a> -Allows you to specify the requirements of the test. - -Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ - +###### Macro [REGISTER\_YQL\_PYTHON\_UDF][] <a name="macro_REGISTER_YQL_PYTHON_UDF"></a> +Not documented yet. + +###### Macro [REQUIREMENTS][]([cpu:<count>] [disk\_usage:<size>] [ram:<size>] [ram\_disk:<size>] [container:<id>] [network:<restricted|full>] [dns:dns64]) <a name="macro_REQUIREMENTS"></a> +Allows you to specify the requirements of the test. + +Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ + ###### Macro [REQUIRES][](dirs...) <a name="macro_REQUIRES"></a> Specify list of dirs which this module must depend on indirectly. @@ -2532,43 +2532,43 @@ to be addressed by either ADDINCLs or marking them as TEXT. Please contact devto Add data (resources, random files, strings) to the program) The common usage is to place Src file into binary. The Key is used to access it using library/cpp/resource or library/python/resource. Alternative syntax with '- Key=Value' allows placing Value string as resource data into binary and make it accessible by Key. - -This is a simpler but less flexible option than ARCHIVE(), because in the case of ARCHIVE(), you have to use the data explicitly, + +This is a simpler but less flexible option than ARCHIVE(), because in the case of ARCHIVE(), you have to use the data explicitly, and in the case of RESOURCE(), the data will fall through SRCS() or SRCS(GLOBAL) to binary linking. - + Use the FORCE\_TEXT parameter to explicitly mark all Src files as text files: they will not be parsed unless used elsewhere. -@example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a2ispolzujjtekomanduresource - -@example: - - LIBRARY() +@example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a2ispolzujjtekomanduresource + +@example: + + LIBRARY() OWNER(user1) - + RESOURCE( path/to/file1 /key/in/program/1 path/to/file2 /key2 ) - END() - + END() + ###### Macro [RESOURCE\_FILES][]([DONT\_PARSE] [PREFIX {prefix}] [STRIP prefix\_to\_strip] {path}) <a name="macro_RESOURCE_FILES"></a> This macro expands into RESOURCE([DONT\_PARSE] {path} resfs/file/{prefix}{path} - resfs/src/resfs/file/{prefix}{remove\_prefix(path, prefix\_to\_strip)}={rootrel\_arc\_src(path)} -) - -resfs/src/{key} stores a source root (or build root) relative path of the -source of the value of the {key} resource. - -resfs/file/{key} stores any value whose source was a file on a filesystem. -resfs/src/resfs/file/{key} must store its path. - +) + +resfs/src/{key} stores a source root (or build root) relative path of the +source of the value of the {key} resource. + +resfs/file/{key} stores any value whose source was a file on a filesystem. +resfs/src/resfs/file/{key} must store its path. + DONT\_PARSE disables parsing for source code files (determined by extension) Please don't abuse: use separate DONT\_PARSE macro call only for files subject to parsing -This form is for use from other plugins: -RESOURCE\_FILES([DEST {dest}] {path}) expands into RESOURCE({path} resfs/file/{dest}) - +This form is for use from other plugins: +RESOURCE\_FILES([DEST {dest}] {path}) expands into RESOURCE({path} resfs/file/{dest}) + @see: https://wiki.yandex-team.ru/devtools/commandsandvars/resourcefiles/ ###### Macro [RESTRICT\_LICENSES][](ALLOW\_ONLY|DENY LicenseProperty...) <a name="macro_RESTRICT_LICENSES"></a> @@ -2585,18 +2585,18 @@ All macro invocation for the same module must use same constraints type (DENY or ###### Macro [RESTRICT\_PATH][] <a name="macro_RESTRICT_PATH"></a> Not documented yet. -###### Macro [RUN][] <a name="macro_RUN"></a> -Not documented yet. - +###### Macro [RUN][] <a name="macro_RUN"></a> +Not documented yet. + ###### Macro [RUN\_ANTLR][](Args...) <a name="macro_RUN_ANTLR"></a> Macro to invoke ANTLR3 generator (general case) - + ###### Macro [RUN\_ANTLR4][](Args...) <a name="macro_RUN_ANTLR4"></a> Macro to invoke ANTLR4 generator (general case) - + ###### Macro [RUN\_ANTLR4\_CPP][](GRAMMAR, OUTPUT\_INCLUDES, LISTENER, VISITOR, Args...) <a name="macro_RUN_ANTLR4_CPP"></a> Macro to invoke ANTLR4 generator (Cpp) - + ###### Macro [RUN\_ANTLR4\_GO][](GRAMMAR, OUTPUT\_INCLUDES, LISTENER, VISITOR, Args...) <a name="macro_RUN_ANTLR4_GO"></a> Macro to invoke ANTLR4 generator (Go) @@ -2604,29 +2604,29 @@ Macro to invoke ANTLR4 generator (Go) Not documented yet. ###### Macro [RUN\_PROGRAM][](tool\_path args... [CWD dir] [ENV key=value...] [TOOL tools...] [IN inputs...] [OUT[\_NOAUTO] outputs...] [STDOUT[\_NOAUTO] output] [OUTPUT\_INCLUDES output\_includes...] [REQUIREMENTS reqs]) <a name="macro_RUN_PROGRAM"></a> -Run a program from arcadia. +Run a program from arcadia. These macros are similar: RUN\_PROGRAM, LUA, PYTHON. - -Parameters: -- tool\_path - Path to the directory of the tool. -- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. -- CWD dir - Absolute path of the working directory. -- ENV key=value... - Environment variables. -- TOOL tools... - Auxiliary tool directories. + +Parameters: +- tool\_path - Path to the directory of the tool. +- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. +- CWD dir - Absolute path of the working directory. +- ENV key=value... - Environment variables. +- TOOL tools... - Auxiliary tool directories. - IN inputs... - Input files -- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. -- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. -- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. +- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. +- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. +- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. - REQUIREMENTS - Override default requirements for CPU and RAM - -For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or -${CURDIR} and ${BINDIR} which are expanded where the outputs are used. + +For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or +${CURDIR} and ${BINDIR} which are expanded where the outputs are used. Note that Tool is always built for the host platform, so be careful to provide that tool can be built for all Arcadia major host platforms (Linux, MacOS and Windows). - -###### Macro [RUN\_PYTHON][](Args...) <a name="macro_RUN_PYTHON"></a> -Version of RUN() macro to invoke Python scripts -@see: [RUN()](#macro\_RUN) - + +###### Macro [RUN\_PYTHON][](Args...) <a name="macro_RUN_PYTHON"></a> +Version of RUN() macro to invoke Python scripts +@see: [RUN()](#macro\_RUN) + ###### Macro [SDBUS\_CPP\_ADAPTOR][](File) <a name="macro_SDBUS_CPP_ADAPTOR"></a> Not documented yet. @@ -2636,137 +2636,137 @@ Not documented yet. ###### Macro [SECONDARY\_OUTPUT][](filename) _# internal_ <a name="macro_SECONDARY_OUTPUT"></a> The use of this macro is strictly prohibited!!! -###### Macro [SET][](varname value) _#builtin_ <a name="macro_SET"></a> -Sets varname to value - -###### Macro [SETUP\_EXECTEST][] <a name="macro_SETUP_EXECTEST"></a> -Not documented yet. - +###### Macro [SET][](varname value) _#builtin_ <a name="macro_SET"></a> +Sets varname to value + +###### Macro [SETUP\_EXECTEST][] <a name="macro_SETUP_EXECTEST"></a> +Not documented yet. + ###### Macro [SETUP\_PYTEST\_BIN][] <a name="macro_SETUP_PYTEST_BIN"></a> -Not documented yet. - -###### Macro [SETUP\_RUN\_PYTHON][] <a name="macro_SETUP_RUN_PYTHON"></a> -Not documented yet. - -###### Macro [SET\_APPEND][](varname appendvalue) _#builtin_ <a name="macro_SET_APPEND"></a> -Appends appendvalue to varname's value using space as a separator - -###### Macro [SET\_APPEND\_WITH\_GLOBAL][](varname appendvalue) _#builtin_ <a name="macro_SET_APPEND_WITH_GLOBAL"></a> -Appends appendvalue to varname's value using space as a separator. -New value is propagated to dependants - +Not documented yet. + +###### Macro [SETUP\_RUN\_PYTHON][] <a name="macro_SETUP_RUN_PYTHON"></a> +Not documented yet. + +###### Macro [SET\_APPEND][](varname appendvalue) _#builtin_ <a name="macro_SET_APPEND"></a> +Appends appendvalue to varname's value using space as a separator + +###### Macro [SET\_APPEND\_WITH\_GLOBAL][](varname appendvalue) _#builtin_ <a name="macro_SET_APPEND_WITH_GLOBAL"></a> +Appends appendvalue to varname's value using space as a separator. +New value is propagated to dependants + ###### Macro [SET\_COMPILE\_OUTPUTS\_MODIFIERS][](NOREL?";norel":"") <a name="macro_SET_COMPILE_OUTPUTS_MODIFIERS"></a> Not documented yet. -###### Macro [SIZE][](SMALL/MEDIUM/LARGE) <a name="macro_SIZE"></a> -Set the 'size' for the test. Each 'size' has own set of resrtictions, SMALL bein the most restricted and LARGE being the list. -See documentation on test system for more details. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [SKIP\_TEST][](Reason) <a name="macro_SKIP_TEST"></a> -Skip the suite defined by test module. Provide a reason to be output in test execution report. - +###### Macro [SIZE][](SMALL/MEDIUM/LARGE) <a name="macro_SIZE"></a> +Set the 'size' for the test. Each 'size' has own set of resrtictions, SMALL bein the most restricted and LARGE being the list. +See documentation on test system for more details. + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [SKIP\_TEST][](Reason) <a name="macro_SKIP_TEST"></a> +Skip the suite defined by test module. Provide a reason to be output in test execution report. + ###### Macro [SOURCE\_GROUP][](...) _#builtin, deprecated_ <a name="macro_SOURCE_GROUP"></a> -Ignored - -###### Macro [SPLIT\_CODEGEN][](tool prefix opts... [OUT\_NUM num] [OUTPUT\_INCLUDES output\_includes...]) <a name="macro_SPLIT_CODEGEN"></a> -Generator of a certain number of parts of the .cpp file + one header .h file from .in - -Supports keywords: -1. OUT\_NUM <the number of generated Prefix.N.cpp default 25 (N varies from 0 to 24)> -2. OUTPUT\_INCLUDES <path to files that will be included in generalnyj of macro files> - -###### Macro [SPLIT\_DWARF][]() <a name="macro_SPLIT_DWARF"></a> -Emit debug info for the PROGRAM/DLL as a separate file <module\_name>.debug. +Ignored + +###### Macro [SPLIT\_CODEGEN][](tool prefix opts... [OUT\_NUM num] [OUTPUT\_INCLUDES output\_includes...]) <a name="macro_SPLIT_CODEGEN"></a> +Generator of a certain number of parts of the .cpp file + one header .h file from .in + +Supports keywords: +1. OUT\_NUM <the number of generated Prefix.N.cpp default 25 (N varies from 0 to 24)> +2. OUTPUT\_INCLUDES <path to files that will be included in generalnyj of macro files> + +###### Macro [SPLIT\_DWARF][]() <a name="macro_SPLIT_DWARF"></a> +Emit debug info for the PROGRAM/DLL as a separate file <module\_name>.debug. NB: It does not help you to save process RSS but can add problems (see e.g. BEGEMOT-2147). - -###### Macro [SPLIT\_FACTOR][](x) <a name="macro_SPLIT_FACTOR"></a> -Sets the number of chunks for parallel run tests when used in test module with FORK\_TESTS() or FORK\_SUBTESTS(). -If none of those is specified this macro implies FORK\_TESTS(). - -Supports C++ ut and PyTest. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [SRC][](File Flags...) <a name="macro_SRC"></a> -Compile single file with extra Flags. -Compilation is driven by the last extension of the File and Flags are specific to corresponding compilation command - -###### Macro [SRCDIR][](dirlist) _# builtin_ <a name="macro_SRCDIR"></a> -Add the specified directories to the list of those in which the source files will be searched -Available only for arcadia/contrib - -###### Macro [SRCS][](<[GLOBAL] File> ...) <a name="macro_SRCS"></a> -Source files of the project. Files are built according to their extension and put int module output or fed to ultimate PROGRAM/DLL depending on GLOBAL presence. -Arcadia Paths from the root and is relative to the project's LIST are supported - -GLOBAL marks next file as direct input to link phase of the program/shared library project built into. This prevents symbols of the file to be excluded by linker as unused. + +###### Macro [SPLIT\_FACTOR][](x) <a name="macro_SPLIT_FACTOR"></a> +Sets the number of chunks for parallel run tests when used in test module with FORK\_TESTS() or FORK\_SUBTESTS(). +If none of those is specified this macro implies FORK\_TESTS(). + +Supports C++ ut and PyTest. + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [SRC][](File Flags...) <a name="macro_SRC"></a> +Compile single file with extra Flags. +Compilation is driven by the last extension of the File and Flags are specific to corresponding compilation command + +###### Macro [SRCDIR][](dirlist) _# builtin_ <a name="macro_SRCDIR"></a> +Add the specified directories to the list of those in which the source files will be searched +Available only for arcadia/contrib + +###### Macro [SRCS][](<[GLOBAL] File> ...) <a name="macro_SRCS"></a> +Source files of the project. Files are built according to their extension and put int module output or fed to ultimate PROGRAM/DLL depending on GLOBAL presence. +Arcadia Paths from the root and is relative to the project's LIST are supported + +GLOBAL marks next file as direct input to link phase of the program/shared library project built into. This prevents symbols of the file to be excluded by linker as unused. The scope of the GLOBAL keyword is the following file (that is, in the case of SRCS(GLOBAL foo.cpp bar.cpp) global will be only foo.cpp) - -@example: - - LIBRARY(test_global) - SRCS(GLOBAL foo.cpp) - END() - -This will produce foo.o and feed it to any PROGRAM/DLL module transitively depending on test\_global library. The library itself will be empty and won't produce .a file. - -###### Macro [SRC\_CPP\_AVX][](File Flags...) <a name="macro_SRC_CPP_AVX"></a> -Compile single .cpp-file with AVX and extra Flags. - -###### Macro [SRC\_CPP\_AVX2][](File Flags...) <a name="macro_SRC_CPP_AVX2"></a> -Compile single .cpp-file with AVX2 and extra Flags. - + +@example: + + LIBRARY(test_global) + SRCS(GLOBAL foo.cpp) + END() + +This will produce foo.o and feed it to any PROGRAM/DLL module transitively depending on test\_global library. The library itself will be empty and won't produce .a file. + +###### Macro [SRC\_CPP\_AVX][](File Flags...) <a name="macro_SRC_CPP_AVX"></a> +Compile single .cpp-file with AVX and extra Flags. + +###### Macro [SRC\_CPP\_AVX2][](File Flags...) <a name="macro_SRC_CPP_AVX2"></a> +Compile single .cpp-file with AVX2 and extra Flags. + ###### Macro [SRC\_CPP\_PIC][](File Flags...) <a name="macro_SRC_CPP_PIC"></a> Compile single .c-file with -fPIC and extra Flags. -###### Macro [SRC\_CPP\_SSE2][](File Flags...) <a name="macro_SRC_CPP_SSE2"></a> -Compile single .cpp-file with SSE2 and extra Flags. - -###### Macro [SRC\_CPP\_SSE3][](File Flags...) <a name="macro_SRC_CPP_SSE3"></a> -Compile single .cpp-file with SSE3 and extra Flags. - -###### Macro [SRC\_CPP\_SSE4][](File Flags...) <a name="macro_SRC_CPP_SSE4"></a> -Compile single .cpp-file with SSE4 (SSE4.1, SSE4.2 and POPCNT) and extra Flags. - -###### Macro [SRC\_CPP\_SSE41][](File Flags...) <a name="macro_SRC_CPP_SSE41"></a> -Compile single .cpp-file with SSE4.1 and extra Flags. - -###### Macro [SRC\_CPP\_SSSE3][](File Flags...) <a name="macro_SRC_CPP_SSSE3"></a> -Compile single .cpp-file with SSSE3 and extra Flags. - -###### Macro [SRC\_C\_AVX][](File Flags...) <a name="macro_SRC_C_AVX"></a> -Compile single .c-file with AVX and extra Flags. - -###### Macro [SRC\_C\_AVX2][](File Flags...) <a name="macro_SRC_C_AVX2"></a> -Compile single .c-file with AVX2 and extra Flags. - -###### Macro [SRC\_C\_SSE2][](File Flags...) <a name="macro_SRC_C_SSE2"></a> -Compile single .c-file with SSE2 and extra Flags. - -###### Macro [SRC\_C\_SSE3][](File Flags...) <a name="macro_SRC_C_SSE3"></a> -Compile single .c-file with SSE3 and extra Flags. - -###### Macro [SRC\_C\_SSE4][](File Flags...) <a name="macro_SRC_C_SSE4"></a> -Compile single .c-file with SSE4 (SSE4.1, SSE4.2 and POPCNT) and extra Flags. - -###### Macro [SRC\_C\_SSE41][](File Flags...) <a name="macro_SRC_C_SSE41"></a> -Compile single .c-file with SSE4.1 and extra Flags. - -###### Macro [SRC\_C\_SSSE3][](File Flags...) <a name="macro_SRC_C_SSSE3"></a> -Compile single .c-file with SSSE3 and extra Flags. - +###### Macro [SRC\_CPP\_SSE2][](File Flags...) <a name="macro_SRC_CPP_SSE2"></a> +Compile single .cpp-file with SSE2 and extra Flags. + +###### Macro [SRC\_CPP\_SSE3][](File Flags...) <a name="macro_SRC_CPP_SSE3"></a> +Compile single .cpp-file with SSE3 and extra Flags. + +###### Macro [SRC\_CPP\_SSE4][](File Flags...) <a name="macro_SRC_CPP_SSE4"></a> +Compile single .cpp-file with SSE4 (SSE4.1, SSE4.2 and POPCNT) and extra Flags. + +###### Macro [SRC\_CPP\_SSE41][](File Flags...) <a name="macro_SRC_CPP_SSE41"></a> +Compile single .cpp-file with SSE4.1 and extra Flags. + +###### Macro [SRC\_CPP\_SSSE3][](File Flags...) <a name="macro_SRC_CPP_SSSE3"></a> +Compile single .cpp-file with SSSE3 and extra Flags. + +###### Macro [SRC\_C\_AVX][](File Flags...) <a name="macro_SRC_C_AVX"></a> +Compile single .c-file with AVX and extra Flags. + +###### Macro [SRC\_C\_AVX2][](File Flags...) <a name="macro_SRC_C_AVX2"></a> +Compile single .c-file with AVX2 and extra Flags. + +###### Macro [SRC\_C\_SSE2][](File Flags...) <a name="macro_SRC_C_SSE2"></a> +Compile single .c-file with SSE2 and extra Flags. + +###### Macro [SRC\_C\_SSE3][](File Flags...) <a name="macro_SRC_C_SSE3"></a> +Compile single .c-file with SSE3 and extra Flags. + +###### Macro [SRC\_C\_SSE4][](File Flags...) <a name="macro_SRC_C_SSE4"></a> +Compile single .c-file with SSE4 (SSE4.1, SSE4.2 and POPCNT) and extra Flags. + +###### Macro [SRC\_C\_SSE41][](File Flags...) <a name="macro_SRC_C_SSE41"></a> +Compile single .c-file with SSE4.1 and extra Flags. + +###### Macro [SRC\_C\_SSSE3][](File Flags...) <a name="macro_SRC_C_SSSE3"></a> +Compile single .c-file with SSSE3 and extra Flags. + ###### Macro [SRC\_RESOURCE][](Id) <a name="macro_SRC_RESOURCE"></a> Not documented yet. -###### Macro [STRIP][]() <a name="macro_STRIP"></a> -Strip debug info from a PROGRAM, DLL or TEST. -This macro doesn't work in LIBRARY's, UNION's and PACKAGE's. - -###### Macro [STRUCT\_CODEGEN][](Prefix) <a name="macro_STRUCT_CODEGEN"></a> -A special case BASE\_CODEGEN, in which the kernel/struct\_codegen/codegen\_tool tool is used. - +###### Macro [STRIP][]() <a name="macro_STRIP"></a> +Strip debug info from a PROGRAM, DLL or TEST. +This macro doesn't work in LIBRARY's, UNION's and PACKAGE's. + +###### Macro [STRUCT\_CODEGEN][](Prefix) <a name="macro_STRUCT_CODEGEN"></a> +A special case BASE\_CODEGEN, in which the kernel/struct\_codegen/codegen\_tool tool is used. + ###### Macro [STYLE][](Globs...) <a name="macro_STYLE"></a> Not documented yet. @@ -2788,39 +2788,39 @@ and tsan.supp for thread sanitizer suppressions respectively. See https://clang.llvm.org/docs/AddressSanitizer.html#suppressing-memory-leaks for details. -###### Macro [SYMLINK][](from to) <a name="macro_SYMLINK"></a> -Add symlink - -###### Macro [SYSTEM\_PROPERTIES][]([<Key Value>...] [<File Path>...]) <a name="macro_SYSTEM_PROPERTIES"></a> -List of Key,Value pairs that will be available to test via System.getProperty(). -FILE means that parst should be read from file specifies as Path. - -Documentation: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [TAG][] ([tag...]) <a name="macro_TAG"></a> -Each test can have one or more tags used to filter tests list for running. -There are also special tags affecting test behaviour, for example ya:external, sb:ssd. - -Documentation: https://wiki.yandex-team.ru/yatool/test/#obshhieponjatija - -###### Macro [TASKLET][]() <a name="macro_TASKLET"></a> -Not documented yet. - -###### Macro [TASKLET\_REG][](Name, Lang, Impl, Includes...) <a name="macro_TASKLET_REG"></a> -Not documented yet. - +###### Macro [SYMLINK][](from to) <a name="macro_SYMLINK"></a> +Add symlink + +###### Macro [SYSTEM\_PROPERTIES][]([<Key Value>...] [<File Path>...]) <a name="macro_SYSTEM_PROPERTIES"></a> +List of Key,Value pairs that will be available to test via System.getProperty(). +FILE means that parst should be read from file specifies as Path. + +Documentation: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [TAG][] ([tag...]) <a name="macro_TAG"></a> +Each test can have one or more tags used to filter tests list for running. +There are also special tags affecting test behaviour, for example ya:external, sb:ssd. + +Documentation: https://wiki.yandex-team.ru/yatool/test/#obshhieponjatija + +###### Macro [TASKLET][]() <a name="macro_TASKLET"></a> +Not documented yet. + +###### Macro [TASKLET\_REG][](Name, Lang, Impl, Includes...) <a name="macro_TASKLET_REG"></a> +Not documented yet. + ###### Macro [TASKLET\_REG\_EXT][](Name, Lang, Impl, Wrapper, Includes...) <a name="macro_TASKLET_REG_EXT"></a> Not documented yet. -###### Macro [TEST\_CWD][](path) <a name="macro_TEST_CWD"></a> -Defines working directory for test runs. Othen used in conjunction with DATA() macro. -Is only used inside of the TEST modules. - -Documentation: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [TEST\_DATA][] <a name="macro_TEST_DATA"></a> -Not documented yet. - +###### Macro [TEST\_CWD][](path) <a name="macro_TEST_CWD"></a> +Defines working directory for test runs. Othen used in conjunction with DATA() macro. +Is only used inside of the TEST modules. + +Documentation: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [TEST\_DATA][] <a name="macro_TEST_DATA"></a> +Not documented yet. + ###### Macro [TEST\_JAVA\_CLASSPATH\_CMD\_TYPE][](Type) <a name="macro_TEST_JAVA_CLASSPATH_CMD_TYPE"></a> Availible types: MANIFEST(default), COMMAND\_FILE, LIST Method for passing a classpath value to a java command line @@ -2828,37 +2828,37 @@ MANIFEST via empty jar file with manifest that cantains Class-Path attribute COMMAND\_FILE via @command\_file LIST via flat args -###### Macro [TEST\_SRCS][](Files...) <a name="macro_TEST_SRCS"></a> +###### Macro [TEST\_SRCS][](Files...) <a name="macro_TEST_SRCS"></a> In PY2TEST, PY3TEST and PY\*\_LIBRARY modules used as PY\_SRCS macro and additionally used to mine test cases to be executed by testing framework. - -Documentation: https://wiki.yandex-team.ru/yatool/test/#testynapytest - -###### Macro [TIMEOUT][](TIMEOUT) <a name="macro_TIMEOUT"></a> -Sets a timeout on test execution - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [TOUCH][](Outputs...) _# internal_ <a name="macro_TOUCH"></a> -Just introduce outputs - -###### Macro [UBERJAR][]() <a name="macro_UBERJAR"></a> + +Documentation: https://wiki.yandex-team.ru/yatool/test/#testynapytest + +###### Macro [TIMEOUT][](TIMEOUT) <a name="macro_TIMEOUT"></a> +Sets a timeout on test execution + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [TOUCH][](Outputs...) _# internal_ <a name="macro_TOUCH"></a> +Just introduce outputs + +###### Macro [UBERJAR][]() <a name="macro_UBERJAR"></a> UBERJAR is a single all-in-one jar-archive that includes all its Java dependencies (reachable PEERDIR). -It also supports shading classes inside the archive by moving them to a different package (similar to the maven-shade-plugin). -Use UBERJAR inside JAVA\_PROGRAM module. - -You can use the following macros to configure the archive: -1. UBERJAR\_HIDING\_PREFIX prefix for classes to shade (classes remain in their packages by default) +It also supports shading classes inside the archive by moving them to a different package (similar to the maven-shade-plugin). +Use UBERJAR inside JAVA\_PROGRAM module. + +You can use the following macros to configure the archive: +1. UBERJAR\_HIDING\_PREFIX prefix for classes to shade (classes remain in their packages by default) 2. UBERJAR\_HIDE\_EXCLUDE\_PATTERN exclude classes matching this patterns from shading (if enabled). -3. UBERJAR\_PATH\_EXCLUDE\_PREFIX the prefix for classes that should not get into the jar archive (all classes are placed into the archive by default) +3. UBERJAR\_PATH\_EXCLUDE\_PREFIX the prefix for classes that should not get into the jar archive (all classes are placed into the archive by default) 4. UBERJAR\_MANIFEST\_TRANSFORMER\_MAIN add ManifestResourceTransformer class to uberjar processing and specify main-class 5. UBERJAR\_MANIFEST\_TRANSFORMER\_ATTRIBUTE add ManifestResourceTransformer class to uberjar processing and specify some attribute 6. UBERJAR\_APPENDING\_TRANSFORMER add AppendingTransformer class to uberjar processing 7. UBERJAR\_SERVICES\_RESOURCE\_TRANSFORMER add ServicesResourceTransformer class to uberjar processing - -Documentation: https://wiki.yandex-team.ru/yatool/java/ - -@see: [JAVA\_PROGRAM](#module\_JAVA\_PROGRAM), [UBERJAR\_HIDING\_PREFIX](#macro\_UBERJAR\_HIDING\_PREFIX), [UBERJAR\_HIDE\_EXCLUDE\_PATTERN](#macro\_UBERJAR\_HIDE\_EXCLUDE\_PATTERN), [UBERJAR\_PATH\_EXCLUDE\_PREFIX](#macro\_UBERJAR\_PATH\_EXCLUDE\_PREFIX) - + +Documentation: https://wiki.yandex-team.ru/yatool/java/ + +@see: [JAVA\_PROGRAM](#module\_JAVA\_PROGRAM), [UBERJAR\_HIDING\_PREFIX](#macro\_UBERJAR\_HIDING\_PREFIX), [UBERJAR\_HIDE\_EXCLUDE\_PATTERN](#macro\_UBERJAR\_HIDE\_EXCLUDE\_PATTERN), [UBERJAR\_PATH\_EXCLUDE\_PREFIX](#macro\_UBERJAR\_PATH\_EXCLUDE\_PREFIX) + ###### Macro [UBERJAR\_APPENDING\_TRANSFORMER][](Resource) <a name="macro_UBERJAR_APPENDING_TRANSFORMER"></a> Add AppendingTransformer for UBERJAR() java programs @@ -2867,19 +2867,19 @@ Parameters: @see: [UBERJAR](#macro\_UBERJAR) -###### Macro [UBERJAR\_HIDE\_EXCLUDE\_PATTERN][](Args...) <a name="macro_UBERJAR_HIDE_EXCLUDE_PATTERN"></a> -Exculude classes matching this patterns from shading (if enabled). -Pattern may contain '\*' and '\*\*' globs. -Shading is enabled for UBERJAR program using UBERJAR\_HIDING\_PREFIX macro. If this macro is not specified all classes are shaded. - -@see: [UBERJAR](#macro\_UBERJAR), [UBERJAR\_HIDING\_PREFIX](#macro\_UBERJAR\_HIDING\_PREFIX) - -###### Macro [UBERJAR\_HIDING\_PREFIX][](Arg) <a name="macro_UBERJAR_HIDING_PREFIX"></a> -Set prefix for classes to shade. All classes in UBERJAR will be moved into package prefixed with Arg. -Classes remain in their packages by default. - -@see: [UBERJAR](#macro\_UBERJAR) - +###### Macro [UBERJAR\_HIDE\_EXCLUDE\_PATTERN][](Args...) <a name="macro_UBERJAR_HIDE_EXCLUDE_PATTERN"></a> +Exculude classes matching this patterns from shading (if enabled). +Pattern may contain '\*' and '\*\*' globs. +Shading is enabled for UBERJAR program using UBERJAR\_HIDING\_PREFIX macro. If this macro is not specified all classes are shaded. + +@see: [UBERJAR](#macro\_UBERJAR), [UBERJAR\_HIDING\_PREFIX](#macro\_UBERJAR\_HIDING\_PREFIX) + +###### Macro [UBERJAR\_HIDING\_PREFIX][](Arg) <a name="macro_UBERJAR_HIDING_PREFIX"></a> +Set prefix for classes to shade. All classes in UBERJAR will be moved into package prefixed with Arg. +Classes remain in their packages by default. + +@see: [UBERJAR](#macro\_UBERJAR) + ###### Macro [UBERJAR\_MANIFEST\_TRANSFORMER\_ATTRIBUTE][](Key, Value) <a name="macro_UBERJAR_MANIFEST_TRANSFORMER_ATTRIBUTE"></a> Transform manifest.mf for UBERJAR() java programs, set attribute @@ -2890,12 +2890,12 @@ Transform manifest.mf for UBERJAR() java programs, set main-class attribute @see: [UBERJAR](#macro\_UBERJAR) -###### Macro [UBERJAR\_PATH\_EXCLUDE\_PREFIX][](Args...) <a name="macro_UBERJAR_PATH_EXCLUDE_PREFIX"></a> -Exculude classes matching this patterns from UBERJAR. -By default all dependencies of UBERJAR program will lend in a .jar archive. - -@see: [UBERJAR](#macro\_UBERJAR) - +###### Macro [UBERJAR\_PATH\_EXCLUDE\_PREFIX][](Args...) <a name="macro_UBERJAR_PATH_EXCLUDE_PREFIX"></a> +Exculude classes matching this patterns from UBERJAR. +By default all dependencies of UBERJAR program will lend in a .jar archive. + +@see: [UBERJAR](#macro\_UBERJAR) + ###### Macro [UBERJAR\_SERVICES\_RESOURCE\_TRANSFORMER][]() <a name="macro_UBERJAR_SERVICES_RESOURCE_TRANSFORMER"></a> Add ServicesResourceTransformer for UBERJAR() java programs @@ -2914,9 +2914,9 @@ Not documented yet. Add dependency on C++ runtime Note: This macro is inteneded for use in \_GO\_BASE\_UNIT like module when the module is built without C++ runtime by default -###### Macro [USE\_ERROR\_PRONE][]() <a name="macro_USE_ERROR_PRONE"></a> -Use errorprone instead of javac for .java compilation. - +###### Macro [USE\_ERROR\_PRONE][]() <a name="macro_USE_ERROR_PRONE"></a> +Use errorprone instead of javac for .java compilation. + ###### Macro [USE\_EXT\_PROTO][](peerdir\_tag...) <a name="macro_USE_EXT_PROTO"></a> Configure module to use proto files from existing PROTO\_LIBRARY module. Additional PEERDIR tags required to build a module can be passed through @@ -2937,37 +2937,37 @@ Use lld linker for a program. This doesn't work in libraries ###### Macro [USE\_PERL\_514\_LIB][]() <a name="macro_USE_PERL_514_LIB"></a> Add dependency on Perl 5.14 to your LIBRARY -###### Macro [USE\_PERL\_LIB][]() <a name="macro_USE_PERL_LIB"></a> -Add dependency on Perl to your LIBRARY - +###### Macro [USE\_PERL\_LIB][]() <a name="macro_USE_PERL_LIB"></a> +Add dependency on Perl to your LIBRARY + ###### Macro [USE\_PLANTUML][]() <a name="macro_USE_PLANTUML"></a> Use PlantUML plug-in for yfm builder to render UML diagrams into documentation ###### Macro [USE\_PYTHON2][]() <a name="macro_USE_PYTHON2"></a> -This adds Python 2.x runtime library to your LIBRARY and makes it Python2-compatible. -Compatibility means proper PEERDIRs, ADDINCLs and variant selection on PEERDIRs to multimodules. - +This adds Python 2.x runtime library to your LIBRARY and makes it Python2-compatible. +Compatibility means proper PEERDIRs, ADDINCLs and variant selection on PEERDIRs to multimodules. + If you'd like to use #include <Python.h> with Python2 specify USE\_PYTHON2 or better make it PY2\_LIBRARY. -If you'd like to use #include <Python.h> with Python3 specify USE\_PYTHON3 or better make it PY3\_LIBRARY. -If you'd like to use #include <Python.h> with both Python2 and Python3 convert your LIBRARY to PY23\_LIBRARY. - +If you'd like to use #include <Python.h> with Python3 specify USE\_PYTHON3 or better make it PY3\_LIBRARY. +If you'd like to use #include <Python.h> with both Python2 and Python3 convert your LIBRARY to PY23\_LIBRARY. + @see: [PY2\_LIBRARY](#module\_PY2\_LIBRARY), [PY3\_LIBRARY](#module\_PY3\_LIBRARY), [PY23\_LIBRARY](#multimodule\_PY23\_LIBRARY) - + ###### Macro [USE\_PYTHON3][]() <a name="macro_USE_PYTHON3"></a> -This adds Python3 library to your LIBRARY and makes it Python3-compatible. -Compatibility means proper PEERDIRs, ADDINCLs and variant selection on PEERDIRs to multimodules. - -If you'd like to use #include <Python.h> with Python3 specify USE\_PYTHON3 or better make it PY3\_LIBRARY. +This adds Python3 library to your LIBRARY and makes it Python3-compatible. +Compatibility means proper PEERDIRs, ADDINCLs and variant selection on PEERDIRs to multimodules. + +If you'd like to use #include <Python.h> with Python3 specify USE\_PYTHON3 or better make it PY3\_LIBRARY. If you'd like to use #include <Python.h> with Python2 specify USE\_PYTHON2 or better make it PY2\_LIBRARY. -If you'd like to use #include <Python.h> with both Python2 and Python3 convert your LIBRARY to PY23\_LIBRARY. - +If you'd like to use #include <Python.h> with both Python2 and Python3 convert your LIBRARY to PY23\_LIBRARY. + @see: [PY2\_LIBRARY](#module\_PY2\_LIBRARY), [PY3\_LIBRARY](#module\_PY3\_LIBRARY), [PY23\_LIBRARY](#multimodule\_PY23\_LIBRARY) - -###### Macro [USE\_RECIPE][](path [arg1 arg2...]) <a name="macro_USE_RECIPE"></a> -Provides prepared environment via recipe for test. - -Documentation: https://wiki.yandex-team.ru/yatool/test/recipes - + +###### Macro [USE\_RECIPE][](path [arg1 arg2...]) <a name="macro_USE_RECIPE"></a> +Provides prepared environment via recipe for test. + +Documentation: https://wiki.yandex-team.ru/yatool/test/recipes + ###### Macro [USE\_SKIFF][]() _#wip, do not use_ <a name="macro_USE_SKIFF"></a> Use mapreduce/yt/skiff\_proto/plugin for C++ @@ -2979,18 +2979,18 @@ Note: This macro is intended for use in \_GO\_BASE\_UNIT like module when the mo Change uid for resource validation tests. May be useful when sandbox resource ttl is changed, but test status is cached in CI. You can change ext to change test's uid. For example VALIDATE\_DATA\_RESTART(X), where is X is current revision. -###### Macro [VERSION][](Args...) <a name="macro_VERSION"></a> -Specify version of a module. Currently unused by build system, only informative. - +###### Macro [VERSION][](Args...) <a name="macro_VERSION"></a> +Specify version of a module. Currently unused by build system, only informative. + ###### Macro [VISIBILITY][](level) <a name="macro_VISIBILITY"></a> This macro sets visibility level for symbols compiled for the current module. 'level' may take only one of the following values: DEFAULT, HIDDEN. -###### Macro [WERROR][]() <a name="macro_WERROR"></a> -Consider warnings as errors in the current module. -In the bright future will be removed, since WERROR is the default. -Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. - +###### Macro [WERROR][]() <a name="macro_WERROR"></a> +Consider warnings as errors in the current module. +In the bright future will be removed, since WERROR is the default. +Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. + ###### Macro [WHOLE\_ARCHIVE][](dirnames...) _# internal_ <a name="macro_WHOLE_ARCHIVE"></a> Not documented yet. @@ -3008,9 +3008,9 @@ Include dynamic libraries as extra PROGRAM/DLL outputs ###### Macro [WITH\_GROOVY][]() <a name="macro_WITH_GROOVY"></a> Compile groovy source code in this java module -###### Macro [WITH\_JDK][]() <a name="macro_WITH_JDK"></a> +###### Macro [WITH\_JDK][]() <a name="macro_WITH_JDK"></a> Add directory with JDK to JAVA\_PROGRAM output - + ###### Macro [WITH\_KOTLIN][]() <a name="macro_WITH_KOTLIN"></a> Compile kotlin source code in this java module @@ -3020,19 +3020,19 @@ Enable allopen kotlin compiler plugin https://kotlinlang.org/docs/all-open-plugi ###### Macro [WITH\_KOTLINC\_NOARG][](-flags) <a name="macro_WITH_KOTLINC_NOARG"></a> Enable noarg kotlin compiler plugin https://kotlinlang.org/docs/no-arg-plugin.html -###### Macro [XS\_PROTO][](InputProto Dir Outputs...) _# deprecated_ <a name="macro_XS_PROTO"></a> -Generate Perl code from protobuf. -In order to use this macro one should predict all outputs protoc will emit from input\_proto file and enlist those as outputs. - -###### Macro [YABS\_GENERATE\_CONF][] <a name="macro_YABS_GENERATE_CONF"></a> -Not documented yet. - -###### Macro [YABS\_GENERATE\_PHANTOM\_CONF\_PATCH][] <a name="macro_YABS_GENERATE_PHANTOM_CONF_PATCH"></a> -Not documented yet. - -###### Macro [YABS\_GENERATE\_PHANTOM\_CONF\_TEST\_CHECK][] <a name="macro_YABS_GENERATE_PHANTOM_CONF_TEST_CHECK"></a> -Not documented yet. - +###### Macro [XS\_PROTO][](InputProto Dir Outputs...) _# deprecated_ <a name="macro_XS_PROTO"></a> +Generate Perl code from protobuf. +In order to use this macro one should predict all outputs protoc will emit from input\_proto file and enlist those as outputs. + +###### Macro [YABS\_GENERATE\_CONF][] <a name="macro_YABS_GENERATE_CONF"></a> +Not documented yet. + +###### Macro [YABS\_GENERATE\_PHANTOM\_CONF\_PATCH][] <a name="macro_YABS_GENERATE_PHANTOM_CONF_PATCH"></a> +Not documented yet. + +###### Macro [YABS\_GENERATE\_PHANTOM\_CONF\_TEST\_CHECK][] <a name="macro_YABS_GENERATE_PHANTOM_CONF_TEST_CHECK"></a> +Not documented yet. + ###### Macro [YDL\_DESC\_USE\_BINARY][]() <a name="macro_YDL_DESC_USE_BINARY"></a> Used in conjunction with BUILD\_YDL\_DESC. When enabled, all generated descriptors are binary. @@ -3045,17 +3045,17 @@ Used in conjunction with BUILD\_YDL\_DESC. When enabled, all generated descripto This will generate descriptor Event.ydld in a binary format. -###### Macro [YMAPS\_SPROTO][](ProtoFiles...) _# maps-specific_ <a name="macro_YMAPS_SPROTO"></a> -Maps-specific .proto handling: generate .sproto.h files using maps/libs/sproto/sprotoc. - +###### Macro [YMAPS\_SPROTO][](ProtoFiles...) _# maps-specific_ <a name="macro_YMAPS_SPROTO"></a> +Maps-specific .proto handling: generate .sproto.h files using maps/libs/sproto/sprotoc. + ###### Macro [YP\_PROTO\_YSON][](Files... OUT\_OPTS Opts...) <a name="macro_YP_PROTO_YSON"></a> Genereate .yson.go from .proto using yp/go/yson/internal/proto-yson-gen/cmd/proto-yson-gen -###### Macro [YQL\_ABI\_VERSION][](major minor release)) <a name="macro_YQL_ABI_VERSION"></a> -Specifying the supported ABI for YQL\_UDF. - -@see: [YQL\_UDF()](#multimodule\_YQL\_UDF) - +###### Macro [YQL\_ABI\_VERSION][](major minor release)) <a name="macro_YQL_ABI_VERSION"></a> +Specifying the supported ABI for YQL\_UDF. + +@see: [YQL\_UDF()](#multimodule\_YQL\_UDF) + ###### Macro [YQL\_LAST\_ABI\_VERSION][]() <a name="macro_YQL_LAST_ABI_VERSION"></a> Use the last ABI for YQL\_UDF @@ -3085,9 +3085,9 @@ Not documented yet. ###### Macro [\_ADD\_JAVA\_STYLE\_CHECKS][] _#internal_ <a name="macro__ADD_JAVA_STYLE_CHECKS"></a> Not documented yet. -###### Macro [\_ADD\_PY\_PROTO\_OUT][](Suf) _#internal_ <a name="macro__ADD_PY_PROTO_OUT"></a> -Not documented yet. - +###### Macro [\_ADD\_PY\_PROTO\_OUT][](Suf) _#internal_ <a name="macro__ADD_PY_PROTO_OUT"></a> +Not documented yet. + ###### Macro [\_ADD\_YQL\_UDF\_DEPS][]() _#internal_ <a name="macro__ADD_YQL_UDF_DEPS"></a> Add all needed PEERDIRs to a YQL\_UDF. @@ -3096,44 +3096,44 @@ https://yql.yandex-team.ru/docs/yt/udf/cpp/ ###### Macro [\_ALL\_PY\_SRCS2][](TOP\_LEVEL?"TOP\_LEVEL":"", RECURSIVE?"/\*\*":"", NAMESPACE[], REST[]) _#internal_ <a name="macro__ALL_PY_SRCS2"></a> Not documented yet. -###### Macro [\_ARCADIA\_PYTHON3\_ADDINCL][]() _# internal_ <a name="macro__ARCADIA_PYTHON3_ADDINCL"></a> -This macro sets up Python3 headers for modules with Arcadia python (e.g. PY3\_LIBRARY) and configures module as Python 3.x. - +###### Macro [\_ARCADIA\_PYTHON3\_ADDINCL][]() _# internal_ <a name="macro__ARCADIA_PYTHON3_ADDINCL"></a> +This macro sets up Python3 headers for modules with Arcadia python (e.g. PY3\_LIBRARY) and configures module as Python 3.x. + ###### Macro [\_ARCADIA\_PYTHON\_ADDINCL][]() _# internal_ <a name="macro__ARCADIA_PYTHON_ADDINCL"></a> This macro sets up Python headers for modules with Arcadia python (e.g. PY2\_LIBRARY) and configures module as Python 2.x. - + ###### Macro [\_BARE\_LINK\_MODULE][]() _# internal_ <a name="macro__BARE_LINK_MODULE"></a> Remove unwanted dependencies for "empty" link module ###### Macro [\_BARE\_MODULE][]() _# internal_ <a name="macro__BARE_MODULE"></a> Remove unwanted dependencies for "empty" library module -###### Macro [\_BUILDWITH\_CYTHON\_CPP\_DEP][](Src Dep Options...) _# internal_ <a name="macro__BUILDWITH_CYTHON_CPP_DEP"></a> -Generates .cpp file from .pyx and attach extra input Dep. -If Dep changes the .cpp file will be re-generated. - -###### Macro [\_BUILDWITH\_CYTHON\_C\_API\_H][](Src Dep Options...) _# internal_ <a name="macro__BUILDWITH_CYTHON_C_API_H"></a> -BUILDWITH\_CYTHON\_C\_H with cdef api \_api.h file. - -###### Macro [\_BUILDWITH\_CYTHON\_C\_DEP][](Src Dep Options...) _# internal_ <a name="macro__BUILDWITH_CYTHON_C_DEP"></a> -Generates .c file from .pyx and attach extra input Dep. -If Dep changes the .c file will be re-generated. - -###### Macro [\_BUILDWITH\_CYTHON\_C\_H][](Src Dep Options...) _# internal_ <a name="macro__BUILDWITH_CYTHON_C_H"></a> -BUILDWITH\_CYTHON\_C without .pyx infix and with cdef public .h file. - -###### Macro [\_BUILD\_MNS\_CPP][](NAME="", CHECK?, RANKING\_SUFFIX="", Files...) _#internal_ <a name="macro__BUILD_MNS_CPP"></a> -Not documented yet. - -###### Macro [\_BUILD\_MNS\_FILE][](Input, Name, Output, Suffix, Check, Fml\_tool, AsmDataName) _#internal_ <a name="macro__BUILD_MNS_FILE"></a> -Not documented yet. - -###### Macro [\_BUILD\_MNS\_FILES][] _#internal_ <a name="macro__BUILD_MNS_FILES"></a> -Not documented yet. - -###### Macro [\_BUILD\_MNS\_HEADER][](NAME="", CHECK?, RANKING\_SUFFIX="", Files...) _#internal_ <a name="macro__BUILD_MNS_HEADER"></a> -Not documented yet. - +###### Macro [\_BUILDWITH\_CYTHON\_CPP\_DEP][](Src Dep Options...) _# internal_ <a name="macro__BUILDWITH_CYTHON_CPP_DEP"></a> +Generates .cpp file from .pyx and attach extra input Dep. +If Dep changes the .cpp file will be re-generated. + +###### Macro [\_BUILDWITH\_CYTHON\_C\_API\_H][](Src Dep Options...) _# internal_ <a name="macro__BUILDWITH_CYTHON_C_API_H"></a> +BUILDWITH\_CYTHON\_C\_H with cdef api \_api.h file. + +###### Macro [\_BUILDWITH\_CYTHON\_C\_DEP][](Src Dep Options...) _# internal_ <a name="macro__BUILDWITH_CYTHON_C_DEP"></a> +Generates .c file from .pyx and attach extra input Dep. +If Dep changes the .c file will be re-generated. + +###### Macro [\_BUILDWITH\_CYTHON\_C\_H][](Src Dep Options...) _# internal_ <a name="macro__BUILDWITH_CYTHON_C_H"></a> +BUILDWITH\_CYTHON\_C without .pyx infix and with cdef public .h file. + +###### Macro [\_BUILD\_MNS\_CPP][](NAME="", CHECK?, RANKING\_SUFFIX="", Files...) _#internal_ <a name="macro__BUILD_MNS_CPP"></a> +Not documented yet. + +###### Macro [\_BUILD\_MNS\_FILE][](Input, Name, Output, Suffix, Check, Fml\_tool, AsmDataName) _#internal_ <a name="macro__BUILD_MNS_FILE"></a> +Not documented yet. + +###### Macro [\_BUILD\_MNS\_FILES][] _#internal_ <a name="macro__BUILD_MNS_FILES"></a> +Not documented yet. + +###### Macro [\_BUILD\_MNS\_HEADER][](NAME="", CHECK?, RANKING\_SUFFIX="", Files...) _#internal_ <a name="macro__BUILD_MNS_HEADER"></a> +Not documented yet. + ###### Macro [\_BUNDLE\_TARGET][](Target, Destination) _#internal_ <a name="macro__BUNDLE_TARGET"></a> Not documented yet. @@ -3156,21 +3156,21 @@ Not documented yet. ###### Macro [\_CPP\_CFGPROTO\_CMD][](File) _#internal_ <a name="macro__CPP_CFGPROTO_CMD"></a> Not documented yet. -###### Macro [\_CPP\_EVLOG\_CMD][](File) _#internal_ <a name="macro__CPP_EVLOG_CMD"></a> -Not documented yet. - +###### Macro [\_CPP\_EVLOG\_CMD][](File) _#internal_ <a name="macro__CPP_EVLOG_CMD"></a> +Not documented yet. + ###### Macro [\_CPP\_FLATC64\_CMD][](SRC, SRCFLAGS...) _#internal_ <a name="macro__CPP_FLATC64_CMD"></a> Not documented yet. ###### Macro [\_CPP\_FLATC\_CMD][](SRC, SRCFLAGS...) _#internal_ <a name="macro__CPP_FLATC_CMD"></a> Not documented yet. -###### Macro [\_CPP\_PROTO\_CMD][](File) _#internal_ <a name="macro__CPP_PROTO_CMD"></a> -Not documented yet. - -###### Macro [\_CPP\_PROTO\_EVLOG\_CMD][](File) _#internal_ <a name="macro__CPP_PROTO_EVLOG_CMD"></a> -Not documented yet. - +###### Macro [\_CPP\_PROTO\_CMD][](File) _#internal_ <a name="macro__CPP_PROTO_CMD"></a> +Not documented yet. + +###### Macro [\_CPP\_PROTO\_EVLOG\_CMD][](File) _#internal_ <a name="macro__CPP_PROTO_EVLOG_CMD"></a> +Not documented yet. + ###### Macro [\_CPP\_VANILLA\_PROTO\_CMD][](File) _#internal_ <a name="macro__CPP_VANILLA_PROTO_CMD"></a> Not documented yet. @@ -3228,12 +3228,12 @@ requirements;hide ###### Macro [\_FROM\_NPM\_LOCKFILES][] _#internal_ <a name="macro__FROM_NPM_LOCKFILES"></a> Not documented yet. -###### Macro [\_GENERATE\_PY\_EVS\_INTERNAL][](FILES...) _#internal_ <a name="macro__GENERATE_PY_EVS_INTERNAL"></a> -Not documented yet. - -###### Macro [\_GENERATE\_PY\_PROTOS\_INTERNAL][](FILES...) _#internal_ <a name="macro__GENERATE_PY_PROTOS_INTERNAL"></a> -Not documented yet. - +###### Macro [\_GENERATE\_PY\_EVS\_INTERNAL][](FILES...) _#internal_ <a name="macro__GENERATE_PY_EVS_INTERNAL"></a> +Not documented yet. + +###### Macro [\_GENERATE\_PY\_PROTOS\_INTERNAL][](FILES...) _#internal_ <a name="macro__GENERATE_PY_PROTOS_INTERNAL"></a> +Not documented yet. + ###### Macro [\_GENTAR\_HELPER][](OUT\_DIR[], Args...) _#internal_ <a name="macro__GENTAR_HELPER"></a> Not documented yet. @@ -3249,15 +3249,15 @@ In globs are supported: Note: globs may slow down builds and may match to garbage if extra files present in working copy. Use with care and only if ultimately needed. -###### Macro [\_GO\_COMPILE\_CGO1][](NAME, FLAGS[], FILES...) _#internal_ <a name="macro__GO_COMPILE_CGO1"></a> -Not documented yet. - +###### Macro [\_GO\_COMPILE\_CGO1][](NAME, FLAGS[], FILES...) _#internal_ <a name="macro__GO_COMPILE_CGO1"></a> +Not documented yet. + ###### Macro [\_GO\_COMPILE\_CGO2][](NAME, C\_FILES[], S\_FILES[], OBJ\_FILES[], FILES...) _#internal_ <a name="macro__GO_COMPILE_CGO2"></a> -Not documented yet. - +Not documented yet. + ###### Macro [\_GO\_COMPILE\_SYMABIS][](FLAGS[], ASM\_FILES...) _#internal_ <a name="macro__GO_COMPILE_SYMABIS"></a> -Not documented yet. - +Not documented yet. + ###### Macro [\_GO\_EMBED\_DIR][](PATTERN) _# internal_ <a name="macro__GO_EMBED_DIR"></a> Define an embed directory DIR. @@ -3273,9 +3273,9 @@ wiil have .fbs.gosrc extension. This .fbs.gosrc is specially processed when ###### Macro [\_GO\_GEN\_COVER\_GO][](GO\_FILE, VAR\_ID) _#internal_ <a name="macro__GO_GEN_COVER_GO"></a> Not documented yet. -###### Macro [\_GO\_GRPC][]() _#internal_ <a name="macro__GO_GRPC"></a> -Not documented yet. - +###### Macro [\_GO\_GRPC][]() _#internal_ <a name="macro__GO_GRPC"></a> +Not documented yet. + ###### Macro [\_GO\_GRPC\_GATEWAY\_SRCS][](Files...) _#internal_ <a name="macro__GO_GRPC_GATEWAY_SRCS"></a> Not documented yet. @@ -3286,31 +3286,31 @@ Not documented yet. Not documented yet. ###### Macro [\_GO\_LINK\_EXE\_IMPL][](CGO\_FILES[], EXTRA\_INPUTS[], GO\_FILES...) _#internal_ <a name="macro__GO_LINK_EXE_IMPL"></a> -Not documented yet. - +Not documented yet. + ###### Macro [\_GO\_LINK\_LIB\_IMPL][](CGO\_FILES[], EXTRA\_INPUTS[], GO\_FILES...) _#internal_ <a name="macro__GO_LINK_LIB_IMPL"></a> -Not documented yet. - +Not documented yet. + ###### Macro [\_GO\_LINK\_TEST\_IMPL][](CGO\_FILES[], EXTRA\_INPUTS[], GO\_TEST\_FILES[], GO\_XTEST\_FILES[], GO\_FILES...) _#internal_ <a name="macro__GO_LINK_TEST_IMPL"></a> -Not documented yet. - -###### Macro [\_GO\_PROCESS\_SRCS][] _#internal_ <a name="macro__GO_PROCESS_SRCS"></a> -\_GO\_PROCESS\_SRCS() macro processes only 'CGO' files. All remaining \*.go files -and other input files are currently processed by a link command of the -GO module (GO\_LIBRARY, GO\_PROGRAM) - +Not documented yet. + +###### Macro [\_GO\_PROCESS\_SRCS][] _#internal_ <a name="macro__GO_PROCESS_SRCS"></a> +\_GO\_PROCESS\_SRCS() macro processes only 'CGO' files. All remaining \*.go files +and other input files are currently processed by a link command of the +GO module (GO\_LIBRARY, GO\_PROGRAM) + ###### Macro [\_GO\_PROTOC\_PLUGIN\_ARGS\_BASE][](Name, Tool, MAP[], PLUGINS[]) _#internal_ <a name="macro__GO_PROTOC_PLUGIN_ARGS_BASE"></a> -Not documented yet. - +Not documented yet. + ###### Macro [\_GO\_PROTOC\_PLUGIN\_ARGS\_BASE\_IMPL][](Name, Tool, PLUGINS...) _#internal_ <a name="macro__GO_PROTOC_PLUGIN_ARGS_BASE_IMPL"></a> Not documented yet. ###### Macro [\_GO\_PROTOC\_PLUGIN\_ARGS\_BASE\_PROXY][](Name, Tool, MAP[], PLUGINS[]) _#internal_ <a name="macro__GO_PROTOC_PLUGIN_ARGS_BASE_PROXY"></a> Not documented yet. -###### Macro [\_GO\_PROTO\_CMD][](File) _#internal_ <a name="macro__GO_PROTO_CMD"></a> -Not documented yet. - +###### Macro [\_GO\_PROTO\_CMD][](File) _#internal_ <a name="macro__GO_PROTO_CMD"></a> +Not documented yet. + ###### Macro [\_GO\_PROTO\_CMD\_IMPL][](File, OPTS[], OUTS[]) _#internal_ <a name="macro__GO_PROTO_CMD_IMPL"></a> Not documented yet. @@ -3321,9 +3321,9 @@ Not documented yet. This macro shouldn't be used in ya.make files, use SRCS() instead. This is internal macro collecting .go sources for processing within Go modules (GO\_PROGRAM and GO\_LIBRARY) -###### Macro [\_GO\_UNUSED\_SRCS][](FLAGS...) _#internal_ <a name="macro__GO_UNUSED_SRCS"></a> -Not documented yet. - +###### Macro [\_GO\_UNUSED\_SRCS][](FLAGS...) _#internal_ <a name="macro__GO_UNUSED_SRCS"></a> +Not documented yet. + ###### Macro [\_HASH\_HELPER][](Args...) _#internal_ <a name="macro__HASH_HELPER"></a> Not documented yet. @@ -3333,9 +3333,9 @@ Not documented yet. ###### Macro [\_INPUT\_WITH\_FLAG\_IMPL][](IN{input}[], Args...) _#internal_ <a name="macro__INPUT_WITH_FLAG_IMPL"></a> Not documented yet. -###### Macro [\_IOS\_ASSETS][](AssetsDir, Content...) _#internal_ <a name="macro__IOS_ASSETS"></a> -Not documented yet. - +###### Macro [\_IOS\_ASSETS][](AssetsDir, Content...) _#internal_ <a name="macro__IOS_ASSETS"></a> +Not documented yet. + ###### Macro [\_JAR\_ANN\_PROC\_OPTS][](Classes...) _#internal_ <a name="macro__JAR_ANN_PROC_OPTS"></a> Not documented yet. @@ -3345,18 +3345,18 @@ Not documented yet. ###### Macro [\_JAVAC\_RUN\_HELPER][](JAVAC\_CMD\_WITH\_ARGS...) _#internal_ <a name="macro__JAVAC_RUN_HELPER"></a> Not documented yet. -###### Macro [\_JAVA\_EVLOG\_CMD][](File) _#internal_ <a name="macro__JAVA_EVLOG_CMD"></a> -Not documented yet. - +###### Macro [\_JAVA\_EVLOG\_CMD][](File) _#internal_ <a name="macro__JAVA_EVLOG_CMD"></a> +Not documented yet. + ###### Macro [\_JAVA\_FLATC\_CMD][](fbs\_file) _# internal_ <a name="macro__JAVA_FLATC_CMD"></a> Create a tar archive of .java files generated by flatc for Java. Output tar acrchive will have .fbs.jsrc extension. Files with .fbs.jsrc extension will be added to results when --add-flatbuf-result flag is specified on the command line for 'ya make ...' -###### Macro [\_JAVA\_PROTO\_CMD][](File) _#internal_ <a name="macro__JAVA_PROTO_CMD"></a> -Not documented yet. - +###### Macro [\_JAVA\_PROTO\_CMD][](File) _#internal_ <a name="macro__JAVA_PROTO_CMD"></a> +Not documented yet. + ###### Macro [\_JAVA\_PROTO\_PLUGIN\_ARGS\_BASE][](Name, Tool, OutParm...) _#internal_ <a name="macro__JAVA_PROTO_PLUGIN_ARGS_BASE"></a> Not documented yet. @@ -3369,12 +3369,12 @@ Not documented yet. ###### Macro [\_LANG\_CFLAGS][](SRC) _#internal_ <a name="macro__LANG_CFLAGS"></a> Not documented yet. -###### Macro [\_LUAJIT\_21\_OBJDUMP][](Src, OUT="") _#internal_ <a name="macro__LUAJIT_21_OBJDUMP"></a> -Not documented yet. - -###### Macro [\_LUAJIT\_OBJDUMP][](Src, OUT="") _#internal_ <a name="macro__LUAJIT_OBJDUMP"></a> -Not documented yet. - +###### Macro [\_LUAJIT\_21\_OBJDUMP][](Src, OUT="") _#internal_ <a name="macro__LUAJIT_21_OBJDUMP"></a> +Not documented yet. + +###### Macro [\_LUAJIT\_OBJDUMP][](Src, OUT="") _#internal_ <a name="macro__LUAJIT_OBJDUMP"></a> +Not documented yet. + ###### Macro [\_MAKE\_YQL\_PYTHON\_UDF\_TEST][]() _#internal_ <a name="macro__MAKE_YQL_PYTHON_UDF_TEST"></a> Not documented yet. @@ -3407,12 +3407,12 @@ Not documented yet. ###### Macro [\_MSVC\_FLAGS\_WINDOWS\_IMPL][](target\_platform compiler\_flags) _# internal_ <a name="macro__MSVC_FLAGS_WINDOWS_IMPL"></a> Add CFLAGS when the firts argument is WINDOWS -###### Macro [\_MX\_BIN\_TO\_INFO][](Src) _#internal_ <a name="macro__MX_BIN_TO_INFO"></a> -Not documented yet. - -###### Macro [\_MX\_GEN\_TABLE][](Srcs...) _#internal_ <a name="macro__MX_GEN_TABLE"></a> -Not documented yet. - +###### Macro [\_MX\_BIN\_TO\_INFO][](Src) _#internal_ <a name="macro__MX_BIN_TO_INFO"></a> +Not documented yet. + +###### Macro [\_MX\_GEN\_TABLE][](Srcs...) _#internal_ <a name="macro__MX_GEN_TABLE"></a> +Not documented yet. + ###### Macro [\_NODE\_MODULES][](IN{input}[], OUT{output}[]) _#internal_ <a name="macro__NODE_MODULES"></a> Not documented yet. @@ -3429,67 +3429,67 @@ Not documented yet. Not documented yet. ###### Macro [\_PROTO\_PLUGIN\_ARGS\_BASE][](Name, Tool, OutParm...) _#internal_ <a name="macro__PROTO_PLUGIN_ARGS_BASE"></a> -Not documented yet. - -###### Macro [\_PY3\_COMPILE\_BYTECODE][](SrcX Src) _# internal_ <a name="macro__PY3_COMPILE_BYTECODE"></a> -Compile Python 3.x .py source file into Arcadia binary form suitable for PY3\_PROGRAM - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/pysrcs/#makrospyregister - -###### Macro [\_PY3\_REGISTER][]() _# internal_ <a name="macro__PY3_REGISTER"></a> -Register Python 3.x module in internal resource file system. Arcadia Python 3.x importer will be retrieve these on import directive - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/pysrcs/#makrospyregister - +Not documented yet. + +###### Macro [\_PY3\_COMPILE\_BYTECODE][](SrcX Src) _# internal_ <a name="macro__PY3_COMPILE_BYTECODE"></a> +Compile Python 3.x .py source file into Arcadia binary form suitable for PY3\_PROGRAM + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/pysrcs/#makrospyregister + +###### Macro [\_PY3\_REGISTER][]() _# internal_ <a name="macro__PY3_REGISTER"></a> +Register Python 3.x module in internal resource file system. Arcadia Python 3.x importer will be retrieve these on import directive + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/pysrcs/#makrospyregister + ###### Macro [\_PYCR\_GENERATE\_CONFIGS][](Package, App) _#internal_ <a name="macro__PYCR_GENERATE_CONFIGS"></a> Not documented yet. ###### Macro [\_PYCR\_GENERATE\_CONFIGS\_INTL][](Package, App, Configs...) _#internal_ <a name="macro__PYCR_GENERATE_CONFIGS_INTL"></a> Not documented yet. -###### Macro \_PYTHON\_ADDINCL() _# internal_ <a name="macro__PYTHON3_ADDINCL"></a> -This macro sets up Python 3.x headers for both Arcadia and non-Arcadia python. - +###### Macro \_PYTHON\_ADDINCL() _# internal_ <a name="macro__PYTHON3_ADDINCL"></a> +This macro sets up Python 3.x headers for both Arcadia and non-Arcadia python. + ###### Macro [\_PYTHON\_ADDINCL][]() _# internal_ <a name="macro__PYTHON_ADDINCL"></a> -This macro sets up Python 2.x headers for both Arcadia and non-Arcadia python. - -###### Macro [\_PY\_COMPILE\_BYTECODE][](SrcX Src) _# internal_ <a name="macro__PY_COMPILE_BYTECODE"></a> +This macro sets up Python 2.x headers for both Arcadia and non-Arcadia python. + +###### Macro [\_PY\_COMPILE\_BYTECODE][](SrcX Src) _# internal_ <a name="macro__PY_COMPILE_BYTECODE"></a> Compile Python 2.x .py source file into Arcadia binary form suitable for PY2\_PROGRAM - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/pysrcs/#makrospyregister - + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/pysrcs/#makrospyregister + ###### Macro [\_PY\_ENUM\_SERIALIZATION\_TO\_JSON][](File) _#internal_ <a name="macro__PY_ENUM_SERIALIZATION_TO_JSON"></a> Not documented yet. ###### Macro [\_PY\_ENUM\_SERIALIZATION\_TO\_PY][](File) _#internal_ <a name="macro__PY_ENUM_SERIALIZATION_TO_PY"></a> Not documented yet. -###### Macro [\_PY\_EVLOG\_CMD][](File) _#internal_ <a name="macro__PY_EVLOG_CMD"></a> -Not documented yet. - -###### Macro [\_PY\_EVLOG\_CMD\_BASE][](File, Suf, Args...) _#internal_ <a name="macro__PY_EVLOG_CMD_BASE"></a> -Not documented yet. - -###### Macro [\_PY\_EVLOG\_CMD\_INTERNAL][](File) _#internal_ <a name="macro__PY_EVLOG_CMD_INTERNAL"></a> -Not documented yet. - +###### Macro [\_PY\_EVLOG\_CMD][](File) _#internal_ <a name="macro__PY_EVLOG_CMD"></a> +Not documented yet. + +###### Macro [\_PY\_EVLOG\_CMD\_BASE][](File, Suf, Args...) _#internal_ <a name="macro__PY_EVLOG_CMD_BASE"></a> +Not documented yet. + +###### Macro [\_PY\_EVLOG\_CMD\_INTERNAL][](File) _#internal_ <a name="macro__PY_EVLOG_CMD_INTERNAL"></a> +Not documented yet. + ###### Macro [\_PY\_PROGRAM][] _#internal_ <a name="macro__PY_PROGRAM"></a> Not documented yet. -###### Macro [\_PY\_PROTO\_CMD][](File) _#internal_ <a name="macro__PY_PROTO_CMD"></a> -Not documented yet. - -###### Macro [\_PY\_PROTO\_CMD\_BASE][](File, Suf, Args...) _#internal_ <a name="macro__PY_PROTO_CMD_BASE"></a> -Not documented yet. - -###### Macro [\_PY\_PROTO\_CMD\_INTERNAL][](File) _#internal_ <a name="macro__PY_PROTO_CMD_INTERNAL"></a> -Not documented yet. - -###### Macro [\_PY\_REGISTER][]() _# internal_ <a name="macro__PY_REGISTER"></a> -Register Python 2.x module in internal resource file system. Arcadia Python 2.x importer will be retrieve these on import directive. - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/pysrcs/#makrospyregister - +###### Macro [\_PY\_PROTO\_CMD][](File) _#internal_ <a name="macro__PY_PROTO_CMD"></a> +Not documented yet. + +###### Macro [\_PY\_PROTO\_CMD\_BASE][](File, Suf, Args...) _#internal_ <a name="macro__PY_PROTO_CMD_BASE"></a> +Not documented yet. + +###### Macro [\_PY\_PROTO\_CMD\_INTERNAL][](File) _#internal_ <a name="macro__PY_PROTO_CMD_INTERNAL"></a> +Not documented yet. + +###### Macro [\_PY\_REGISTER][]() _# internal_ <a name="macro__PY_REGISTER"></a> +Register Python 2.x module in internal resource file system. Arcadia Python 2.x importer will be retrieve these on import directive. + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/pysrcs/#makrospyregister + ###### Macro [\_PY\_SSQLS\_SRC][](EXT, SRC, SRCFLAGS...) _#internal_ <a name="macro__PY_SSQLS_SRC"></a> Not documented yet. @@ -3499,9 +3499,9 @@ Not documented yet. ###### Macro \_PY\_SSQLS\_SRC("ssqls", SRC, SRCFLAGS...) _#internal_ <a name="macro__PY_SSQLS_SRC____ssqls"></a> Not documented yet. -###### Macro [\_PY\_TEST][] _#internal_ <a name="macro__PY_TEST"></a> -Not documented yet. - +###### Macro [\_PY\_TEST][] _#internal_ <a name="macro__PY_TEST"></a> +Not documented yet. + ###### Macro [\_RAW\_PROTO\_SRCS][](files...) _# internal_ <a name="macro__RAW_PROTO_SRCS"></a> \_RAW\_PROTO\_SRCS is a proxy macro to FILES macro which filters out GLOBAL keyword from the list of files (NOTE! The order of files listed @@ -3516,8 +3516,8 @@ Not documented yet. Not documented yet. ###### Macro [\_RUN\_JAVA][](IN{input}[], OUT{output}[], OUT\_NOAUTO{output}[], OUTPUT\_INCLUDES[], TOOL[], STDOUT="", STDOUT\_NOAUTO="", CWD="", ENV[], HIDE\_OUTPUT?"stderr2stdout":"stdout2stderr", REQUIREMENTS[], Args...) _#internal_ <a name="macro__RUN_JAVA"></a> -Not documented yet. - +Not documented yet. + ###### Macro [\_RUN\_JBUILD\_PROGRAM][] _#internal_ <a name="macro__RUN_JBUILD_PROGRAM"></a> Not documented yet. @@ -3527,165 +3527,165 @@ Not documented yet. ###### Macro [\_SET\_FIRST\_VALUE][](name args...) _# interanl internal_ <a name="macro__SET_FIRST_VALUE"></a> This macro sets the value of `name` vraiable to the value of next argument -###### Macro [\_SPLIT\_CODEGEN\_BASE][](tool prefix OUTS[] OUTPUT\_INCLUDES[]) _# internal_ <a name="macro__SPLIT_CODEGEN_BASE"></a> -Generator of a certain number .the. cpp file + one header .h file from .in. -This is the call of the generator. Python macro SPLIT\_CODEGEN() is defined in order to properly fill command outputs from OUT\_NUM argument. - -###### Macro [\_SRC][](Ext Src Flags) _# internal_ <a name="macro__SRC"></a> -Basic building block of extension-based command dispatching -To enable specific extension processing define \_SRC() macro with fixed first argument (Ext). -Internal logic will apply this macro to all files with this Ext listed in SRC/SRCS macros or outputs -of other commands (except ones marked as noauto) - +###### Macro [\_SPLIT\_CODEGEN\_BASE][](tool prefix OUTS[] OUTPUT\_INCLUDES[]) _# internal_ <a name="macro__SPLIT_CODEGEN_BASE"></a> +Generator of a certain number .the. cpp file + one header .h file from .in. +This is the call of the generator. Python macro SPLIT\_CODEGEN() is defined in order to properly fill command outputs from OUT\_NUM argument. + +###### Macro [\_SRC][](Ext Src Flags) _# internal_ <a name="macro__SRC"></a> +Basic building block of extension-based command dispatching +To enable specific extension processing define \_SRC() macro with fixed first argument (Ext). +Internal logic will apply this macro to all files with this Ext listed in SRC/SRCS macros or outputs +of other commands (except ones marked as noauto) + ###### Macro [\_SRCS\_NO\_GLOBAL][](files...) _# internal_ <a name="macro__SRCS_NO_GLOBAL"></a> Proxy macro to SRCS macro which filters out GLOBAL keyword from the list of source files. Useful for modules like EXTERNAL\_JAVA\_LIBRARY, where GLOBAL keyword cannot be applied properly. Note: this macro changes order of source files. -###### Macro \_SRC("C", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____C"></a> -Not documented yet. - -###### Macro \_SRC("S", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____S"></a> -Not documented yet. - -###### Macro \_SRC("asm", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____asm"></a> -Not documented yet. - -###### Macro \_SRC("asp", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____asp"></a> -Not documented yet. - -###### Macro \_SRC("c", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____c"></a> -Not documented yet. - -###### Macro \_SRC("cc", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____cc"></a> -Not documented yet. - +###### Macro \_SRC("C", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____C"></a> +Not documented yet. + +###### Macro \_SRC("S", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____S"></a> +Not documented yet. + +###### Macro \_SRC("asm", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____asm"></a> +Not documented yet. + +###### Macro \_SRC("asp", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____asp"></a> +Not documented yet. + +###### Macro \_SRC("c", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____c"></a> +Not documented yet. + +###### Macro \_SRC("cc", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____cc"></a> +Not documented yet. + ###### Macro \_SRC("cfgproto", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____cfgproto"></a> Not documented yet. -###### Macro \_SRC("cpp", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____cpp"></a> -Not documented yet. - +###### Macro \_SRC("cpp", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____cpp"></a> +Not documented yet. + ###### Macro \_SRC("cu", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____cu"></a> Not documented yet. -###### Macro \_SRC("cxx", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____cxx"></a> -Not documented yet. - -###### Macro \_SRC("ev", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____ev"></a> -Not documented yet. - -###### Macro \_SRC("f", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____f"></a> -Not documented yet. - +###### Macro \_SRC("cxx", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____cxx"></a> +Not documented yet. + +###### Macro \_SRC("ev", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____ev"></a> +Not documented yet. + +###### Macro \_SRC("f", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____f"></a> +Not documented yet. + ###### Macro \_SRC("fbs", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____fbs"></a> Not documented yet. ###### Macro \_SRC("fbs64", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____fbs64"></a> Not documented yet. -###### Macro \_SRC("fml", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____fml"></a> -Not documented yet. - -###### Macro \_SRC("fml2", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____fml2"></a> -Not documented yet. - -###### Macro \_SRC("fml3", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____fml3"></a> -Not documented yet. - -###### Macro \_SRC("gperf", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____gperf"></a> -Not documented yet. - -###### Macro \_SRC("gztproto", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____gztproto"></a> -Not documented yet. - -###### Macro \_SRC("in", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____in"></a> -Not documented yet. - -###### Macro \_SRC("l", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____l"></a> -Not documented yet. - -###### Macro \_SRC("lex", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____lex"></a> -Not documented yet. - -###### Macro \_SRC("lpp", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____lpp"></a> -Not documented yet. - +###### Macro \_SRC("fml", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____fml"></a> +Not documented yet. + +###### Macro \_SRC("fml2", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____fml2"></a> +Not documented yet. + +###### Macro \_SRC("fml3", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____fml3"></a> +Not documented yet. + +###### Macro \_SRC("gperf", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____gperf"></a> +Not documented yet. + +###### Macro \_SRC("gztproto", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____gztproto"></a> +Not documented yet. + +###### Macro \_SRC("in", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____in"></a> +Not documented yet. + +###### Macro \_SRC("l", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____l"></a> +Not documented yet. + +###### Macro \_SRC("lex", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____lex"></a> +Not documented yet. + +###### Macro \_SRC("lpp", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____lpp"></a> +Not documented yet. + ###### Macro \_SRC("lua", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____lua"></a> Not documented yet. -###### Macro \_SRC("m", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____m"></a> -Not documented yet. - -###### Macro \_SRC("masm", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____masm"></a> -Not documented yet. - -###### Macro \_SRC("mm", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____mm"></a> -Not documented yet. - -###### Macro \_SRC("pln", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____pln"></a> -Not documented yet. - -###### Macro \_SRC("po", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____po"></a> -Not documented yet. - -###### Macro \_SRC("proto", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____proto"></a> -Not documented yet. - +###### Macro \_SRC("m", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____m"></a> +Not documented yet. + +###### Macro \_SRC("masm", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____masm"></a> +Not documented yet. + +###### Macro \_SRC("mm", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____mm"></a> +Not documented yet. + +###### Macro \_SRC("pln", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____pln"></a> +Not documented yet. + +###### Macro \_SRC("po", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____po"></a> +Not documented yet. + +###### Macro \_SRC("proto", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____proto"></a> +Not documented yet. + ###### Macro \_SRC("pysrc", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____pysrc"></a> Not documented yet. -###### Macro \_SRC("pyx", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____pyx"></a> -Not documented yet. - -###### Macro \_SRC("rl", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____rl"></a> -Not documented yet. - -###### Macro \_SRC("rl5", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____rl5"></a> -Not documented yet. - -###### Macro \_SRC("rl6", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____rl6"></a> -Not documented yet. - -###### Macro \_SRC("s", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____s"></a> -Not documented yet. - +###### Macro \_SRC("pyx", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____pyx"></a> +Not documented yet. + +###### Macro \_SRC("rl", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____rl"></a> +Not documented yet. + +###### Macro \_SRC("rl5", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____rl5"></a> +Not documented yet. + +###### Macro \_SRC("rl6", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____rl6"></a> +Not documented yet. + +###### Macro \_SRC("s", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____s"></a> +Not documented yet. + ###### Macro \_SRC("s79", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____s79"></a> Not documented yet. -###### Macro \_SRC("sc", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____sc"></a> -Not documented yet. - -###### Macro \_SRC("sfdl", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____sfdl"></a> -Not documented yet. - +###### Macro \_SRC("sc", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____sc"></a> +Not documented yet. + +###### Macro \_SRC("sfdl", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____sfdl"></a> +Not documented yet. + ###### Macro \_SRC("ssqls", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____ssqls"></a> Not documented yet. -###### Macro \_SRC("storyboard", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____storyboard"></a> -Not documented yet. - -###### Macro \_SRC("xib", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____xib"></a> -Not documented yet. - -###### Macro \_SRC("xs", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____xs"></a> -Not documented yet. - -###### Macro \_SRC("xsyn", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____xsyn"></a> -Not documented yet. - -###### Macro \_SRC("y", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____y"></a> -Not documented yet. - -###### Macro \_SRC("yasm", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____yasm"></a> -Not documented yet. - -###### Macro \_SRC("ydl", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____ydl"></a> -Not documented yet. - -###### Macro \_SRC("ypp", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____ypp"></a> -Not documented yet. - +###### Macro \_SRC("storyboard", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____storyboard"></a> +Not documented yet. + +###### Macro \_SRC("xib", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____xib"></a> +Not documented yet. + +###### Macro \_SRC("xs", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____xs"></a> +Not documented yet. + +###### Macro \_SRC("xsyn", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____xsyn"></a> +Not documented yet. + +###### Macro \_SRC("y", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____y"></a> +Not documented yet. + +###### Macro \_SRC("yasm", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____yasm"></a> +Not documented yet. + +###### Macro \_SRC("ydl", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____ydl"></a> +Not documented yet. + +###### Macro \_SRC("ypp", SRC, SRCFLAGS...) _#internal_ <a name="macro__SRC____ypp"></a> +Not documented yet. + ###### Macro [\_SRC\_c][](SRC, COMPILE\_OUT\_SUFFIX="", SRCFLAGS...) _#internal_ <a name="macro__SRC_c"></a> Not documented yet. @@ -3711,14 +3711,14 @@ Not documented yet. Not documented yet. ###### Macro [\_SRC\_yasm][](SRC, PREINCLUDES[], SRCFLAGS...) _#internal_ <a name="macro__SRC_yasm"></a> -Not documented yet. - +Not documented yet. + ###### Macro [\_STYLE][] _#internal_ <a name="macro__STYLE"></a> Not documented yet. ###### Macro [\_SWIG\_LANG\_FILTERED\_SRCS][] _#internal_ <a name="macro__SWIG_LANG_FILTERED_SRCS"></a> -Not documented yet. - +Not documented yet. + ###### Macro [\_SWIG\_PYTHON\_C][](Src, DstSubPrefix) _# internal_ <a name="macro__SWIG_PYTHON_C"></a> Like \_SWIG\_PYTHON\_CPP but generate DstSubPrefix\_swg.c. @@ -3729,30 +3729,30 @@ provides DstSubPrefix\_swg python module. ###### Macro [\_TS\_CONFIGURE][] _#internal_ <a name="macro__TS_CONFIGURE"></a> Not documented yet. -###### Macro [\_UNITTEST][] _#internal_ <a name="macro__UNITTEST"></a> -Not documented yet. - +###### Macro [\_UNITTEST][] _#internal_ <a name="macro__UNITTEST"></a> +Not documented yet. + ###### Macro [\_USE\_LINKER][]() _#internal_ <a name="macro__USE_LINKER"></a> Not documented yet. ###### Macro [\_USE\_LINKER\_IMPL][](LINKER\_ID...) _#internal_ <a name="macro__USE_LINKER_IMPL"></a> Not documented yet. -###### Macro [\_YCR\_GENERATE\_CONFIGS][](Package, App) _#internal_ <a name="macro__YCR_GENERATE_CONFIGS"></a> -Not documented yet. - -###### Macro [\_YCR\_GENERATE\_CONFIGS\_INTL][](Package, App, Configs...) _#internal_ <a name="macro__YCR_GENERATE_CONFIGS_INTL"></a> -Not documented yet. - +###### Macro [\_YCR\_GENERATE\_CONFIGS][](Package, App) _#internal_ <a name="macro__YCR_GENERATE_CONFIGS"></a> +Not documented yet. + +###### Macro [\_YCR\_GENERATE\_CONFIGS\_INTL][](Package, App, Configs...) _#internal_ <a name="macro__YCR_GENERATE_CONFIGS_INTL"></a> +Not documented yet. + ###### Macro [\_YMAKE\_GENERATE\_SCRIPT][] _#internal_ <a name="macro__YMAKE_GENERATE_SCRIPT"></a> Not documented yet. -###### Macro [\_YMAPS\_GENERATE\_SPROTO\_HEADER][](File) _#internal_ <a name="macro__YMAPS_GENERATE_SPROTO_HEADER"></a> -Not documented yet. - -###### Macro [\_YTEST][] _#internal_ <a name="macro__YTEST"></a> -Not documented yet. - +###### Macro [\_YMAPS\_GENERATE\_SPROTO\_HEADER][](File) _#internal_ <a name="macro__YMAPS_GENERATE_SPROTO_HEADER"></a> +Not documented yet. + +###### Macro [\_YTEST][] _#internal_ <a name="macro__YTEST"></a> +Not documented yet. + [DLL\_JAVA]: https://a.yandex-team.ru/arc/trunk/arcadia/build/conf/java.ymake.conf?rev=9127402#L165 [DOCS]: https://a.yandex-team.ru/arc/trunk/arcadia/build/ymake.core.conf?rev=9127402#L3247 [DYNAMIC\_LIBRARY]: https://a.yandex-team.ru/arc/trunk/arcadia/build/ymake.core.conf?rev=9127402#L2904 diff --git a/build/docs/readme.md b/build/docs/readme.md index 02000d9d65..3db0a653c7 100644 --- a/build/docs/readme.md +++ b/build/docs/readme.md @@ -1,14 +1,14 @@ *Do not edit, this file is generated from comments to macros definitions using `ya dump conf-docs`.* -# ya.make commands - -General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles) - -## Table of contents - - * [Multimodules](#multimodules) +# ya.make commands + +General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles) + +## Table of contents + + * [Multimodules](#multimodules) - Multimodule [DLL_JAVA](#multimodule_DLL_JAVA) - - Multimodule [DOCS](#multimodule_DOCS) + - Multimodule [DOCS](#multimodule_DOCS) - Multimodule [FBS_LIBRARY](#multimodule_FBS_LIBRARY) - Multimodule [JAR_PROGRAM](#multimodule_JAR_PROGRAM) - Multimodule [JAVA_CONTRIB_PROGRAM](#multimodule_JAVA_CONTRIB_PROGRAM) @@ -19,19 +19,19 @@ General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/Ho - Multimodule [JUNIT5](#multimodule_JUNIT5) - Multimodule [JUNIT5_YMAKE](#multimodule_JUNIT5_YMAKE) - Multimodule [MAPS_IDL_LIBRARY](#multimodule_MAPS_IDL_LIBRARY) - - Multimodule [PROTO_LIBRARY](#multimodule_PROTO_LIBRARY) - - Multimodule [PY23_LIBRARY](#multimodule_PY23_LIBRARY) - - Multimodule [PY23_NATIVE_LIBRARY](#multimodule_PY23_NATIVE_LIBRARY) + - Multimodule [PROTO_LIBRARY](#multimodule_PROTO_LIBRARY) + - Multimodule [PY23_LIBRARY](#multimodule_PY23_LIBRARY) + - Multimodule [PY23_NATIVE_LIBRARY](#multimodule_PY23_NATIVE_LIBRARY) - Multimodule [PY23_TEST](#multimodule_PY23_TEST) - Multimodule [PY3TEST](#multimodule_PY3TEST) - Multimodule [PY3_PROGRAM](#multimodule_PY3_PROGRAM) - Multimodule [SANDBOX_PY23_TASK](#multimodule_SANDBOX_PY23_TASK) - Multimodule [SANDBOX_PY3_TASK](#multimodule_SANDBOX_PY3_TASK) - - Multimodule [SANDBOX_TASK](#multimodule_SANDBOX_TASK) + - Multimodule [SANDBOX_TASK](#multimodule_SANDBOX_TASK) - Multimodule [SSQLS_LIBRARY](#multimodule_SSQLS_LIBRARY) - - Multimodule [YQL_UDF](#multimodule_YQL_UDF) - * [Modules](#modules) - - Module [BOOSTTEST](#module_BOOSTTEST) + - Multimodule [YQL_UDF](#multimodule_YQL_UDF) + * [Modules](#modules) + - Module [BOOSTTEST](#module_BOOSTTEST) - Module [BOOSTTEST_WITH_MAIN](#module_BOOSTTEST_WITH_MAIN) - Module [CI_GROUP](#module_CI_GROUP) - Module [CONTAINER](#module_CONTAINER) @@ -39,27 +39,27 @@ General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/Ho - Module [CPP_STYLE_TEST](#module_CPP_STYLE_TEST) - Module [CUSTOM_BUILD_LIBRARY](#module_CUSTOM_BUILD_LIBRARY) - Module [DEFAULT_IOS_INTERFACE](#module_DEFAULT_IOS_INTERFACE) - - Module [DLL](#module_DLL) + - Module [DLL](#module_DLL) - Module [DLL_TOOL](#module_DLL_TOOL) - - Module [EXECTEST](#module_EXECTEST) - - Module [FAT_OBJECT](#module_FAT_OBJECT) - - Module [FUZZ](#module_FUZZ) + - Module [EXECTEST](#module_EXECTEST) + - Module [FAT_OBJECT](#module_FAT_OBJECT) + - Module [FUZZ](#module_FUZZ) - Module [GO_DLL](#module_GO_DLL) - - Module [GO_LIBRARY](#module_GO_LIBRARY) - - Module [GO_PROGRAM](#module_GO_PROGRAM) - - Module [GO_TEST](#module_GO_TEST) - - Module [GTEST](#module_GTEST) + - Module [GO_LIBRARY](#module_GO_LIBRARY) + - Module [GO_PROGRAM](#module_GO_PROGRAM) + - Module [GO_TEST](#module_GO_TEST) + - Module [GTEST](#module_GTEST) - Module [GTEST_UGLY](#module_GTEST_UGLY) - Module [G_BENCHMARK](#module_G_BENCHMARK) - Module [IOS_INTERFACE](#module_IOS_INTERFACE) - Module [JAVA_CONTRIB](#module_JAVA_CONTRIB) - Module [JAVA_CONTRIB_PROXY](#module_JAVA_CONTRIB_PROXY) - - Module [JAVA_LIBRARY](#module_JAVA_LIBRARY) - - Module [LIBRARY](#module_LIBRARY) + - Module [JAVA_LIBRARY](#module_JAVA_LIBRARY) + - Module [LIBRARY](#module_LIBRARY) - Module [MCU_PROGRAM](#module_MCU_PROGRAM) - - Module [METAQUERY](#module_METAQUERY) - - Module [PACKAGE](#module_PACKAGE) - - Module [PROGRAM](#module_PROGRAM) + - Module [METAQUERY](#module_METAQUERY) + - Module [PACKAGE](#module_PACKAGE) + - Module [PROGRAM](#module_PROGRAM) - Module [PROTO_DESCRIPTIONS](#module_PROTO_DESCRIPTIONS) - Module [PROTO_REGISTRY](#module_PROTO_REGISTRY) - Module [PY2MODULE](#module_PY2MODULE) @@ -67,34 +67,34 @@ General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/Ho - Module [PY2_LIBRARY](#module_PY2_LIBRARY) - Module [PY2_PROGRAM](#module_PY2_PROGRAM) - Module [PY3MODULE](#module_PY3MODULE) - - Module [PY3TEST_BIN](#module_PY3TEST_BIN) - - Module [PY3_LIBRARY](#module_PY3_LIBRARY) + - Module [PY3TEST_BIN](#module_PY3TEST_BIN) + - Module [PY3_LIBRARY](#module_PY3_LIBRARY) - Module [PY3_PROGRAM_BIN](#module_PY3_PROGRAM_BIN) - Module [PYCR_PROGRAM](#module_PYCR_PROGRAM) - Module [PYTEST_BIN](#module_PYTEST_BIN) - - Module [PY_ANY_MODULE](#module_PY_ANY_MODULE) + - Module [PY_ANY_MODULE](#module_PY_ANY_MODULE) - Module [RECURSIVE_LIBRARY](#module_RECURSIVE_LIBRARY) - - Module [RESOURCES_LIBRARY](#module_RESOURCES_LIBRARY) - - Module [R_MODULE](#module_R_MODULE) - - Module [SO_PROGRAM](#module_SO_PROGRAM) + - Module [RESOURCES_LIBRARY](#module_RESOURCES_LIBRARY) + - Module [R_MODULE](#module_R_MODULE) + - Module [SO_PROGRAM](#module_SO_PROGRAM) - Module [TS_LIBRARY](#module_TS_LIBRARY) - - Module [UDF](#module_UDF) - - Module [UDF_LIB](#module_UDF_LIB) - - Module [UNION](#module_UNION) - - Module [UNITTEST](#module_UNITTEST) - - Module [UNITTEST_FOR](#module_UNITTEST_FOR) - - Module [UNITTEST_WITH_CUSTOM_ENTRY_POINT](#module_UNITTEST_WITH_CUSTOM_ENTRY_POINT) - - Module [YCR_PROGRAM](#module_YCR_PROGRAM) - - Module [YQL_PYTHON3_UDF](#module_YQL_PYTHON3_UDF) + - Module [UDF](#module_UDF) + - Module [UDF_LIB](#module_UDF_LIB) + - Module [UNION](#module_UNION) + - Module [UNITTEST](#module_UNITTEST) + - Module [UNITTEST_FOR](#module_UNITTEST_FOR) + - Module [UNITTEST_WITH_CUSTOM_ENTRY_POINT](#module_UNITTEST_WITH_CUSTOM_ENTRY_POINT) + - Module [YCR_PROGRAM](#module_YCR_PROGRAM) + - Module [YQL_PYTHON3_UDF](#module_YQL_PYTHON3_UDF) - Module [YQL_PYTHON3_UDF_TEST](#module_YQL_PYTHON3_UDF_TEST) - - Module [YQL_PYTHON_UDF](#module_YQL_PYTHON_UDF) + - Module [YQL_PYTHON_UDF](#module_YQL_PYTHON_UDF) - Module [YQL_PYTHON_UDF_PROGRAM](#module_YQL_PYTHON_UDF_PROGRAM) - - Module [YQL_PYTHON_UDF_TEST](#module_YQL_PYTHON_UDF_TEST) - - Module [YQL_UDF_MODULE](#module_YQL_UDF_MODULE) - - Module [YQL_UDF_TEST](#module_YQL_UDF_TEST) - - Module [YT_UNITTEST](#module_YT_UNITTEST) + - Module [YQL_PYTHON_UDF_TEST](#module_YQL_PYTHON_UDF_TEST) + - Module [YQL_UDF_MODULE](#module_YQL_UDF_MODULE) + - Module [YQL_UDF_TEST](#module_YQL_UDF_TEST) + - Module [YT_UNITTEST](#module_YT_UNITTEST) - Module [Y_BENCHMARK](#module_Y_BENCHMARK) - * [Macros](#macros) + * [Macros](#macros) - Macros [AARS](#macro_AARS) .. [ADD_COMPILABLE_TRANSLATE](#macro_ADD_COMPILABLE_TRANSLATE) - Macros [ADD_COMPILABLE_TRANSLIT](#macro_ADD_COMPILABLE_TRANSLIT) .. [ANNOTATION_PROCESSOR](#macro_ANNOTATION_PROCESSOR) - Macros [ARCHIVE](#macro_ARCHIVE) .. [BUILDWITH_CYTHON_CPP](#macro_BUILDWITH_CYTHON_CPP) @@ -137,8 +137,8 @@ General info: [How to write ya.make files](https://wiki.yandex-team.ru/yatool/Ho - Macros [USE_PLANTUML](#macro_USE_PLANTUML) .. [WERROR](#macro_WERROR) - Macros [WINDOWS_MANIFEST](#macro_WINDOWS_MANIFEST) .. [YABS_GENERATE_CONF](#macro_YABS_GENERATE_CONF) - Macros [YABS_GENERATE_PHANTOM_CONF_PATCH](#macro_YABS_GENERATE_PHANTOM_CONF_PATCH) .. [YT_SPEC](#macro_YT_SPEC) -## Multimodules <a name="multimodules"></a> - +## Multimodules <a name="multimodules"></a> + ###### Multimodule [DLL\_JAVA][]() <a name="multimodule_DLL_JAVA"></a> DLL built using swig for Java. Produces dynamic library and a .jar. Dynamic library is treated the same as in the case of PEERDIR from Java to DLL. @@ -146,16 +146,16 @@ Dynamic library is treated the same as in the case of PEERDIR from Java to DLL. Documentation: https://wiki.yandex-team.ru/yatool/java/#integracijascpp/pythonsborkojj -###### Multimodule [DOCS][]() <a name="multimodule_DOCS"></a> -Documentation project multimodule. - -When built directly, via RECURSE, DEPENDS or BUNDLE the output artifact is docs.tar.gz with statically generated site (using mkdocs as builder). -When PEERDIRed from other DOCS() module behaves like a UNION (supplying own content and dependencies to build target). -Peerdirs from modules other than DOCS are not accepted. +###### Multimodule [DOCS][]() <a name="multimodule_DOCS"></a> +Documentation project multimodule. + +When built directly, via RECURSE, DEPENDS or BUNDLE the output artifact is docs.tar.gz with statically generated site (using mkdocs as builder). +When PEERDIRed from other DOCS() module behaves like a UNION (supplying own content and dependencies to build target). +Peerdirs from modules other than DOCS are not accepted. Most usual macros are not accepted, only used with the macros DOCS\_DIR(), DOCS\_CONFIG(), DOCS\_VARS(), DOCS\_BUILDER(). - + @see: [DOCS\_DIR()](#macro\_DOCS\_DIR), [DOCS\_CONFIG()](#macro\_DOCS\_CONFIG), [DOCS\_VARS()](#macro\_DOCS\_VARS), [DOCS\_BUILDER()](#macro\_DOCS\_BUILDER). - + ###### Multimodule [FBS\_LIBRARY][]() <a name="multimodule_FBS_LIBRARY"></a> Build some variant of Flatbuffers library. @@ -202,44 +202,44 @@ The particular variant is selected based on where PEERDIR to IDL\_LIBRARY comes Now supported 2 variants: C++, Java Java version is not really a library but an archive of generated Java sources -###### Multimodule [PROTO\_LIBRARY][]() <a name="multimodule_PROTO_LIBRARY"></a> -Build some varian of protocol buffers library. - -The particular variant is selected based on where PEERDIR to PROTO\_LIBRARY comes from. - -Now supported 5 variants: C++, Java, Python 2.x, Python 3.x and Go. -When PEERDIR comes from module for particular language appropriate variant is selected. -PROTO\_LIBRARY also supports emission of GRPC code if GRPC() macro is specified. -Notes: -- Python versions emit C++ code in addition to Python as optimization. -- In some PROTO\_LIBRARY-es Java or Python versions are excluded via EXCLUDE\_TAGS macros due to incompatibilities. -- Use from DEPENDS or BUNDLE is not allowed - -Documentation: https://wiki.yandex-team.ru/yatool/proto\_library/ - -See: [GRPC()](#macro\_GRPC), [OPTIMIZE\_PY\_PROTOS()](#macro\_OPTIMIZE\_PY\_PROTOS), [INCLUDE\_TAGS()](#macro\_INCLUDE\_TAGS), [EXCLUDE\_TAGS()](#macro\_EXCLUDE\_TAGS) - -###### Multimodule [PY23\_LIBRARY][]([name]) <a name="multimodule_PY23_LIBRARY"></a> +###### Multimodule [PROTO\_LIBRARY][]() <a name="multimodule_PROTO_LIBRARY"></a> +Build some varian of protocol buffers library. + +The particular variant is selected based on where PEERDIR to PROTO\_LIBRARY comes from. + +Now supported 5 variants: C++, Java, Python 2.x, Python 3.x and Go. +When PEERDIR comes from module for particular language appropriate variant is selected. +PROTO\_LIBRARY also supports emission of GRPC code if GRPC() macro is specified. +Notes: +- Python versions emit C++ code in addition to Python as optimization. +- In some PROTO\_LIBRARY-es Java or Python versions are excluded via EXCLUDE\_TAGS macros due to incompatibilities. +- Use from DEPENDS or BUNDLE is not allowed + +Documentation: https://wiki.yandex-team.ru/yatool/proto\_library/ + +See: [GRPC()](#macro\_GRPC), [OPTIMIZE\_PY\_PROTOS()](#macro\_OPTIMIZE\_PY\_PROTOS), [INCLUDE\_TAGS()](#macro\_INCLUDE\_TAGS), [EXCLUDE\_TAGS()](#macro\_EXCLUDE\_TAGS) + +###### Multimodule [PY23\_LIBRARY][]([name]) <a name="multimodule_PY23_LIBRARY"></a> Build PY2\_LIBRARY or PY3\_LIBRARY depending on incoming PEERDIR. -Direct build or build by RECURSE creates both variants. -This multimodule doesn't define any final targets, so use from DEPENDS or BUNDLE is not allowed. - -Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs - -###### Multimodule [PY23\_NATIVE\_LIBRARY][]([name]) <a name="multimodule_PY23_NATIVE_LIBRARY"></a> +Direct build or build by RECURSE creates both variants. +This multimodule doesn't define any final targets, so use from DEPENDS or BUNDLE is not allowed. + +Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs + +###### Multimodule [PY23\_NATIVE\_LIBRARY][]([name]) <a name="multimodule_PY23_NATIVE_LIBRARY"></a> Build LIBRARY compatible with either Python 2.x or Python 3.x depending on incoming PEERDIR. - + This multimodule doesn't depend on Arcadia Python binary build. It is intended only for C++ code and cannot contain PY\_SRCS and USE\_PYTHON2 macros. Use these multimodule instead of PY23\_LIBRARY if the C++ extension defined in it will be used in PY2MODULE. While it doesn't bring Arcadia Python dependency itself, it is still compatible with Arcadia Python build and can be PEERDIR-ed from PY2\_LIBRARY and alikes. -Proper version will be selected according to Python version of the module PEERDIR comes from. - -This mulrtimodule doesn't define any final targets so cannot be used from DEPENDS or BUNDLE macros. - -For more information read https://wiki.yandex-team.ru/arcadia/python/pysrcs/#pysrcssrcsipy23nativelibrary - +Proper version will be selected according to Python version of the module PEERDIR comes from. + +This mulrtimodule doesn't define any final targets so cannot be used from DEPENDS or BUNDLE macros. + +For more information read https://wiki.yandex-team.ru/arcadia/python/pysrcs/#pysrcssrcsipy23nativelibrary + @see [LIBRARY()](#module\_LIBRARY), [PY2MODULE()](#module\_PY2MODULE) - + ###### Multimodule [PY23\_TEST][] <a name="multimodule_PY23_TEST"></a> Not documented yet. @@ -274,36 +274,36 @@ and will select multimodule variants accordingly. Documentation: https://wiki.yandex-team.ru/sandbox/tasks/binary -###### Multimodule [SANDBOX\_TASK][]([Name]) <a name="multimodule_SANDBOX_TASK"></a> -Multimodule describing Sandbox task (Python code that can be executed by Sandbox system). - +###### Multimodule [SANDBOX\_TASK][]([Name]) <a name="multimodule_SANDBOX_TASK"></a> +Multimodule describing Sandbox task (Python code that can be executed by Sandbox system). + When being a final target, this multimodule builds Sandbox binary task. It may PEERDIR other SANDBOX\_TASKs as libraries. The final artifact is provided when SANDBOX\_TASK is referred to by DEPENDS and BUNDLE macros. As PEERDIR target, it works like regular PY2\_LIBRARY with predefined dependencies on Sandbox SDK to allow code reuse among SANDBOX\_TASKs. - + Currently Sandbox supports only Python 2.x, so both variants will be compatible only with Python 2.x modules and will select multimodule variants accordingly. - -Documentation: https://wiki.yandex-team.ru/sandbox/tasks/binary - + +Documentation: https://wiki.yandex-team.ru/sandbox/tasks/binary + ###### Multimodule [SSQLS\_LIBRARY][] <a name="multimodule_SSQLS_LIBRARY"></a> Not documented yet. -###### Multimodule [YQL\_UDF][](name) <a name="multimodule_YQL_UDF"></a> -User-defined function for YQL - -Multimodule which is YQL\_UDF\_MODULE when built directly or referred by BUNDLE and DEPENDS macros. -If used by PEERDIRs it is usual static LIBRARY with default YQL dependencies, allowing code reuse between UDFs. - -@see: [YQL\_UDF\_MODULE()](#module\_YQL\_UDF\_MODULE) - -## Modules <a name="modules"></a> - -###### Module [BOOSTTEST][]([name]) _#deprecated_ <a name="module_BOOSTTEST"></a> -Test module based on boost/test/unit\_test.hpp. -As with entire boost library usage of this technology is deprecated in Arcadia and restricted with configuration error in most of projects. -No new module of this type should be introduced unless it is explicitly approved by C++ committee. - +###### Multimodule [YQL\_UDF][](name) <a name="multimodule_YQL_UDF"></a> +User-defined function for YQL + +Multimodule which is YQL\_UDF\_MODULE when built directly or referred by BUNDLE and DEPENDS macros. +If used by PEERDIRs it is usual static LIBRARY with default YQL dependencies, allowing code reuse between UDFs. + +@see: [YQL\_UDF\_MODULE()](#module\_YQL\_UDF\_MODULE) + +## Modules <a name="modules"></a> + +###### Module [BOOSTTEST][]([name]) _#deprecated_ <a name="module_BOOSTTEST"></a> +Test module based on boost/test/unit\_test.hpp. +As with entire boost library usage of this technology is deprecated in Arcadia and restricted with configuration error in most of projects. +No new module of this type should be introduced unless it is explicitly approved by C++ committee. + ###### Module [BOOSTTEST\_WITH\_MAIN][]([name]) _#deprecated_ <a name="module_BOOSTTEST_WITH_MAIN"></a> Same as BOOSTTEST (see above), but comes with builtin int main(argc, argv) implementation @@ -328,79 +328,79 @@ Not documented yet. ###### Module [DEFAULT\_IOS\_INTERFACE][]: IOS\_INTERFACE <a name="module_DEFAULT_IOS_INTERFACE"></a> Not documented yet. -###### Module [DLL][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_DLL"></a> -Dynamic library module defintion. -1. major\_ver and minor\_ver must be integers. -2. EXPORTS allows you to explicitly specify the list of exported functions. This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files -3. PREFIX allows you to change the prefix of the output file (default DLL has the prefix "lib"). - -DLL cannot participate in linking to programs but can be used from Java or as final artifact (packaged and deployed). - +###### Module [DLL][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_DLL"></a> +Dynamic library module defintion. +1. major\_ver and minor\_ver must be integers. +2. EXPORTS allows you to explicitly specify the list of exported functions. This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files +3. PREFIX allows you to change the prefix of the output file (default DLL has the prefix "lib"). + +DLL cannot participate in linking to programs but can be used from Java or as final artifact (packaged and deployed). + ###### Module [DLL\_TOOL][] <a name="module_DLL_TOOL"></a> DLL\_TOOL is a DLL that can be used as a LD\_PRELOAD tool. -###### Module [EXECTEST][]() <a name="module_EXECTEST"></a> -Module definition of generic test that executes a binary. -Use macro RUN to specify binary to run. - -@example: - - EXECTEST() - OWNER(g:yatool) - - RUN( - cat input.txt - ) - DATA( - arcadia/devtools/ya/test/tests/exectest/data - ) - DEPENDS( - devtools/dummy_arcadia/cat - ) - TEST_CWD(devtools/ya/test/tests/exectest/data) - END() - -More examples: https://wiki.yandex-team.ru/yatool/test/#exec-testy - -@see: [RUN()](#macro\_RUN) - -###### Module [FAT\_OBJECT][]() <a name="module_FAT_OBJECT"></a> -The "fat" object module. It will contain all its transitive dependencies reachable by PEERDIRs: -static libraries, local (from own SRCS) and global (from peers') object files. - -Designed for use in XCode projects for iOS. - -###### Module [FUZZ][]() <a name="module_FUZZ"></a> -In order to start using Fuzzing in Arcadia, you need to create a FUZZ module with the implementation of the function LLVMFuzzerTestOneInput(). -This module should be reachable by RECURSE from /autocheck project in order for the corpus to be regularly updated. -AFL and Libfuzzer are supported in Arcadia via a single interface, but the automatic fuzzing still works only through Libfuzzer. - -Example: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/re2/re2/fuzzing/re2\_fuzzer.cc?rev=2919463#L58 - -Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ - +###### Module [EXECTEST][]() <a name="module_EXECTEST"></a> +Module definition of generic test that executes a binary. +Use macro RUN to specify binary to run. + +@example: + + EXECTEST() + OWNER(g:yatool) + + RUN( + cat input.txt + ) + DATA( + arcadia/devtools/ya/test/tests/exectest/data + ) + DEPENDS( + devtools/dummy_arcadia/cat + ) + TEST_CWD(devtools/ya/test/tests/exectest/data) + END() + +More examples: https://wiki.yandex-team.ru/yatool/test/#exec-testy + +@see: [RUN()](#macro\_RUN) + +###### Module [FAT\_OBJECT][]() <a name="module_FAT_OBJECT"></a> +The "fat" object module. It will contain all its transitive dependencies reachable by PEERDIRs: +static libraries, local (from own SRCS) and global (from peers') object files. + +Designed for use in XCode projects for iOS. + +###### Module [FUZZ][]() <a name="module_FUZZ"></a> +In order to start using Fuzzing in Arcadia, you need to create a FUZZ module with the implementation of the function LLVMFuzzerTestOneInput(). +This module should be reachable by RECURSE from /autocheck project in order for the corpus to be regularly updated. +AFL and Libfuzzer are supported in Arcadia via a single interface, but the automatic fuzzing still works only through Libfuzzer. + +Example: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/re2/re2/fuzzing/re2\_fuzzer.cc?rev=2919463#L58 + +Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ + ###### Module [GO\_DLL][](name major\_ver [minor\_ver] [PREFIX prefix]) <a name="module_GO_DLL"></a> Go ishared object module definition. Compile and link Go module to a shared object. Will select Go implementation on PEERDIR to PROTO\_LIBRARY. -###### Module [GO\_LIBRARY][]([name]) <a name="module_GO_LIBRARY"></a> -Go library module definition. -Compile Go module as a library suitable for PEERDIR from other Go modules. -Will select Go implementation on PEERDIR to PROTO\_LIBRARY. - -###### Module [GO\_PROGRAM][]([name]) <a name="module_GO_PROGRAM"></a> -Go program module definition. -Compile and link Go module to an executable program. -Will select Go implementation on PEERDIR to PROTO\_LIBRARY. - -###### Module [GO\_TEST][]([name]) <a name="module_GO_TEST"></a> -Go test module definition. -Compile and link Go module as a test suitable for running with Arcadia testing support. -All usual testing support macros like DATA, DEPENDS, SIZE, REQUIREMENTS etc. are supported. -Will select Go implementation on PEERDIR to PROTO\_LIBRARY. - -###### Module [GTEST][]([name]) <a name="module_GTEST"></a> +###### Module [GO\_LIBRARY][]([name]) <a name="module_GO_LIBRARY"></a> +Go library module definition. +Compile Go module as a library suitable for PEERDIR from other Go modules. +Will select Go implementation on PEERDIR to PROTO\_LIBRARY. + +###### Module [GO\_PROGRAM][]([name]) <a name="module_GO_PROGRAM"></a> +Go program module definition. +Compile and link Go module to an executable program. +Will select Go implementation on PEERDIR to PROTO\_LIBRARY. + +###### Module [GO\_TEST][]([name]) <a name="module_GO_TEST"></a> +Go test module definition. +Compile and link Go module as a test suitable for running with Arcadia testing support. +All usual testing support macros like DATA, DEPENDS, SIZE, REQUIREMENTS etc. are supported. +Will select Go implementation on PEERDIR to PROTO\_LIBRARY. + +###### Module [GTEST][]([name]) <a name="module_GTEST"></a> Unit test module based on library/cpp/testing/gtest. It is recommended not to specify the name. @@ -409,11 +409,11 @@ Documentation: https://docs.yandex-team.ru/arcadia-cpp/cpp\_test ###### Module [GTEST\_UGLY][]([name]) <a name="module_GTEST_UGLY"></a> Deprecated, do not use in new projects. Use GTEST instead. -The test module based on gtest (contrib/libs/gtest contrib/libs/gmock). -Use public documentation on gtest for details. - -Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ - +The test module based on gtest (contrib/libs/gtest contrib/libs/gmock). +Use public documentation on gtest for details. + +Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ + ###### Module [G\_BENCHMARK][]([benchmarkname]) <a name="module_G_BENCHMARK"></a> Benchmark test based on the google benchmark. @@ -421,54 +421,54 @@ For more details see: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/be ###### Module [IOS\_INTERFACE][]() <a name="module_IOS_INTERFACE"></a> iOS GUI module definition - + ###### Module [JAVA\_CONTRIB][]: \_JAR\_BASE <a name="module_JAVA_CONTRIB"></a> Not documented yet. ###### Module [JAVA\_CONTRIB\_PROXY][]: \_JAR\_BASE <a name="module_JAVA_CONTRIB_PROXY"></a> Not documented yet. -###### Module [JAVA\_LIBRARY][]() <a name="module_JAVA_LIBRARY"></a> -The module describing java library build. - -Documentation: https://wiki.yandex-team.ru/yatool/java/ - -###### Module [LIBRARY][]() <a name="module_LIBRARY"></a> -The regular static library module. - -The LIBRARY() is intermediate module, so when built directly it won't build its dependencies. -It transitively provides its PEERDIRs to ultimate final target, where all LIBRARY() modules are built and linked together. - -This is C++ library, and it selects peers from multimodules accordingly. - -It makes little sense to mention LIBRARY in DEPENDS or BUNDLE, package and deploy it since it is not a standalone entity. -In order to use library in tests PEERDIR it to link into tests. -If you think you need to distribute static library please contact devtools@ for assistance. - +###### Module [JAVA\_LIBRARY][]() <a name="module_JAVA_LIBRARY"></a> +The module describing java library build. + +Documentation: https://wiki.yandex-team.ru/yatool/java/ + +###### Module [LIBRARY][]() <a name="module_LIBRARY"></a> +The regular static library module. + +The LIBRARY() is intermediate module, so when built directly it won't build its dependencies. +It transitively provides its PEERDIRs to ultimate final target, where all LIBRARY() modules are built and linked together. + +This is C++ library, and it selects peers from multimodules accordingly. + +It makes little sense to mention LIBRARY in DEPENDS or BUNDLE, package and deploy it since it is not a standalone entity. +In order to use library in tests PEERDIR it to link into tests. +If you think you need to distribute static library please contact devtools@ for assistance. + ###### Module [MCU\_PROGRAM][]([progname]) <a name="module_MCU_PROGRAM"></a> Program module for microcontrollers. Converts binary to Intel HEX and Motorola S-record file formats. If name is not specified it will be generated from the name of the containing project directory. -###### Module [METAQUERY][]() _#deprecated_ <a name="module_METAQUERY"></a> -Project Definition - KIWI Meta query. (Objected) - -https://wiki.yandex-team.ru/robot/manual/kiwi/techdoc/design/metaquery/ - -###### Module [PACKAGE][](name) <a name="module_PACKAGE"></a> -Module collects what is described directly inside it, builds and collects all its transitively available PEERDIRs. -As a result, build directory of the project gets the structure of the accessible part of Arcadia, where the build result of each PEERDIR is placed to relevant Arcadia subpath. +###### Module [METAQUERY][]() _#deprecated_ <a name="module_METAQUERY"></a> +Project Definition - KIWI Meta query. (Objected) + +https://wiki.yandex-team.ru/robot/manual/kiwi/techdoc/design/metaquery/ + +###### Module [PACKAGE][](name) <a name="module_PACKAGE"></a> +Module collects what is described directly inside it, builds and collects all its transitively available PEERDIRs. +As a result, build directory of the project gets the structure of the accessible part of Arcadia, where the build result of each PEERDIR is placed to relevant Arcadia subpath. The data can be optionally packed if macro PACK() is used. - -Is only used together with the macros FILES(), PEERDIR(), COPY(), FROM\_SANDBOX(), RUN\_PROGRAM or BUNDLE(). Don't use SRCS inside a PACKAGE. - -Documentation: https://wiki.yandex-team.ru/yatool/large-data/ - + +Is only used together with the macros FILES(), PEERDIR(), COPY(), FROM\_SANDBOX(), RUN\_PROGRAM or BUNDLE(). Don't use SRCS inside a PACKAGE. + +Documentation: https://wiki.yandex-team.ru/yatool/large-data/ + @see: [PACK()](#macro\_PACK) -###### Module [PROGRAM][]([progname]) <a name="module_PROGRAM"></a> -Regular program module. -If name is not specified it will be generated from the name of the containing project directory. - +###### Module [PROGRAM][]([progname]) <a name="module_PROGRAM"></a> +Regular program module. +If name is not specified it will be generated from the name of the containing project directory. + ###### Module [PROTO\_DESCRIPTIONS][]: \_BARE\_UNIT <a name="module_PROTO_DESCRIPTIONS"></a> Not documented yet. @@ -525,65 +525,65 @@ Do not PEERDIR PY3\_LIBRARY or PY23\_LIBRARY: this will link Python in and rende Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ -###### Module [PY3TEST\_BIN][]() _#deprecated_ <a name="module_PY3TEST_BIN"></a> -Same as PY3TEST. Don't use this, use PY3TEST instead. - -###### Module [PY3\_LIBRARY][]() <a name="module_PY3_LIBRARY"></a> +###### Module [PY3TEST\_BIN][]() _#deprecated_ <a name="module_PY3TEST_BIN"></a> +Same as PY3TEST. Don't use this, use PY3TEST instead. + +###### Module [PY3\_LIBRARY][]() <a name="module_PY3_LIBRARY"></a> Python 3.x binary library. Builds sources from PY\_SRCS to data suitable for PY2\_PROGRAM -Adds dependencies to Python 2.x runtime library from Arcadia. -This module is only compatible with PYTHON3-tagged modules and selects those from multimodules. -This module is only compatible with Arcadia Python build. - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ - +Adds dependencies to Python 2.x runtime library from Arcadia. +This module is only compatible with PYTHON3-tagged modules and selects those from multimodules. +This module is only compatible with Arcadia Python build. + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ + ###### Module [PY3\_PROGRAM\_BIN][]([progname]) <a name="module_PY3_PROGRAM_BIN"></a> Use instead of PY3\_PROGRAM only if ya.make with PY3\_PROGRAM() included in another ya.make In all other cases use PY3\_PROGRAM - + ###### Module [PYCR\_PROGRAM][]([progname]) <a name="module_PYCR_PROGRAM"></a> pycare-specific program module. Generates pycare configs in addition to producing the program. If name is not specified it will be generated from the name of the containing project directory. ###### Module [PYTEST\_BIN][]() _#deprecated_ <a name="module_PYTEST_BIN"></a> Same as PY2TEST. Don't use this, use PY2TEST instead. - -###### Module [PY\_ANY\_MODULE][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_PY_ANY_MODULE"></a> -The Python external module for any versio of Arcadia or system Python. -1. major\_ver and minor\_ver must be integers. -2. The resulting .so will have the prefix "lib". -3. Processing EXPORTS and PREFIX is the same as for DLL module -This is native DLL, so it will select C++ version from PROTO\_LIBRARY. - -Note: Use PYTHON2\_MODULE()/PYTHON3\_MODULE() in order to PEERDIR proper version of PY23\_NATIVE\_LIBRARY. -Do not PEERDIR any PY\*\_LIBRARY: this will link Python in and render artifact unusable as Python module. - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ - + +###### Module [PY\_ANY\_MODULE][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_PY_ANY_MODULE"></a> +The Python external module for any versio of Arcadia or system Python. +1. major\_ver and minor\_ver must be integers. +2. The resulting .so will have the prefix "lib". +3. Processing EXPORTS and PREFIX is the same as for DLL module +This is native DLL, so it will select C++ version from PROTO\_LIBRARY. + +Note: Use PYTHON2\_MODULE()/PYTHON3\_MODULE() in order to PEERDIR proper version of PY23\_NATIVE\_LIBRARY. +Do not PEERDIR any PY\*\_LIBRARY: this will link Python in and render artifact unusable as Python module. + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs/ + ###### Module [RECURSIVE\_LIBRARY][]() <a name="module_RECURSIVE_LIBRARY"></a> The recursive ("fat") library module. It will contain all its transitive dependencies reachable by PEERDIRs: from static libraries, local (from own SRCS) and global (from peers') object files. Designed for use in XCode projects for iOS. -###### Module [RESOURCES\_LIBRARY][]() <a name="module_RESOURCES_LIBRARY"></a> -Definition of a module that brings its content from external source (Sandbox) via DECLARE\_EXTERNAL\_RESOURCE macro. -This can participate in PEERDIRs of others as library but it cannot have own sources and PEERDIRs. - -@see: [DECLARE\_EXTERNAL\_RESOURCE()](#macro\_DECLARE\_EXTERNAL\_RESOURCE) - -###### Module [R\_MODULE][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_R_MODULE"></a> -The external module for R language. -1. major\_ver and minor\_ver must be integers. -2. The resulting .so will have the prefix "lib". -3. Processing EXPORTS and PREFIX is the same as for DLL module -This is native DLL, so it will select C++ version from PROTO\_LIBRARY. - -###### Module [SO\_PROGRAM][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_SO_PROGRAM"></a> -Executable dynamic library module defintion. -1. major\_ver and minor\_ver must be integers. -2. EXPORTS allows you to explicitly specify the list of exported functions. This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files -3. PREFIX allows you to change the prefix of the output file. - +###### Module [RESOURCES\_LIBRARY][]() <a name="module_RESOURCES_LIBRARY"></a> +Definition of a module that brings its content from external source (Sandbox) via DECLARE\_EXTERNAL\_RESOURCE macro. +This can participate in PEERDIRs of others as library but it cannot have own sources and PEERDIRs. + +@see: [DECLARE\_EXTERNAL\_RESOURCE()](#macro\_DECLARE\_EXTERNAL\_RESOURCE) + +###### Module [R\_MODULE][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_R_MODULE"></a> +The external module for R language. +1. major\_ver and minor\_ver must be integers. +2. The resulting .so will have the prefix "lib". +3. Processing EXPORTS and PREFIX is the same as for DLL module +This is native DLL, so it will select C++ version from PROTO\_LIBRARY. + +###### Module [SO\_PROGRAM][](name major\_ver [minor\_ver] [EXPORTS symlist\_file] [PREFIX prefix]) <a name="module_SO_PROGRAM"></a> +Executable dynamic library module defintion. +1. major\_ver and minor\_ver must be integers. +2. EXPORTS allows you to explicitly specify the list of exported functions. This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files +3. PREFIX allows you to change the prefix of the output file. + ###### Module [TS\_LIBRARY][]([name]) <a name="module_TS_LIBRARY"></a> The TypeScript/JavaScript library module, compiles TypeScript sources to JavaScript. Build results are JavaScript files, typings and source mappings (depending on local tsconfig.json settings). @@ -596,50 +596,50 @@ Build results are JavaScript files, typings and source mappings (depending on lo NODE_MODULES() END() -###### Module [UDF][](name [EXPORTS symlist\_file] [PREFIX prefix]) _# deprecated_ <a name="module_UDF"></a> -The KiWi UDF module. -Processing EXPORTS and PREFIX is the same as for DLL. - -https://wiki.yandex-team.ru/robot/manual/kiwi/userguide/#polzovatelskiefunkciiudftriggerykwcalc - -###### Module [UDF\_LIB][]([name]) _# deprecated_ <a name="module_UDF_LIB"></a> -The LIBRARY module for KiWi UDF, so has default PEERDIR to yweb/robot/kiwi/kwcalc/udflib. - -###### Module [UNION][](name) <a name="module_UNION"></a> -Collection of PEERDIR dependencies, files and artifacts. -UNION doesn't build its peers, just provides those to modules depending on it. -When specied in DEPENDS() macro the UNION is transitively closed, building all its peers and providing those by own paths (without adding this module path like PACKAGE does). - -Is only used together with the macros like FILES(), PEERDIR(), COPY(), FROM\_SANDBOX(), RUN\_PROGRAM or BUNDLE(). Don't use SRCS inside a UNION. - -Documentation: https://wiki.yandex-team.ru/yatool/large-data/ - -###### Module [UNITTEST][]([name]) <a name="module_UNITTEST"></a> +###### Module [UDF][](name [EXPORTS symlist\_file] [PREFIX prefix]) _# deprecated_ <a name="module_UDF"></a> +The KiWi UDF module. +Processing EXPORTS and PREFIX is the same as for DLL. + +https://wiki.yandex-team.ru/robot/manual/kiwi/userguide/#polzovatelskiefunkciiudftriggerykwcalc + +###### Module [UDF\_LIB][]([name]) _# deprecated_ <a name="module_UDF_LIB"></a> +The LIBRARY module for KiWi UDF, so has default PEERDIR to yweb/robot/kiwi/kwcalc/udflib. + +###### Module [UNION][](name) <a name="module_UNION"></a> +Collection of PEERDIR dependencies, files and artifacts. +UNION doesn't build its peers, just provides those to modules depending on it. +When specied in DEPENDS() macro the UNION is transitively closed, building all its peers and providing those by own paths (without adding this module path like PACKAGE does). + +Is only used together with the macros like FILES(), PEERDIR(), COPY(), FROM\_SANDBOX(), RUN\_PROGRAM or BUNDLE(). Don't use SRCS inside a UNION. + +Documentation: https://wiki.yandex-team.ru/yatool/large-data/ + +###### Module [UNITTEST][]([name]) <a name="module_UNITTEST"></a> Unit test module based on library/cpp/testing/unittest. -It is recommended not to specify the name. - -Documentation: https://wiki.yandex-team.ru/yatool/test/#opisanievya.make1 - -###### Module [UNITTEST\_FOR][](path/to/lib) <a name="module_UNITTEST_FOR"></a> -Convenience extension of UNITTEST module. -The UNINTTEST module with additional SRCDIR + ADDINCL + PEERDIR on path/to/lib. -path/to/lib is the path to the directory with the LIBRARY project. - -Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ - -###### Module [UNITTEST\_WITH\_CUSTOM\_ENTRY\_POINT][]([name]) <a name="module_UNITTEST_WITH_CUSTOM_ENTRY_POINT"></a> -Generic unit test module. - -###### Module [YCR\_PROGRAM][]([progname]) <a name="module_YCR_PROGRAM"></a> -yacare-specific program module. Generates yacare configs in addition to producing the program. -If name is not specified it will be generated from the name of the containing project directory. - -###### Module [YQL\_PYTHON3\_UDF][](name) <a name="module_YQL_PYTHON3_UDF"></a> -The extension module for YQL with Python 3.x UDF (User Defined Function for YQL). -Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. - -Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ - +It is recommended not to specify the name. + +Documentation: https://wiki.yandex-team.ru/yatool/test/#opisanievya.make1 + +###### Module [UNITTEST\_FOR][](path/to/lib) <a name="module_UNITTEST_FOR"></a> +Convenience extension of UNITTEST module. +The UNINTTEST module with additional SRCDIR + ADDINCL + PEERDIR on path/to/lib. +path/to/lib is the path to the directory with the LIBRARY project. + +Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ + +###### Module [UNITTEST\_WITH\_CUSTOM\_ENTRY\_POINT][]([name]) <a name="module_UNITTEST_WITH_CUSTOM_ENTRY_POINT"></a> +Generic unit test module. + +###### Module [YCR\_PROGRAM][]([progname]) <a name="module_YCR_PROGRAM"></a> +yacare-specific program module. Generates yacare configs in addition to producing the program. +If name is not specified it will be generated from the name of the containing project directory. + +###### Module [YQL\_PYTHON3\_UDF][](name) <a name="module_YQL_PYTHON3_UDF"></a> +The extension module for YQL with Python 3.x UDF (User Defined Function for YQL). +Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. + +Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ + ###### Module [YQL\_PYTHON3\_UDF\_TEST][](name) <a name="module_YQL_PYTHON3_UDF_TEST"></a> The Python test for Python 3.x YQL UDF (User Defined Function for YQL). The code should be a proper YQL\_PYTHON3\_UDF. @@ -649,50 +649,50 @@ Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ @see: [YQL\_PYTHON3\_UDF()](#module\_YQL\_PYTHON3\_UDF) -###### Module [YQL\_PYTHON\_UDF][](name) <a name="module_YQL_PYTHON_UDF"></a> -Definition of the extension module for YQL with Python 2.x UDF (User Defined Function for YQL). -Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. - -https://yql.yandex-team.ru/docs/yt/udf/python/ - +###### Module [YQL\_PYTHON\_UDF][](name) <a name="module_YQL_PYTHON_UDF"></a> +Definition of the extension module for YQL with Python 2.x UDF (User Defined Function for YQL). +Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. + +https://yql.yandex-team.ru/docs/yt/udf/python/ + ###### Module [YQL\_PYTHON\_UDF\_PROGRAM][](name) <a name="module_YQL_PYTHON_UDF_PROGRAM"></a> Definition of the extension module for YQL with Python 2.x UDF (User Defined Function for YQL). Unlike YQL\_UDF this is plain DLL module, so PEERDIRs to it are not allowed. https://yql.yandex-team.ru/docs/yt/udf/python/ -###### Module [YQL\_PYTHON\_UDF\_TEST][](name) <a name="module_YQL_PYTHON_UDF_TEST"></a> -The Python test for Python YQL UDF (Python User Defined Function for YQL). The code should be a proper YQL\_PYTHON\_UDF. - -This module will basically build itself as UDF and run as test using yql/tools/run\_python\_udf/run\_python\_udf tool. - -Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ - -@example: https://a.yandex-team.ru/arc/trunk/arcadia/yql/udfs/test/simple/ya.make - -@see: [YQL\_PYTHON\_UDF()](#module\_YQL\_PYTHON\_UDF) - -###### Module [YQL\_UDF\_MODULE][](name) <a name="module_YQL_UDF_MODULE"></a> -The extension module for YQL with C++ UDF (User Defined Function YQL) - -https://yql.yandex-team.ru/docs/yt/udf/cpp/ - -###### Module [YQL\_UDF\_TEST][]([name]) <a name="module_YQL_UDF_TEST"></a> -The module to test YQL C++ UDF. - -Documentation: https://yql.yandex-team.ru/docs/yt/libraries/testing/ -Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ - -###### Module [YT\_UNITTEST][]([name]) <a name="module_YT_UNITTEST"></a> -YT Unit test module based on mapreduce/yt/library/utlib - +###### Module [YQL\_PYTHON\_UDF\_TEST][](name) <a name="module_YQL_PYTHON_UDF_TEST"></a> +The Python test for Python YQL UDF (Python User Defined Function for YQL). The code should be a proper YQL\_PYTHON\_UDF. + +This module will basically build itself as UDF and run as test using yql/tools/run\_python\_udf/run\_python\_udf tool. + +Documentation: https://yql.yandex-team.ru/docs/yt/udf/python/ + +@example: https://a.yandex-team.ru/arc/trunk/arcadia/yql/udfs/test/simple/ya.make + +@see: [YQL\_PYTHON\_UDF()](#module\_YQL\_PYTHON\_UDF) + +###### Module [YQL\_UDF\_MODULE][](name) <a name="module_YQL_UDF_MODULE"></a> +The extension module for YQL with C++ UDF (User Defined Function YQL) + +https://yql.yandex-team.ru/docs/yt/udf/cpp/ + +###### Module [YQL\_UDF\_TEST][]([name]) <a name="module_YQL_UDF_TEST"></a> +The module to test YQL C++ UDF. + +Documentation: https://yql.yandex-team.ru/docs/yt/libraries/testing/ +Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ + +###### Module [YT\_UNITTEST][]([name]) <a name="module_YT_UNITTEST"></a> +YT Unit test module based on mapreduce/yt/library/utlib + ###### Module [Y\_BENCHMARK][]([benchmarkname]) <a name="module_Y_BENCHMARK"></a> Benchmark test based on the library/cpp/testing/benchmark. For more details see: https://wiki.yandex-team.ru/yatool/test/#zapuskbenchmark -## Macros <a name="macros"></a> - +## Macros <a name="macros"></a> + ###### Macro [AARS][](Aars...) <a name="macro_AARS"></a> This macro is strictly prohibited to use outside of mapsmobi project @@ -703,73 +703,73 @@ Not documented yet. Not documented yet. ###### Macro [ACCELEO][](XSD{input}[], MTL{input}[], MTL\_ROOT="${MODDIR}", LANG{input}[], OUT{output}[], OUT\_NOAUTO{output}[], OUTPUT\_INCLUDES[], DEBUG?"stdout2stderr":"stderr2stdout") <a name="macro_ACCELEO"></a> -Not documented yet. - +Not documented yet. + ###### Macro [ADDINCL][]([FOR <lang>][GLOBAL dir]\* dirlist) _# builtin_ <a name="macro_ADDINCL"></a> The macro adds the directories to include/import search path to compilation flags of the current project. By default settings apply to C/C++ compilation namely sets -I<library path> flag, use FOR argument to change target command. -@params: +@params: `FOR <lang>` - adds inclues/import serach path for othe language. E.g. `FOR proto` adds import search path for .proto files processing. `GLOBAL` - extends the search for headers (-I) on the dependent projects. - + ###### Macro [ADDINCLSELF][]() <a name="macro_ADDINCLSELF"></a> The macro adds the -I<project source path> flag to the source compilation flags of the current project. - -###### Macro [ADD\_CHECK][] <a name="macro_ADD_CHECK"></a> -Not documented yet. - -###### Macro [ADD\_CHECK\_PY\_IMPORTS][] <a name="macro_ADD_CHECK_PY_IMPORTS"></a> -Not documented yet. - + +###### Macro [ADD\_CHECK][] <a name="macro_ADD_CHECK"></a> +Not documented yet. + +###### Macro [ADD\_CHECK\_PY\_IMPORTS][] <a name="macro_ADD_CHECK_PY_IMPORTS"></a> +Not documented yet. + ###### Macro [ADD\_CLANG\_TIDY][]() <a name="macro_ADD_CLANG_TIDY"></a> Not documented yet. -###### Macro [ADD\_COMPILABLE\_TRANSLATE][](Dict Name Options...) <a name="macro_ADD_COMPILABLE_TRANSLATE"></a> -Generate translation dictionary code to transdict.LOWER(Name).cpp that will than be compiled into library - -###### Macro [ADD\_COMPILABLE\_TRANSLIT][](TranslitTable NGrams Name Options...) <a name="macro_ADD_COMPILABLE_TRANSLIT"></a> -Generate transliteration dictionary code -This will emit both translit, untranslit and ngrams table codes those will be than further compiled into library - -###### Macro [ADD\_DLLS\_TO\_JAR][]() <a name="macro_ADD_DLLS_TO_JAR"></a> -Not documented yet. - -###### Macro [ADD\_PERL\_MODULE][](Dir ModuleName) <a name="macro_ADD_PERL_MODULE"></a> -Add dependency on specified Perl module to the library - +###### Macro [ADD\_COMPILABLE\_TRANSLATE][](Dict Name Options...) <a name="macro_ADD_COMPILABLE_TRANSLATE"></a> +Generate translation dictionary code to transdict.LOWER(Name).cpp that will than be compiled into library + +###### Macro [ADD\_COMPILABLE\_TRANSLIT][](TranslitTable NGrams Name Options...) <a name="macro_ADD_COMPILABLE_TRANSLIT"></a> +Generate transliteration dictionary code +This will emit both translit, untranslit and ngrams table codes those will be than further compiled into library + +###### Macro [ADD\_DLLS\_TO\_JAR][]() <a name="macro_ADD_DLLS_TO_JAR"></a> +Not documented yet. + +###### Macro [ADD\_PERL\_MODULE][](Dir ModuleName) <a name="macro_ADD_PERL_MODULE"></a> +Add dependency on specified Perl module to the library + ###### Macro [ADD\_PYTEST\_BIN][] <a name="macro_ADD_PYTEST_BIN"></a> -Not documented yet. - +Not documented yet. + ###### Macro [ADD\_PYTEST\_SCRIPT][] <a name="macro_ADD_PYTEST_SCRIPT"></a> -Not documented yet. - -###### Macro [ADD\_YTEST][] <a name="macro_ADD_YTEST"></a> -Not documented yet. - -###### Macro [ALLOCATOR][](Alloc) _# Default: LF_ <a name="macro_ALLOCATOR"></a> -Set memory allocator implementation for the PROGRAM()/DLL() module. -This may only be specified for programs and dlls, use in other modules leads to configuration errors. - +Not documented yet. + +###### Macro [ADD\_YTEST][] <a name="macro_ADD_YTEST"></a> +Not documented yet. + +###### Macro [ALLOCATOR][](Alloc) _# Default: LF_ <a name="macro_ALLOCATOR"></a> +Set memory allocator implementation for the PROGRAM()/DLL() module. +This may only be specified for programs and dlls, use in other modules leads to configuration errors. + Available allocators are: "LF", "LF\_YT", "LF\_DBG", "YT", "J", "B", "BM", "C", "TCMALLOC", "GOOGLE", "LOCKLESS", "SYSTEM", "FAKE", "MIM", "HU". - LF - lfalloc (https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/lfalloc) - LF\_YT - Allocator selection for YT (https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/lfalloc/yt/ya.make) - LF\_DBG - Debug allocator selection (https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/lfalloc/dbg/ya.make) - YT - The YTAlloc allocator (https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/ytalloc/impl/ya.make) - - J - The JEMalloc allocator (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/jemalloc) - - B - The balloc allocator named Pyotr Popov and Anton Samokhvalov - - Discussion: https://ironpeter.at.yandex-team.ru/replies.xml?item\_no=126 + - J - The JEMalloc allocator (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/jemalloc) + - B - The balloc allocator named Pyotr Popov and Anton Samokhvalov + - Discussion: https://ironpeter.at.yandex-team.ru/replies.xml?item\_no=126 - Code: https://a.yandex-team.ru/arc/trunk/arcadia/library/cpp/balloc - BM - The balloc for market (agri@ commits from july 2018 till November 2018 saved) - - C - Like B, but can be disabled for each thread to LF or SYSTEM one (B can be disabled only to SYSTEM) + - C - Like B, but can be disabled for each thread to LF or SYSTEM one (B can be disabled only to SYSTEM) - MIM - Microsoft's mimalloc (actual version) (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/mimalloc) - TCMALLOC - Google TCMalloc (actual version) (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/tcmalloc) - - GOOGLE - Google TCMalloc (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/galloc) - - LOCKLESS - Allocator based upon lockless queues (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/lockless) - - SYSTEM - Use target system allocator - - FAKE - Don't link with any allocator - -More about allocators in Arcadia: https://wiki.yandex-team.ru/arcadia/allocators/ - + - GOOGLE - Google TCMalloc (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/galloc) + - LOCKLESS - Allocator based upon lockless queues (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/lockless) + - SYSTEM - Use target system allocator + - FAKE - Don't link with any allocator + +More about allocators in Arcadia: https://wiki.yandex-team.ru/arcadia/allocators/ + ###### Macro [ALL\_PY\_SRCS][]([RECURSIVE] { | TOP\_LEVEL | NAMESPACE ns} [Dirs...]) <a name="macro_ALL_PY_SRCS"></a> Puts all .py-files from given Dirs (relative to projects') into PY\_SRCS of the current module. If Dirs is ommitted project directory is used @@ -782,49 +782,49 @@ Note: Macro is designed to reject any ya.make files in Dirs except current one @see [PY\_SRCS()](#macro\_PY\_SRCS) -###### Macro [ALL\_SRCS][]([GLOBAL] filenames...) <a name="macro_ALL_SRCS"></a> -Make all source files listed as GLOBAL or not depending on the keyword GLOBAL -Call to ALL\_SRCS macro is equivalent to call to GLOBAL\_SRCS macro when GLOBAL keyword is specified -as the first argument and is equivalent to call to SRCS macro otherwise. - -@example: - - LIBRARY() - SET(MAKE_IT_GLOBAL GLOBAL) - ALL_SRCS(${MAKE_IT_GLOBAL} foo.cpp bar.cpp) - END() - -@see: [GLOBAL\_SRCS()](#macro\_GLOBAL\_SRCS), [SRCS()](#macro\_SRCS) - -###### Macro [ANNOTATION\_PROCESSOR][](processors...) <a name="macro_ANNOTATION_PROCESSOR"></a> -The macro is in development. -Used to specify annotation processors to build JAVA\_PROGRAM() and JAVA\_LIBRARY(). - -###### Macro [ARCHIVE][](archive\_name [DONT\_COMPRESS] files...) <a name="macro_ARCHIVE"></a> -Add arbitrary data to a modules. Unlike RESOURCE macro the result should be futher processed by othet macros in the module. - -Example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a1ispolzujjtekomanduarchive - -###### Macro [ARCHIVE\_ASM][](NAME archive\_name files...) <a name="macro_ARCHIVE_ASM"></a> -Similar to the macro ARCHIVE, but: -1. works faster and it is better to use for large files. -2. Different syntax (see examples in codesearch or users/pg/tests/archive\_test) - -###### Macro [ARCHIVE\_BY\_KEYS][](archive\_name key [DONT\_COMPRESS] files...) <a name="macro_ARCHIVE_BY_KEYS"></a> -Add arbitrary data to a module be accessible by specified key. -Unlike RESOURCE macro the result should be futher processed by othet macros in the module. - -Example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a1ispolzujjtekomanduarchive - -###### Macro [ASM\_PREINCLUDE][](AsmFiles...) <a name="macro_ASM_PREINCLUDE"></a> -Supply additional .asm files to all assembler calls within a module - +###### Macro [ALL\_SRCS][]([GLOBAL] filenames...) <a name="macro_ALL_SRCS"></a> +Make all source files listed as GLOBAL or not depending on the keyword GLOBAL +Call to ALL\_SRCS macro is equivalent to call to GLOBAL\_SRCS macro when GLOBAL keyword is specified +as the first argument and is equivalent to call to SRCS macro otherwise. + +@example: + + LIBRARY() + SET(MAKE_IT_GLOBAL GLOBAL) + ALL_SRCS(${MAKE_IT_GLOBAL} foo.cpp bar.cpp) + END() + +@see: [GLOBAL\_SRCS()](#macro\_GLOBAL\_SRCS), [SRCS()](#macro\_SRCS) + +###### Macro [ANNOTATION\_PROCESSOR][](processors...) <a name="macro_ANNOTATION_PROCESSOR"></a> +The macro is in development. +Used to specify annotation processors to build JAVA\_PROGRAM() and JAVA\_LIBRARY(). + +###### Macro [ARCHIVE][](archive\_name [DONT\_COMPRESS] files...) <a name="macro_ARCHIVE"></a> +Add arbitrary data to a modules. Unlike RESOURCE macro the result should be futher processed by othet macros in the module. + +Example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a1ispolzujjtekomanduarchive + +###### Macro [ARCHIVE\_ASM][](NAME archive\_name files...) <a name="macro_ARCHIVE_ASM"></a> +Similar to the macro ARCHIVE, but: +1. works faster and it is better to use for large files. +2. Different syntax (see examples in codesearch or users/pg/tests/archive\_test) + +###### Macro [ARCHIVE\_BY\_KEYS][](archive\_name key [DONT\_COMPRESS] files...) <a name="macro_ARCHIVE_BY_KEYS"></a> +Add arbitrary data to a module be accessible by specified key. +Unlike RESOURCE macro the result should be futher processed by othet macros in the module. + +Example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a1ispolzujjtekomanduarchive + +###### Macro [ASM\_PREINCLUDE][](AsmFiles...) <a name="macro_ASM_PREINCLUDE"></a> +Supply additional .asm files to all assembler calls within a module + ###### Macro [ASSERT][] <a name="macro_ASSERT"></a> Not documented yet. -###### Macro [BASE\_CODEGEN][](tool\_path prefix) <a name="macro_BASE_CODEGEN"></a> -Generator ${prefix}.cpp + ${prefix}.h files based on ${prefix}.in. - +###### Macro [BASE\_CODEGEN][](tool\_path prefix) <a name="macro_BASE_CODEGEN"></a> +Generator ${prefix}.cpp + ${prefix}.h files based on ${prefix}.in. + ###### Macro [BPF][](Input Output Opts...) <a name="macro_BPF"></a> Emit eBPF bytecode from .c file. Note: Output name is used as is, no extension added. @@ -833,36 +833,36 @@ Note: Output name is used as is, no extension added. Emit eBPF bytecode from .c file. Note: Output name is used as is, no extension added. -###### Macro [BUILDWITH\_CYTHON\_C][](Src Options...) <a name="macro_BUILDWITH_CYTHON_C"></a> -Generates .c file from .pyx. - -###### Macro [BUILDWITH\_CYTHON\_CPP][](Src Options...) <a name="macro_BUILDWITH_CYTHON_CPP"></a> -Generates .cpp file from .pyx. - -###### Macro [BUILDWITH\_RAGEL6][](Src Options...) <a name="macro_BUILDWITH_RAGEL6"></a> -Compile .rl file using Ragel6. - +###### Macro [BUILDWITH\_CYTHON\_C][](Src Options...) <a name="macro_BUILDWITH_CYTHON_C"></a> +Generates .c file from .pyx. + +###### Macro [BUILDWITH\_CYTHON\_CPP][](Src Options...) <a name="macro_BUILDWITH_CYTHON_CPP"></a> +Generates .cpp file from .pyx. + +###### Macro [BUILDWITH\_RAGEL6][](Src Options...) <a name="macro_BUILDWITH_RAGEL6"></a> +Compile .rl file using Ragel6. + ###### Macro [BUILD\_CATBOOST][](cbmodel cbname) <a name="macro_BUILD_CATBOOST"></a> -Generate catboost model and access code. -cbmodel - CatBoost model file name (\*.cmb). -cbname - name for a variable (of NCatboostCalcer::TCatboostCalcer type) to be available in CPP code. -CatBoost specific macro. - -###### Macro [BUILD\_MN][]([CHECK] [PTR] [MULTI] mninfo mnname) _# matrixnet_ <a name="macro_BUILD_MN"></a> -Generate MatrixNet data and access code using single command. -Alternative macro BUILD\_MNS() works faster and better for large files. - -###### Macro [BUILD\_MNS][]([CHECK] NAME listname mninfos...) _# matrixnet_ <a name="macro_BUILD_MNS"></a> -Generate MatrixNet data and access code using separate commands for support code, interface and data. -Faster version of BUILD\_MN() macro for large files. - -###### Macro [BUILD\_ONLY\_IF][](variables) _# builtin_ <a name="macro_BUILD_ONLY_IF"></a> -Print warning if all variables are false. For example, BUILD\_ONLY\_IF(LINUX WIN32) - -###### Macro [BUILD\_PLNS][](Src...) <a name="macro_BUILD_PLNS"></a> -Generate interface header plnmodels.h for Relev model (PLN). -Relev specific macro. - +Generate catboost model and access code. +cbmodel - CatBoost model file name (\*.cmb). +cbname - name for a variable (of NCatboostCalcer::TCatboostCalcer type) to be available in CPP code. +CatBoost specific macro. + +###### Macro [BUILD\_MN][]([CHECK] [PTR] [MULTI] mninfo mnname) _# matrixnet_ <a name="macro_BUILD_MN"></a> +Generate MatrixNet data and access code using single command. +Alternative macro BUILD\_MNS() works faster and better for large files. + +###### Macro [BUILD\_MNS][]([CHECK] NAME listname mninfos...) _# matrixnet_ <a name="macro_BUILD_MNS"></a> +Generate MatrixNet data and access code using separate commands for support code, interface and data. +Faster version of BUILD\_MN() macro for large files. + +###### Macro [BUILD\_ONLY\_IF][](variables) _# builtin_ <a name="macro_BUILD_ONLY_IF"></a> +Print warning if all variables are false. For example, BUILD\_ONLY\_IF(LINUX WIN32) + +###### Macro [BUILD\_PLNS][](Src...) <a name="macro_BUILD_PLNS"></a> +Generate interface header plnmodels.h for Relev model (PLN). +Relev specific macro. + ###### Macro [BUILD\_YDL\_DESC][](Input Symbol Output) <a name="macro_BUILD_YDL_DESC"></a> Generate a descriptor for a Symbol located in a ydl module Input, and put it to the file Output. @@ -874,35 +874,35 @@ Generate a descriptor for a Symbol located in a ydl module Input, and put it to This will parse file ../types.ydl, generate a descriptor for a symbol Event defined in the said file, and put the descriptor to the Event.ydld. -###### Macro [BUNDLE][](<Dir [NAME Name]>...) <a name="macro_BUNDLE"></a> -Brings build artefact from module Dir under optional Name to the current module (e.g. UNION) -If NAME is not specified, the name of the Dir's build artefact will be preserved -It makes little sense to specify BUNDLE on non-final targets and so this may stop working without prior notice. -Bundle on multimodule will select final target among multimodule variants and will fail if there are none or more than one. - +###### Macro [BUNDLE][](<Dir [NAME Name]>...) <a name="macro_BUNDLE"></a> +Brings build artefact from module Dir under optional Name to the current module (e.g. UNION) +If NAME is not specified, the name of the Dir's build artefact will be preserved +It makes little sense to specify BUNDLE on non-final targets and so this may stop working without prior notice. +Bundle on multimodule will select final target among multimodule variants and will fail if there are none or more than one. + ###### Macro [CC\_REQUIREMENTS][]([cpu: <value>] [ram: <value>]) <a name="macro_CC_REQUIREMENTS"></a> Override CPU and RAM requirements for all C/C++ compilation commands in the module -###### Macro [CFLAGS][]([GLOBAL compiler\_flag]\* compiler\_flags) <a name="macro_CFLAGS"></a> -Add the specified flags to the compilation command of C and C++ files. -@params: GLOBAL - Propagates these flags to dependent projects -Note: remember about the incompatibility flags for clang and cl (to set flags specifically for cl.exe use MSVC\_FLAGS). - -###### Macro [CGO\_CFLAGS][](Flags...) <a name="macro_CGO_CFLAGS"></a> -Compiler flags specific to CGO compilation - -###### Macro [CGO\_LDFLAGS][](Files...) <a name="macro_CGO_LDFLAGS"></a> -Linker flags specific to CGO linking - -###### Macro [CGO\_SRCS][](Files...) <a name="macro_CGO_SRCS"></a> -.go sources to be built with CGO - +###### Macro [CFLAGS][]([GLOBAL compiler\_flag]\* compiler\_flags) <a name="macro_CFLAGS"></a> +Add the specified flags to the compilation command of C and C++ files. +@params: GLOBAL - Propagates these flags to dependent projects +Note: remember about the incompatibility flags for clang and cl (to set flags specifically for cl.exe use MSVC\_FLAGS). + +###### Macro [CGO\_CFLAGS][](Flags...) <a name="macro_CGO_CFLAGS"></a> +Compiler flags specific to CGO compilation + +###### Macro [CGO\_LDFLAGS][](Files...) <a name="macro_CGO_LDFLAGS"></a> +Linker flags specific to CGO linking + +###### Macro [CGO\_SRCS][](Files...) <a name="macro_CGO_SRCS"></a> +.go sources to be built with CGO + ###### Macro [CHECK\_CONTRIB\_CREDITS][] <a name="macro_CHECK_CONTRIB_CREDITS"></a> Not documented yet. ###### Macro [CHECK\_DEPENDENT\_DIRS][](DENY|ALLOW\_ONLY ([ALL|PEERDIRS|GLOB] dir)...) <a name="macro_CHECK_DEPENDENT_DIRS"></a> Specify project transitive dependencies constraints. - + @params: 1. DENY: current module can not depend on module from any specified directory neither directly nor transitively. 2. ALLOW\_ONLY: current module can not depend on module from a dir not specified in the directory list neither directly nor transitively. @@ -916,15 +916,15 @@ Direcory constraints added before either ALL or PEERDIRS modifier is used are tr Note: Can be used multiple times on the same module all specified constraints will be checked. All macro invocation for the same module must use same constraints type (DENY or ALLOW\_ONLY) -###### Macro [CHECK\_JAVA\_DEPS][](<yes|no>) <a name="macro_CHECK_JAVA_DEPS"></a> -Check for different classes with duplicate name in classpath. - -Documentation: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [CLANG\_EMIT\_AST\_CXX][](Input Output Opts...) <a name="macro_CLANG_EMIT_AST_CXX"></a> +###### Macro [CHECK\_JAVA\_DEPS][](<yes|no>) <a name="macro_CHECK_JAVA_DEPS"></a> +Check for different classes with duplicate name in classpath. + +Documentation: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [CLANG\_EMIT\_AST\_CXX][](Input Output Opts...) <a name="macro_CLANG_EMIT_AST_CXX"></a> Emit Clang AST from .cpp file. CXXFLAGS and LLVM\_OPTS are passed in, while CFLAGS and C\_FLAGS\_PLATFORM are not. -Note: Output name is used as is, no extension added. - +Note: Output name is used as is, no extension added. + ###### Macro [COLLECT\_FRONTEND\_FILES][](Varname, Dir) <a name="macro_COLLECT_FRONTEND_FILES"></a> Recursively collect files with typical frontend extensions from Dir and save the result into variable Varname @@ -935,9 +935,9 @@ stores result in the variable with mane specified by first parameter. ###### Macro [COLLECT\_YDB\_API\_SPECS\_LEGACY][](VarName Paths...) _#deprecated_ <a name="macro_COLLECT_YDB_API_SPECS_LEGACY"></a> This macro is ugly hack for legacy YDB go API codegen, any other uses are prohibited -###### Macro [COMPILE\_C\_AS\_CXX][]() <a name="macro_COMPILE_C_AS_CXX"></a> -Compile .c files as .cpp ones within a module. - +###### Macro [COMPILE\_C\_AS\_CXX][]() <a name="macro_COMPILE_C_AS_CXX"></a> +Compile .c files as .cpp ones within a module. + ###### Macro [COMPILE\_LUA][](Src, [NAME <import\_name>]) <a name="macro_COMPILE_LUA"></a> Compile LUA source file to object code using LUA 2.0 Optionally override import name which is by default reflects Src name @@ -951,27 +951,27 @@ Generate and compile .nlg templates (Jinja2-based) and interface for megamind ru Alice-specific macro -###### Macro [COMPILE\_SWIFT\_MODULE][](SRCS{input}[], BRIDGE\_HEADER{input}="", Flags...) <a name="macro_COMPILE_SWIFT_MODULE"></a> -Not documented yet. - -###### Macro [CONFIGURE\_FILE][](from to) <a name="macro_CONFIGURE_FILE"></a> -Copy file with the replacement of configuration variables in form of @ANY\_CONF\_VAR@ with their values. +###### Macro [COMPILE\_SWIFT\_MODULE][](SRCS{input}[], BRIDGE\_HEADER{input}="", Flags...) <a name="macro_COMPILE_SWIFT_MODULE"></a> +Not documented yet. + +###### Macro [CONFIGURE\_FILE][](from to) <a name="macro_CONFIGURE_FILE"></a> +Copy file with the replacement of configuration variables in form of @ANY\_CONF\_VAR@ with their values. The values are collected during configure stage, while replacement itself happens during build stage. -Used implicitly for .in-files processing. - +Used implicitly for .in-files processing. + ###### Macro [CONFTEST\_LOAD\_POLICY\_LOCAL][]() <a name="macro_CONFTEST_LOAD_POLICY_LOCAL"></a> Loads conftest.py files in a way that pytest does it -###### Macro [CONLYFLAGS][]([GLOBAL compiler\_flag]\* compiler\_flags) <a name="macro_CONLYFLAGS"></a> -Add the specified flags to the compilation command of .c (but not .cpp) files. -@params: GLOBAL - Distributes these flags on dependent projects - -###### Macro [COPY][] <a name="macro_COPY"></a> -Not documented yet. - +###### Macro [CONLYFLAGS][]([GLOBAL compiler\_flag]\* compiler\_flags) <a name="macro_CONLYFLAGS"></a> +Add the specified flags to the compilation command of .c (but not .cpp) files. +@params: GLOBAL - Distributes these flags on dependent projects + +###### Macro [COPY][] <a name="macro_COPY"></a> +Not documented yet. + ###### Macro [COPY\_FILE][](File Destination [AUTO] [OUTPUT\_INCLUDES Deps...]) <a name="macro_COPY_FILE"></a> -Copy file to build root. It is possible to change both location and the name. - +Copy file to build root. It is possible to change both location and the name. + Parameters: - File - Source file name. - Destination - Output file name. @@ -1006,191 +1006,191 @@ using Tool. Extra dependencies are passed via DEPS. Define protoc plugin for C++ with given Name that emits code into 2 extra outputs using Tool. Extra dependencies are passed via DEPS. -###### Macro [CREATE\_BUILDINFO\_FOR][](GenHdr) <a name="macro_CREATE_BUILDINFO_FOR"></a> -Creates header file to access some information about build specified via configuration variables. -Unlike CREATE\_SVNVERSION\_FOR() it doesn't take revion information from VCS, it uses revision and SandboxTaskId passed via -D options to ya make - -###### Macro [CREATE\_INIT\_PY\_STRUCTURE][] <a name="macro_CREATE_INIT_PY_STRUCTURE"></a> -Not documented yet. - +###### Macro [CREATE\_BUILDINFO\_FOR][](GenHdr) <a name="macro_CREATE_BUILDINFO_FOR"></a> +Creates header file to access some information about build specified via configuration variables. +Unlike CREATE\_SVNVERSION\_FOR() it doesn't take revion information from VCS, it uses revision and SandboxTaskId passed via -D options to ya make + +###### Macro [CREATE\_INIT\_PY\_STRUCTURE][] <a name="macro_CREATE_INIT_PY_STRUCTURE"></a> +Not documented yet. + ###### Macro [CREDITS\_DISCLAIMER][] <a name="macro_CREDITS_DISCLAIMER"></a> Not documented yet. -###### Macro [CTEMPLATE\_VARNAMES][](File) <a name="macro_CTEMPLATE_VARNAMES"></a> -Generate File.varnames.h using contrib/libs/ctemplate/make\_tpl\_varnames\_h - -Documentation: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/ctemplate/README.md - -###### Macro [CUDA\_NVCC\_FLAGS][](compiler flags) <a name="macro_CUDA_NVCC_FLAGS"></a> -Add the specified flags to the compile line .cu-files. - +###### Macro [CTEMPLATE\_VARNAMES][](File) <a name="macro_CTEMPLATE_VARNAMES"></a> +Generate File.varnames.h using contrib/libs/ctemplate/make\_tpl\_varnames\_h + +Documentation: https://a.yandex-team.ru/arc/trunk/arcadia/contrib/libs/ctemplate/README.md + +###### Macro [CUDA\_NVCC\_FLAGS][](compiler flags) <a name="macro_CUDA_NVCC_FLAGS"></a> +Add the specified flags to the compile line .cu-files. + ###### Macro [CUSTOM\_LINK\_STEP\_SCRIPT][](name) <a name="macro_CUSTOM_LINK_STEP_SCRIPT"></a> Specifies name of a script for custom link step. The scripts should be placed in the build/scripts directory and are subject to review by devtools@. -###### Macro [CXXFLAGS][](compiler\_flags) <a name="macro_CXXFLAGS"></a> -Add the specified flags to the compilation command of .cpp (but not .c) files. - -###### Macro [DARWIN\_SIGNED\_RESOURCE][](Resource, Relpath) <a name="macro_DARWIN_SIGNED_RESOURCE"></a> -Not documented yet. - -###### Macro [DARWIN\_STRINGS\_RESOURCE][](Resource, Relpath) <a name="macro_DARWIN_STRINGS_RESOURCE"></a> -Not documented yet. - -###### Macro [DATA][]([path...]) <a name="macro_DATA"></a> -Specifies the path to the data necessary test. -Valid values are: arcadia/<path> , arcadia\_tests\_data/<path> and sbr://<resource\_id>. -In the latter case resource will be brought to the working directory of the test before it is started - -Used only inside TEST modules. - -Documentation: https://wiki.yandex-team.ru/yatool/test/#dannyeizrepozitorija - -###### Macro [DEB\_VERSION][](File) <a name="macro_DEB_VERSION"></a> -Creates a header file DebianVersion.h define the DEBIAN\_VERSION taken from the File. - -###### Macro [DECIMAL\_MD5\_LOWER\_32\_BITS][](<fileName> [FUNCNAME funcName] [inputs...]) <a name="macro_DECIMAL_MD5_LOWER_32_BITS"></a> -Generates .cpp file <fileName> with one defined function 'const char\* <funcName>() { return "<calculated\_md5\_hash>"; }'. -<calculated\_md5\_hash> will be md5 hash for all inputs passed to this macro. - -###### Macro [DECLARE\_EXTERNAL\_HOST\_RESOURCES\_BUNDLE][](name sbr:id FOR platform1 sbr:id FOR platform2...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_HOST_RESOURCES_BUNDLE"></a> -Associate name with sbr-id on platform. - -Ask devtools@yandex-team.ru if you need more information - -###### Macro [DECLARE\_EXTERNAL\_HOST\_RESOURCES\_PACK][](RESOURCE\_NAME name sbr:id FOR platform1 sbr:id FOR platform2... RESOURCE\_NAME name1 sbr:id1 FOR platform1...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_HOST_RESOURCES_PACK"></a> -Associate name with sbr-id on platform. - -Ask devtools@yandex-team.ru if you need more information - -###### Macro [DECLARE\_EXTERNAL\_RESOURCE][](name sbr:id name1 sbr:id1...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_RESOURCE"></a> -Associate name with sbr-id. - -Ask devtools@yandex-team.ru if you need more information - -###### Macro [DEFAULT][](varname value) _#builtin_ <a name="macro_DEFAULT"></a> -Sets varname to value if value is not set yet - -###### Macro [DEPENDENCY\_MANAGEMENT][](path/to/lib1 path/to/lib2 ...) <a name="macro_DEPENDENCY_MANAGEMENT"></a> -Lock version of the library from the contrib/java at some point, so that all unversioned PEERDIRs to this library refer to the specified version. - -For example, if the moduse has PEERDIR (contrib/java/junit/junit), and - 1. specifies DEPENDENCY\_MANAGEMENT(contrib/java/junit/junit/4.12), - the PEERDIR is automatically replaced by contrib/java/junit/junit/4.12; - 2. doesn't specify DEPENDENCY\_MANAGEMENT, PEERDIR automatically replaced - with the default from contrib/java/junit/junit/ya.make. - These defaults are always there and are supported by maven-import, which puts - there the maximum version available in contrib/java. - -The property is transitive. That is, if module A PEERDIRs module B, and B has PEERDIR(contrib/java/junit/junit), and this junit was replaced by junit-4.12, then junit-4.12 will come to A through B. - -If some module has both DEPENDENCY\_MANAGEMENT(contrib/java/junit/junit/4.12) and PERDIR(contrib/java/junit/junit/4.11), the PEERDIR wins. - -Documentation: https://wiki.yandex-team.ru/yatool/java/ - -###### Macro [DEPENDS][](path1 [path2...]) _# builtin_ <a name="macro_DEPENDS"></a> +###### Macro [CXXFLAGS][](compiler\_flags) <a name="macro_CXXFLAGS"></a> +Add the specified flags to the compilation command of .cpp (but not .c) files. + +###### Macro [DARWIN\_SIGNED\_RESOURCE][](Resource, Relpath) <a name="macro_DARWIN_SIGNED_RESOURCE"></a> +Not documented yet. + +###### Macro [DARWIN\_STRINGS\_RESOURCE][](Resource, Relpath) <a name="macro_DARWIN_STRINGS_RESOURCE"></a> +Not documented yet. + +###### Macro [DATA][]([path...]) <a name="macro_DATA"></a> +Specifies the path to the data necessary test. +Valid values are: arcadia/<path> , arcadia\_tests\_data/<path> and sbr://<resource\_id>. +In the latter case resource will be brought to the working directory of the test before it is started + +Used only inside TEST modules. + +Documentation: https://wiki.yandex-team.ru/yatool/test/#dannyeizrepozitorija + +###### Macro [DEB\_VERSION][](File) <a name="macro_DEB_VERSION"></a> +Creates a header file DebianVersion.h define the DEBIAN\_VERSION taken from the File. + +###### Macro [DECIMAL\_MD5\_LOWER\_32\_BITS][](<fileName> [FUNCNAME funcName] [inputs...]) <a name="macro_DECIMAL_MD5_LOWER_32_BITS"></a> +Generates .cpp file <fileName> with one defined function 'const char\* <funcName>() { return "<calculated\_md5\_hash>"; }'. +<calculated\_md5\_hash> will be md5 hash for all inputs passed to this macro. + +###### Macro [DECLARE\_EXTERNAL\_HOST\_RESOURCES\_BUNDLE][](name sbr:id FOR platform1 sbr:id FOR platform2...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_HOST_RESOURCES_BUNDLE"></a> +Associate name with sbr-id on platform. + +Ask devtools@yandex-team.ru if you need more information + +###### Macro [DECLARE\_EXTERNAL\_HOST\_RESOURCES\_PACK][](RESOURCE\_NAME name sbr:id FOR platform1 sbr:id FOR platform2... RESOURCE\_NAME name1 sbr:id1 FOR platform1...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_HOST_RESOURCES_PACK"></a> +Associate name with sbr-id on platform. + +Ask devtools@yandex-team.ru if you need more information + +###### Macro [DECLARE\_EXTERNAL\_RESOURCE][](name sbr:id name1 sbr:id1...) _#builtin_ <a name="macro_DECLARE_EXTERNAL_RESOURCE"></a> +Associate name with sbr-id. + +Ask devtools@yandex-team.ru if you need more information + +###### Macro [DEFAULT][](varname value) _#builtin_ <a name="macro_DEFAULT"></a> +Sets varname to value if value is not set yet + +###### Macro [DEPENDENCY\_MANAGEMENT][](path/to/lib1 path/to/lib2 ...) <a name="macro_DEPENDENCY_MANAGEMENT"></a> +Lock version of the library from the contrib/java at some point, so that all unversioned PEERDIRs to this library refer to the specified version. + +For example, if the moduse has PEERDIR (contrib/java/junit/junit), and + 1. specifies DEPENDENCY\_MANAGEMENT(contrib/java/junit/junit/4.12), + the PEERDIR is automatically replaced by contrib/java/junit/junit/4.12; + 2. doesn't specify DEPENDENCY\_MANAGEMENT, PEERDIR automatically replaced + with the default from contrib/java/junit/junit/ya.make. + These defaults are always there and are supported by maven-import, which puts + there the maximum version available in contrib/java. + +The property is transitive. That is, if module A PEERDIRs module B, and B has PEERDIR(contrib/java/junit/junit), and this junit was replaced by junit-4.12, then junit-4.12 will come to A through B. + +If some module has both DEPENDENCY\_MANAGEMENT(contrib/java/junit/junit/4.12) and PERDIR(contrib/java/junit/junit/4.11), the PEERDIR wins. + +Documentation: https://wiki.yandex-team.ru/yatool/java/ + +###### Macro [DEPENDS][](path1 [path2...]) _# builtin_ <a name="macro_DEPENDS"></a> Buildable targets that should be brought to the test run. This dependency isonly used when tests run is requested. It will build the specified modules andbring them to the working directory of the test (in their Arcadia paths). Itis reasonable to specify only final targets her (like programs, DLLs orpackages). DEPENDS to UNION is the only exception: UNIONs aretransitively closed at DEPENDS bringing all dependencies to the test. - + DEPENDS on multimodule will select and bring single final target. If more noneor more than one final target available in multimodule DEPENDS to it willproduce configuration error. ###### Macro [DIRECT\_DEPS\_ONLY][] <a name="macro_DIRECT_DEPS_ONLY"></a> Add direct PEERDIR's only in java compile classpath -###### Macro [DISABLE][](varname) _#builtin_ <a name="macro_DISABLE"></a> +###### Macro [DISABLE][](varname) _#builtin_ <a name="macro_DISABLE"></a> Sets varname to 'no' - + ###### Macro [DISABLE\_DATA\_VALIDATION][]() <a name="macro_DISABLE_DATA_VALIDATION"></a> Not documented yet. -###### Macro [DLL\_FOR][](path/to/lib [libname] [major\_ver [minor\_ver]] [EXPORTS symlist\_file]) _#builtin_ <a name="macro_DLL_FOR"></a> -DLL module definition based on specified LIBRARY - +###### Macro [DLL\_FOR][](path/to/lib [libname] [major\_ver [minor\_ver]] [EXPORTS symlist\_file]) _#builtin_ <a name="macro_DLL_FOR"></a> +DLL module definition based on specified LIBRARY + ###### Macro [DOCS\_BUILDER][](tool) <a name="macro_DOCS_BUILDER"></a> Specify docs builder tool. Avalialbe tools: mkdocs and yfm (by default). @see: [DOCS](#multimodule\_DOCS) -###### Macro [DOCS\_CONFIG][](path) <a name="macro_DOCS_CONFIG"></a> +###### Macro [DOCS\_CONFIG][](path) <a name="macro_DOCS_CONFIG"></a> Specify path to config file for DOCS multimodule if it differs from default path. If [DOCS\_BUILDER()](#macro\_DOCS\_BUILDER) is set to "mkdocs" the default path is "%%project\_directory%%/mkdocs.yml". If [DOCS\_BUILDER()](#macro\_DOCS\_BUILDER) is not set or set to "yfm" the default path is "%%project\_directory%%/.yfm". Path must be either Arcadia root relative. - -@see: [DOCS](#multimodule\_DOCS) - -###### Macro [DOCS\_DIR][](path) <a name="macro_DOCS_DIR"></a> -Specify directory with source .md files for DOCS multimodule if it differs from project directory. -Path must be Arcadia root relative. - -@see: [DOCS](#multimodule\_DOCS) - + +@see: [DOCS](#multimodule\_DOCS) + +###### Macro [DOCS\_DIR][](path) <a name="macro_DOCS_DIR"></a> +Specify directory with source .md files for DOCS multimodule if it differs from project directory. +Path must be Arcadia root relative. + +@see: [DOCS](#multimodule\_DOCS) + ###### Macro [DOCS\_INCLUDE\_SOURCES][](path...) <a name="macro_DOCS_INCLUDE_SOURCES"></a> Specify a list of paths to source code files which will be used as text includes in a documentation project. Paths must be Arcadia root relative. @see: [DOCS](#multimodule\_DOCS) -###### Macro [DOCS\_VARS][](variable1=value1 variable2=value2 ...) <a name="macro_DOCS_VARS"></a> -Specify a set of default values of template variables for DOCS multimodule. -There must be no spaces around "=". Values will be treated as strings. - -@see: [DOCS](#multimodule\_DOCS) - -###### Macro [DUMPERF\_CODEGEN][](Prefix) <a name="macro_DUMPERF_CODEGEN"></a> -A special case BASE\_CODEGEN, in which the extsearch/images/robot/tools/dumperf/codegen tool is used - +###### Macro [DOCS\_VARS][](variable1=value1 variable2=value2 ...) <a name="macro_DOCS_VARS"></a> +Specify a set of default values of template variables for DOCS multimodule. +There must be no spaces around "=". Values will be treated as strings. + +@see: [DOCS](#multimodule\_DOCS) + +###### Macro [DUMPERF\_CODEGEN][](Prefix) <a name="macro_DUMPERF_CODEGEN"></a> +A special case BASE\_CODEGEN, in which the extsearch/images/robot/tools/dumperf/codegen tool is used + ###### Macro [DYNAMIC\_LIBRARY\_FROM][](Paths) <a name="macro_DYNAMIC_LIBRARY_FROM"></a> Use specified libraries as sources of DLL -###### Macro IF(condition) .. [ELSE][]IF(other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_ELSE"></a> -Apply macros if none of previous conditions hold - -###### Macro IF(condition) .. [ELSEIF][](other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_ELSEIF"></a> -Apply macros if other\_condition holds while none of previous conditions hold - +###### Macro IF(condition) .. [ELSE][]IF(other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_ELSE"></a> +Apply macros if none of previous conditions hold + +###### Macro IF(condition) .. [ELSEIF][](other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_ELSEIF"></a> +Apply macros if other\_condition holds while none of previous conditions hold + ###### Macro [EMBED\_JAVA\_VCS\_INFO][]() <a name="macro_EMBED_JAVA_VCS_INFO"></a> Embed manifest with vcs info into `EXTERNAL\_JAVA\_LIBRARY` By default this is disabled. -###### Macro [ENABLE][](varname) _#builtin_ <a name="macro_ENABLE"></a> +###### Macro [ENABLE][](varname) _#builtin_ <a name="macro_ENABLE"></a> Sets varname to 'yes' - + ###### Macro [ENABLE\_PREVIEW][]() <a name="macro_ENABLE_PREVIEW"></a> Enable java preview features. -###### Macro [END][]() _# builtin_ <a name="macro_END"></a> -The end of the module - -###### Macro IF(condition) .. ELSEIF(other\_condition) .. ELSE() .. [ENDIF][]() _#builtin_ <a name="macro_ENDIF"></a> -End of conditional construct - -###### Macro [ENV][](key[=value]) <a name="macro_ENV"></a> -Sets env variable key to value (gets value from system env by default). - -###### Macro [EXCLUDE][] <a name="macro_EXCLUDE"></a> -EXCLUDE(prefixes) - -The macro is in development. -Specifies which libraries should be excluded from the classpath. - -###### Macro [EXCLUDE\_TAGS][](tags...) _# builtin_ <a name="macro_EXCLUDE_TAGS"></a> -Instantiate from multimodule all variants except ones with tags listed - -###### Macro [EXPORTS\_SCRIPT][](exports\_file) <a name="macro_EXPORTS_SCRIPT"></a> +###### Macro [END][]() _# builtin_ <a name="macro_END"></a> +The end of the module + +###### Macro IF(condition) .. ELSEIF(other\_condition) .. ELSE() .. [ENDIF][]() _#builtin_ <a name="macro_ENDIF"></a> +End of conditional construct + +###### Macro [ENV][](key[=value]) <a name="macro_ENV"></a> +Sets env variable key to value (gets value from system env by default). + +###### Macro [EXCLUDE][] <a name="macro_EXCLUDE"></a> +EXCLUDE(prefixes) + +The macro is in development. +Specifies which libraries should be excluded from the classpath. + +###### Macro [EXCLUDE\_TAGS][](tags...) _# builtin_ <a name="macro_EXCLUDE_TAGS"></a> +Instantiate from multimodule all variants except ones with tags listed + +###### Macro [EXPORTS\_SCRIPT][](exports\_file) <a name="macro_EXPORTS_SCRIPT"></a> Specify exports script within PROGRAM, DLL and DLL-derived modules. -This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files. +This accepts 2 kind of files: .exports with <lang symbol> pairs and JSON-line .symlist files. The other option use EXPORTS parameter of the DLL module itself. - -@see: [DLL](#module\_DLL) - + +@see: [DLL](#module\_DLL) + ###### Macro [EXPORT\_ALL\_DYNAMIC\_SYMBOLS][]() <a name="macro_EXPORT_ALL_DYNAMIC_SYMBOLS"></a> Export all non-hidden symbols as dynamic when linking a PROGRAM. -###### Macro [EXPORT\_YMAPS\_PROTO][]() _# maps-specific_ <a name="macro_EXPORT_YMAPS_PROTO"></a> -Maps-specific .proto handling: IMPORT\_YMAPS\_PROTO() + maps protobuf namespace. - +###### Macro [EXPORT\_YMAPS\_PROTO][]() _# maps-specific_ <a name="macro_EXPORT_YMAPS_PROTO"></a> +Maps-specific .proto handling: IMPORT\_YMAPS\_PROTO() + maps protobuf namespace. + ###### Macro [EXPOSE][](OutputsToExport...) <a name="macro_EXPOSE"></a> Allows to mark outputs of macro command as unused in the current module but intended to be used in modules consuming current via PEERDIR. @@ -1199,22 +1199,22 @@ TODO(DEVTOOLS-9000) proper implementation needed ###### Macro [EXTERNAL\_JAR][] <a name="macro_EXTERNAL_JAR"></a> Not documented yet. - -###### Macro [EXTERNAL\_RESOURCE][](...) _#builtin, deprecated_ <a name="macro_EXTERNAL_RESOURCE"></a> -Don't use this. Use RESOURCE\_LIBRARY or FROM\_SANDBOX instead - + +###### Macro [EXTERNAL\_RESOURCE][](...) _#builtin, deprecated_ <a name="macro_EXTERNAL_RESOURCE"></a> +Don't use this. Use RESOURCE\_LIBRARY or FROM\_SANDBOX instead + ###### Macro [EXTRADIR][](...) _#builtin, deprecated_ <a name="macro_EXTRADIR"></a> -Ignored - -###### Macro [EXTRALIBS][](liblist) _# builtin_ <a name="macro_EXTRALIBS"></a> -Add external dynamic libraries during program linkage stage - -###### Macro [EXTRALIBS\_STATIC][](Libs...) <a name="macro_EXTRALIBS_STATIC"></a> -Add the specified external static libraries to the program link - -###### Macro [FAT\_RESOURCE][] <a name="macro_FAT_RESOURCE"></a> -Not documented yet. - +Ignored + +###### Macro [EXTRALIBS][](liblist) _# builtin_ <a name="macro_EXTRALIBS"></a> +Add external dynamic libraries during program linkage stage + +###### Macro [EXTRALIBS\_STATIC][](Libs...) <a name="macro_EXTRALIBS_STATIC"></a> +Add the specified external static libraries to the program link + +###### Macro [FAT\_RESOURCE][] <a name="macro_FAT_RESOURCE"></a> +Not documented yet. + ###### Macro [FBS\_NAMESPACE][](NAMESPACE, PATH...) <a name="macro_FBS_NAMESPACE"></a> Not documented yet. @@ -1224,49 +1224,49 @@ Not documented yet. ###### Macro [FLATC\_FLAGS][](flags...) <a name="macro_FLATC_FLAGS"></a> Add flags to flatc command line -###### Macro [FLAT\_JOIN\_SRCS\_GLOBAL][](Out Src...) <a name="macro_FLAT_JOIN_SRCS_GLOBAL"></a> -Join set of sources into single file named Out and send it for further processing as if it were listed as SRCS(GLOBAL Out). -This macro places all files into single file, so will work with any sources. +###### Macro [FLAT\_JOIN\_SRCS\_GLOBAL][](Out Src...) <a name="macro_FLAT_JOIN_SRCS_GLOBAL"></a> +Join set of sources into single file named Out and send it for further processing as if it were listed as SRCS(GLOBAL Out). +This macro places all files into single file, so will work with any sources. You should specify file name with the extension as Out. Further processing will be done according to this extension. - -###### Macro [FORK\_SUBTESTS][]() <a name="macro_FORK_SUBTESTS"></a> -Splits the test run in chunks on subtests. -The number of chunks can be overridden using the macro SPLIT\_FACTOR. - + +###### Macro [FORK\_SUBTESTS][]() <a name="macro_FORK_SUBTESTS"></a> +Splits the test run in chunks on subtests. +The number of chunks can be overridden using the macro SPLIT\_FACTOR. + Allows to run tests in parallel. Supported in UNITTEST, JTEST/JUNIT5 and PY2TEST/PY3TEST modules. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [FORK\_TESTS][]() <a name="macro_FORK_TESTS"></a> -Splits a test run on chunks by test classes. -The number of chunks can be overridden using the macro SPLIT\_FACTOR. - + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [FORK\_TESTS][]() <a name="macro_FORK_TESTS"></a> +Splits a test run on chunks by test classes. +The number of chunks can be overridden using the macro SPLIT\_FACTOR. + Allows to run tests in parallel. Supported in UNITTEST, JTEST/JUNIT5 and PY2TEST/PY3TEST modules. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [FORK\_TEST\_FILES][]() <a name="macro_FORK_TEST_FILES"></a> + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [FORK\_TEST\_FILES][]() <a name="macro_FORK_TEST_FILES"></a> Only for PY2TEST and PY3TEST: splits a file executable with the tests on chunks in the files listed in TEST\_SRCS -Compatible with FORK\_(SUB)TESTS. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - +Compatible with FORK\_(SUB)TESTS. + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + ###### Macro [FROM\_ARCHIVE][](Src [RENAME <resource files>] OUT\_[NOAUTO] <output files> [EXECUTABLE]) <a name="macro_FROM_ARCHIVE"></a> Process file archive as [FROM\_SANDBOX()](#macro\_FROM\_SANDBOX). ###### Macro [FROM\_MDS][]([FILE] key [RENAME <resource files>] OUT\_[NOAUTO] <output files> [EXECUTABLE]) <a name="macro_FROM_MDS"></a> Download resource from MDS with the specified key and process like [FROM\_SANDBOX()](#macro\_FROM\_SANDBOX). - + ###### Macro [FROM\_NPM][](NAME VERSION SKY\_ID INTEGRITY INTEGRITY\_ALGO TARBALL\_PATH) <a name="macro_FROM_NPM"></a> Not documented yet. ###### Macro [FROM\_SANDBOX][]([FILE] resource\_id [AUTOUPDATED script] [RENAME <resource files>] OUT\_[NOAUTO] <output files> [EXECUTABLE] [OUTPUT\_INCLUDES <include files>]) <a name="macro_FROM_SANDBOX"></a> Download the resource from the Sandbox, unpack (if not explicitly specified word FILE) and add OUT files to the build. EXECUTABLE makes them executable. You may specify extra dependencies that output files bring using OUTPUT\_INCLUDES. The change of these may e.g. lead to recompilation of .cpp files extracted from resource. -If there is no default processing for OUT files or you need process them specially use OUT\_NOAUTO instead of OUT. - -It is disallowed to specify directory as OUT/OUT\_NOAUTO since all outputs of commands shall be known to build system. - +If there is no default processing for OUT files or you need process them specially use OUT\_NOAUTO instead of OUT. + +It is disallowed to specify directory as OUT/OUT\_NOAUTO since all outputs of commands shall be known to build system. + RENAME renames files to the corresponding OUT and OUT\_NOAUTO outputs: FROM\_SANDBOX(resource\_id RENAME in\_file1 in\_file2 OUT out\_file1 out\_file2 out\_file3) FROM\_SANDBOX(resource\_id RENAME in\_file1 OUT out\_file1 RENAME in\_file2 OUT out\_file2) @@ -1274,127 +1274,127 @@ FROM\_SANDBOX(FILE resource\_id RENAME resource\_file OUT out\_name) RENAME RESOURCE allows to rename the resource without specifying its file name. -If AUTOUPDATED is specified than macro will be regularly updated according to autoupdate script. The dedicated Sandbox task scans the arcadia and +If AUTOUPDATED is specified than macro will be regularly updated according to autoupdate script. The dedicated Sandbox task scans the arcadia and changes resource\_ids in such macros if newer resource of specified type is available. Note that the task seeks AUTOUPDATED in specific position, -so you shall place it immediately after resource\_id. - -###### Macro [FUZZ\_DICTS][](path1 [path2...]) <a name="macro_FUZZ_DICTS"></a> -Allows you to specify dictionaries, relative to the root of Arcadia, which will be used in Fuzzing. -Libfuzzer and AFL use a single syntax for dictionary descriptions. -Should only be used in FUZZ modules. - -Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ - -###### Macro [FUZZ\_OPTS][](opt1 [Opt2...]) <a name="macro_FUZZ_OPTS"></a> -Overrides or adds options to the corpus mining and fuzzer run. -Currently supported only Libfuzzer, so you should use the options for it. -Should only be used in FUZZ modules. - -@example: - - FUZZ_OPTS ( - -max_len=1024 - -rss_limit_mb=8192 - ) - -Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ - -###### Macro [GENERATED\_SRCS][](srcs... PARSE\_META\_FROM cpp\_srcs... [OUTPUT\_INCLUDES output\_includes...] [OPTIONS]) <a name="macro_GENERATED_SRCS"></a> -Generate sources using Jinja 2 template engine. - -srcs... - list of text files which will be generated during build time by templates. Each template must be - placed to the place in source tree where corresponding source file should be generated. Name of +so you shall place it immediately after resource\_id. + +###### Macro [FUZZ\_DICTS][](path1 [path2...]) <a name="macro_FUZZ_DICTS"></a> +Allows you to specify dictionaries, relative to the root of Arcadia, which will be used in Fuzzing. +Libfuzzer and AFL use a single syntax for dictionary descriptions. +Should only be used in FUZZ modules. + +Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ + +###### Macro [FUZZ\_OPTS][](opt1 [Opt2...]) <a name="macro_FUZZ_OPTS"></a> +Overrides or adds options to the corpus mining and fuzzer run. +Currently supported only Libfuzzer, so you should use the options for it. +Should only be used in FUZZ modules. + +@example: + + FUZZ_OPTS ( + -max_len=1024 + -rss_limit_mb=8192 + ) + +Documentation: https://wiki.yandex-team.ru/yatool/fuzzing/ + +###### Macro [GENERATED\_SRCS][](srcs... PARSE\_META\_FROM cpp\_srcs... [OUTPUT\_INCLUDES output\_includes...] [OPTIONS]) <a name="macro_GENERATED_SRCS"></a> +Generate sources using Jinja 2 template engine. + +srcs... - list of text files which will be generated during build time by templates. Each template must be + placed to the place in source tree where corresponding source file should be generated. Name of template must be "<name\_of\_src\_file>.markettemplate". For example if you want to generate file "example.cpp" then template should be named "example.cpp.markettemplate". -PARSE\_META\_FROM cpp\_srcs... - list of C++ source files (.cpp, .h) which will be parsed using clang library - and metainformation extracted from the files will be made available for templates. Example of - template code fragment using metainformation: {{ meta.objects["@N@std@S@string"].name }} -OUTPUT\_INCLUDES output\_includes... - in cases when build system parser fails to determine all headers - which generated files include, you can specify additional headers here. In a normal situation this should - not be needed and this feature could be removed in the future. -OPTIONS - additional options for code\_generator utility - -Examples of templates can be found in directory market/tools/code\_generator/templates. -Metainformation does not contain entries for every object declared in C++ files specified in PARSE\_META\_FROM -parameter. To include some object into consideration you need to mark it by attribute. Attributes can -automatically add more attributes to dependent objects. This behavior depends on attribute definition. - -More information will be available (eventually:) here: https://wiki.yandex-team.ru/Users/denisk/codegenerator/ - -###### Macro [GENERATE\_ENUM\_SERIALIZATION][](File.h) <a name="macro_GENERATE_ENUM_SERIALIZATION"></a> -Create serialization support for enumeration members defined in the header (String <-> Enum conversions) and compile it into the module. - -Documentation: https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles/ - -###### Macro [GENERATE\_ENUM\_SERIALIZATION\_WITH\_HEADER][](File.h) <a name="macro_GENERATE_ENUM_SERIALIZATION_WITH_HEADER"></a> -Create serialization support for enumeration members defined in the header (String <-> Enum conversions) and compile it into the module -Provide access to serialization functions via generated header File\_serialized.h - -Documentation: https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles/ - -###### Macro [GENERATE\_PY\_PROTOS][](ProtoFiles...) _# deprecated_ <a name="macro_GENERATE_PY_PROTOS"></a> -Generate python bindings for protobuf files. -Macro is obsolete and not recommended for use! - -###### Macro [GENERATE\_SCRIPT][] <a name="macro_GENERATE_SCRIPT"></a> -heretic@ promised to make tutorial here -Don't forget -Feel free to remind - -###### Macro [GEN\_SCHEEME2][](scheeme\_name from\_file dependent\_files...) <a name="macro_GEN_SCHEEME2"></a> -Generates a C++ description for structure(contains the field RecordSig) in the specified file (and connected). - -1. ${scheeme\_name}.inc - the name of the generated file. -2. Use an environment variable - DATAWORK\_SCHEEME\_EXPORT\_FLAGS that allows to specify flags to tools/structparser - -@example: - - SET(DATAWORK_SCHEEME_EXPORT_FLAGS --final_only -m "::") - -all options are passed to structparser (in this example --final\_only - do not export heirs with public base that contains the required field,,- m "::" only from the root namespace) -sets in extra option - -@example: - - SET(EXTRACT_STRUCT_INFO_FLAGS -f \"const static ui32 RecordSig\" - -u \"RecordSig\" -n${scheeme_name}SchemeInfo ----gcc44_no_typename no_complex_overloaded_func_export - ${DATAWORK_SCHEEME_EXPORT_FLAGS}) - -for compatibility with C++ compiler and the external environment. -See tools/structparser for more details. - -###### Macro [GLOBAL\_SRCS][](filenames...) <a name="macro_GLOBAL_SRCS"></a> -Make all source files listed as GLOBAL. -Call to GLOBAL\_SRCS macro is equivalent to call to SRCS macro when each source file is marked with GLOBAL keyword. -Arcadia root relative or project dir relative paths are supported for filenames arguments. GLOBAL keyword is not -recognized for GLOBAL\_SRCS in contrast to SRCS macro. - -@example: -Consider the file to ya.make: - - LIBRARY() - GLOBAL_SRCS(foo.cpp bar.cpp) - END() - -@see: [SRCS()](#macro\_SRCS) - -###### Macro [GO\_ASM\_FLAGS][](flags) <a name="macro_GO_ASM_FLAGS"></a> +PARSE\_META\_FROM cpp\_srcs... - list of C++ source files (.cpp, .h) which will be parsed using clang library + and metainformation extracted from the files will be made available for templates. Example of + template code fragment using metainformation: {{ meta.objects["@N@std@S@string"].name }} +OUTPUT\_INCLUDES output\_includes... - in cases when build system parser fails to determine all headers + which generated files include, you can specify additional headers here. In a normal situation this should + not be needed and this feature could be removed in the future. +OPTIONS - additional options for code\_generator utility + +Examples of templates can be found in directory market/tools/code\_generator/templates. +Metainformation does not contain entries for every object declared in C++ files specified in PARSE\_META\_FROM +parameter. To include some object into consideration you need to mark it by attribute. Attributes can +automatically add more attributes to dependent objects. This behavior depends on attribute definition. + +More information will be available (eventually:) here: https://wiki.yandex-team.ru/Users/denisk/codegenerator/ + +###### Macro [GENERATE\_ENUM\_SERIALIZATION][](File.h) <a name="macro_GENERATE_ENUM_SERIALIZATION"></a> +Create serialization support for enumeration members defined in the header (String <-> Enum conversions) and compile it into the module. + +Documentation: https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles/ + +###### Macro [GENERATE\_ENUM\_SERIALIZATION\_WITH\_HEADER][](File.h) <a name="macro_GENERATE_ENUM_SERIALIZATION_WITH_HEADER"></a> +Create serialization support for enumeration members defined in the header (String <-> Enum conversions) and compile it into the module +Provide access to serialization functions via generated header File\_serialized.h + +Documentation: https://wiki.yandex-team.ru/yatool/HowToWriteYaMakeFiles/ + +###### Macro [GENERATE\_PY\_PROTOS][](ProtoFiles...) _# deprecated_ <a name="macro_GENERATE_PY_PROTOS"></a> +Generate python bindings for protobuf files. +Macro is obsolete and not recommended for use! + +###### Macro [GENERATE\_SCRIPT][] <a name="macro_GENERATE_SCRIPT"></a> +heretic@ promised to make tutorial here +Don't forget +Feel free to remind + +###### Macro [GEN\_SCHEEME2][](scheeme\_name from\_file dependent\_files...) <a name="macro_GEN_SCHEEME2"></a> +Generates a C++ description for structure(contains the field RecordSig) in the specified file (and connected). + +1. ${scheeme\_name}.inc - the name of the generated file. +2. Use an environment variable - DATAWORK\_SCHEEME\_EXPORT\_FLAGS that allows to specify flags to tools/structparser + +@example: + + SET(DATAWORK_SCHEEME_EXPORT_FLAGS --final_only -m "::") + +all options are passed to structparser (in this example --final\_only - do not export heirs with public base that contains the required field,,- m "::" only from the root namespace) +sets in extra option + +@example: + + SET(EXTRACT_STRUCT_INFO_FLAGS -f \"const static ui32 RecordSig\" + -u \"RecordSig\" -n${scheeme_name}SchemeInfo ----gcc44_no_typename no_complex_overloaded_func_export + ${DATAWORK_SCHEEME_EXPORT_FLAGS}) + +for compatibility with C++ compiler and the external environment. +See tools/structparser for more details. + +###### Macro [GLOBAL\_SRCS][](filenames...) <a name="macro_GLOBAL_SRCS"></a> +Make all source files listed as GLOBAL. +Call to GLOBAL\_SRCS macro is equivalent to call to SRCS macro when each source file is marked with GLOBAL keyword. +Arcadia root relative or project dir relative paths are supported for filenames arguments. GLOBAL keyword is not +recognized for GLOBAL\_SRCS in contrast to SRCS macro. + +@example: +Consider the file to ya.make: + + LIBRARY() + GLOBAL_SRCS(foo.cpp bar.cpp) + END() + +@see: [SRCS()](#macro\_SRCS) + +###### Macro [GO\_ASM\_FLAGS][](flags) <a name="macro_GO_ASM_FLAGS"></a> Add the specified flags to the go asm compile command line. - + ###### Macro [GO\_BENCH\_TIMEOUT][](x) <a name="macro_GO_BENCH_TIMEOUT"></a> Sets timeout in seconds for 1 Benchmark in go benchmark suite Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ -###### Macro [GO\_CGO1\_FLAGS][](flags) <a name="macro_GO_CGO1_FLAGS"></a> -Add the specified flags to the go cgo compile command line. - -###### Macro [GO\_CGO2\_FLAGS][](flags) <a name="macro_GO_CGO2_FLAGS"></a> -Add the specified flags to the go cgo compile command line. - -###### Macro [GO\_COMPILE\_FLAGS][](flags) <a name="macro_GO_COMPILE_FLAGS"></a> -Add the specified flags to the go compile command line. - +###### Macro [GO\_CGO1\_FLAGS][](flags) <a name="macro_GO_CGO1_FLAGS"></a> +Add the specified flags to the go cgo compile command line. + +###### Macro [GO\_CGO2\_FLAGS][](flags) <a name="macro_GO_CGO2_FLAGS"></a> +Add the specified flags to the go cgo compile command line. + +###### Macro [GO\_COMPILE\_FLAGS][](flags) <a name="macro_GO_COMPILE_FLAGS"></a> +Add the specified flags to the go compile command line. + ###### Macro [GO\_EMBED\_DIR][](DIR) <a name="macro_GO_EMBED_DIR"></a> Define an embed directory DIR. @@ -1407,21 +1407,21 @@ Define an embed directory DIR for internal go tests. ###### Macro GO\_XTEST\_EMBED\_DIR(DIR) <a name="macro_GO_EMBED_XTEST_DIR"></a> Define an embed directory DIR for external go tests. -###### Macro [GO\_FAKE\_OUTPUT][](go-src-files...) <a name="macro_GO_FAKE_OUTPUT"></a> -Not documented yet. - +###### Macro [GO\_FAKE\_OUTPUT][](go-src-files...) <a name="macro_GO_FAKE_OUTPUT"></a> +Not documented yet. + ###### Macro [GO\_GRPC\_GATEWAY\_SRCS][]() <a name="macro_GO_GRPC_GATEWAY_SRCS"></a> Use of grpc-gateway plugin (Supported for Go only). ###### Macro [GO\_GRPC\_GATEWAY\_SWAGGER\_SRCS][]() <a name="macro_GO_GRPC_GATEWAY_SWAGGER_SRCS"></a> Use of grpc-gateway plugin w/ swagger emission (Supported for Go only). -###### Macro [GO\_LDFLAGS][](Flags...) <a name="macro_GO_LDFLAGS"></a> -Link flags for GO\_PROGRAM linking from .go sources - -###### Macro [GO\_LINK\_FLAGS][](flags) <a name="macro_GO_LINK_FLAGS"></a> -Add the specified flags to the go link command line. - +###### Macro [GO\_LDFLAGS][](Flags...) <a name="macro_GO_LDFLAGS"></a> +Link flags for GO\_PROGRAM linking from .go sources + +###### Macro [GO\_LINK\_FLAGS][](flags) <a name="macro_GO_LINK_FLAGS"></a> +Add the specified flags to the go link command line. + ###### Macro [GO\_MOCKGEN\_FROM][](Path) <a name="macro_GO_MOCKGEN_FROM"></a> Not documented yet. @@ -1434,9 +1434,9 @@ Not documented yet. ###### Macro [GO\_MOCKGEN\_TYPES][](First, Rest...) <a name="macro_GO_MOCKGEN_TYPES"></a> Not documented yet. -###### Macro [GO\_PACKAGE\_NAME][](Name) <a name="macro_GO_PACKAGE_NAME"></a> -Override name of a Go package. - +###### Macro [GO\_PACKAGE\_NAME][](Name) <a name="macro_GO_PACKAGE_NAME"></a> +Override name of a Go package. + ###### Macro [GO\_PROTO\_PLUGIN][](Name Ext Tool [DEPS dependencies...]) <a name="macro_GO_PROTO_PLUGIN"></a> Define protoc plugin for GO with given Name that emits extra output with provided extension Ext using Tool. Extra dependencies are passed via DEPS. @@ -1448,26 +1448,26 @@ NB! Subtests are not taken into account! ###### Macro [GO\_TEST\_EMBED\_PATTERN][](PATTERN) <a name="macro_GO_TEST_EMBED_PATTERN"></a> Define an embed pattern for internal go tests. -###### Macro [GO\_TEST\_FOR][](path/to/module) _#builtin_ <a name="macro_GO_TEST_FOR"></a> -Produces go test for specified module - -###### Macro [GO\_TEST\_SRCS][](Files...) <a name="macro_GO_TEST_SRCS"></a> -.go sources for internal tests of a module - +###### Macro [GO\_TEST\_FOR][](path/to/module) _#builtin_ <a name="macro_GO_TEST_FOR"></a> +Produces go test for specified module + +###### Macro [GO\_TEST\_SRCS][](Files...) <a name="macro_GO_TEST_SRCS"></a> +.go sources for internal tests of a module + ###### Macro [GO\_XTEST\_EMBED\_PATTERN][](PATTERN) <a name="macro_GO_XTEST_EMBED_PATTERN"></a> Define an embed pattern for external go tests. -###### Macro [GO\_XTEST\_SRCS][](Files...) <a name="macro_GO_XTEST_SRCS"></a> -.go sources for external tests of a module - -###### Macro [GRPC][]() <a name="macro_GRPC"></a> -Emit GRPC code for all .proto files in a PROTO\_LIBRARY. -This works for all available PROTO\_LIBRARY versions (C++, Python 2.x, Pyton 3.x, Java and Go). - -###### Macro [IDEA\_EXCLUDE\_DIRS][](<excluded dirs>) <a name="macro_IDEA_EXCLUDE_DIRS"></a> -Exclude specified directories from an idea project generated by ya ide idea -Have no effect on regular build. - +###### Macro [GO\_XTEST\_SRCS][](Files...) <a name="macro_GO_XTEST_SRCS"></a> +.go sources for external tests of a module + +###### Macro [GRPC][]() <a name="macro_GRPC"></a> +Emit GRPC code for all .proto files in a PROTO\_LIBRARY. +This works for all available PROTO\_LIBRARY versions (C++, Python 2.x, Pyton 3.x, Java and Go). + +###### Macro [IDEA\_EXCLUDE\_DIRS][](<excluded dirs>) <a name="macro_IDEA_EXCLUDE_DIRS"></a> +Exclude specified directories from an idea project generated by ya ide idea +Have no effect on regular build. + ###### Macro [IDEA\_JAR\_SRCS][](Args...) <a name="macro_IDEA_JAR_SRCS"></a> Not documented yet. @@ -1475,36 +1475,36 @@ Not documented yet. Set module name in an idea project generated by ya ide idea Have no effect on regular build. -###### Macro [IDEA\_RESOURCE\_DIRS][](<additional dirs>) <a name="macro_IDEA_RESOURCE_DIRS"></a> -Set specified resource directories in an idea project generated by ya ide idea -Have no effect on regular build. - -###### Macro [IF][](condition) .. ELSEIF(other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_IF"></a> -Apply macros if condition holds - -###### Macro [INCLUDE][](filename) _#builtin_ <a name="macro_INCLUDE"></a> -Include file textually and process it as a part of the ya.make - -###### Macro [INCLUDE\_TAGS][](tags...) _# builtin_ <a name="macro_INCLUDE_TAGS"></a> -Additionally instantiate from multimodule all variants with tags listed (overrides default) - -###### Macro [INDUCED\_DEPS][](Extension Path...) _#builtin_ <a name="macro_INDUCED_DEPS"></a> +###### Macro [IDEA\_RESOURCE\_DIRS][](<additional dirs>) <a name="macro_IDEA_RESOURCE_DIRS"></a> +Set specified resource directories in an idea project generated by ya ide idea +Have no effect on regular build. + +###### Macro [IF][](condition) .. ELSEIF(other\_condition) .. ELSE() .. ENDIF() _#builtin_ <a name="macro_IF"></a> +Apply macros if condition holds + +###### Macro [INCLUDE][](filename) _#builtin_ <a name="macro_INCLUDE"></a> +Include file textually and process it as a part of the ya.make + +###### Macro [INCLUDE\_TAGS][](tags...) _# builtin_ <a name="macro_INCLUDE_TAGS"></a> +Additionally instantiate from multimodule all variants with tags listed (overrides default) + +###### Macro [INDUCED\_DEPS][](Extension Path...) _#builtin_ <a name="macro_INDUCED_DEPS"></a> States that files wih the Extension generated by the PROGRAM will depend on files in Path. This only useful in PROGRAM and similar modules. It will be applied if the PROGRAM is used in RUN\_PROGRAM macro. All Paths specified must be absolute arcadia paths i.e. start with ${ARCADIA\_ROOT} ${ARCADIA\_BUILD\_ROOT}, ${CURDIR} or ${BINDIR}. - -###### Macro [IOS\_APP\_ASSETS\_FLAGS][](Flags...) <a name="macro_IOS_APP_ASSETS_FLAGS"></a> -Not documented yet. - -###### Macro [IOS\_APP\_COMMON\_FLAGS][](Flags...) <a name="macro_IOS_APP_COMMON_FLAGS"></a> -Not documented yet. - -###### Macro [IOS\_APP\_SETTINGS][] <a name="macro_IOS_APP_SETTINGS"></a> -Not documented yet. - -###### Macro [IOS\_ASSETS][] <a name="macro_IOS_ASSETS"></a> -Not documented yet. - + +###### Macro [IOS\_APP\_ASSETS\_FLAGS][](Flags...) <a name="macro_IOS_APP_ASSETS_FLAGS"></a> +Not documented yet. + +###### Macro [IOS\_APP\_COMMON\_FLAGS][](Flags...) <a name="macro_IOS_APP_COMMON_FLAGS"></a> +Not documented yet. + +###### Macro [IOS\_APP\_SETTINGS][] <a name="macro_IOS_APP_SETTINGS"></a> +Not documented yet. + +###### Macro [IOS\_ASSETS][] <a name="macro_IOS_ASSETS"></a> +Not documented yet. + ###### Macro [JAR\_ANNOTATION\_PROCESSOR][](Classes...) <a name="macro_JAR_ANNOTATION_PROCESSOR"></a> Not documented yet. @@ -1519,9 +1519,9 @@ Filter .jar file content: keep only matched files ###### Macro [JAR\_RESOURCE][](Id) <a name="macro_JAR_RESOURCE"></a> Not documented yet. -###### Macro [JAVAC\_FLAGS][](Args...) <a name="macro_JAVAC_FLAGS"></a> -Set additional Java compilation flags. - +###### Macro [JAVAC\_FLAGS][](Args...) <a name="macro_JAVAC_FLAGS"></a> +Set additional Java compilation flags. + ###### Macro [JAVA\_DEPENDENCIES\_CONFIGURATION][](Vetos...) <a name="macro_JAVA_DEPENDENCIES_CONFIGURATION"></a> Validate contrib/java dependencies Valid arguments @@ -1535,12 +1535,12 @@ REQUIRE\_DM - all dependencies must be specified in DEPENDENCY\_MANAGEMENT (tran ###### Macro [JAVA\_EXTERNAL\_DEPENDENCIES][](file1 file2 ...) <a name="macro_JAVA_EXTERNAL_DEPENDENCIES"></a> Add non-source java external build dependency (like lombok config file) -###### Macro [JAVA\_IGNORE\_CLASSPATH\_CLASH\_FOR][]([classes]) <a name="macro_JAVA_IGNORE_CLASSPATH_CLASH_FOR"></a> -Ignore classpath clash test fails for classes - -###### Macro [JAVA\_MODULE][] <a name="macro_JAVA_MODULE"></a> -Not documented yet. - +###### Macro [JAVA\_IGNORE\_CLASSPATH\_CLASH\_FOR][]([classes]) <a name="macro_JAVA_IGNORE_CLASSPATH_CLASH_FOR"></a> +Ignore classpath clash test fails for classes + +###### Macro [JAVA\_MODULE][] <a name="macro_JAVA_MODULE"></a> +Not documented yet. + ###### Macro [JAVA\_PROTO\_PLUGIN][](Name Tool DEPS <Dependencies>) <a name="macro_JAVA_PROTO_PLUGIN"></a> Define protoc plugin for Java with given Name that emits extra outputs using Tool. Extra dependencies are passed via DEPS @@ -1551,57 +1551,57 @@ Override CPU and RAM requirements for all C/C++ compilation commands in the modu ###### Macro [JAVA\_RESOURCE][](JAR, SOURCES="") <a name="macro_JAVA_RESOURCE"></a> Not documented yet. -###### Macro [JAVA\_SRCS][](srcs) <a name="macro_JAVA_SRCS"></a> -Specify java source files and resources. A macro can be contained in any of four java modules. -Keywords: -1. X SRCDIR - specify the directory x is performed relatively to search the source code for these patterns. If there is no SRCDIR, the source will be searched relative to the module directory. -2. PACKAGE\_PREFIX x - use if source paths relative to the SRCDIR does not coincide with the full class names. For example, if all sources of module are in the same package, you can create a directory package/name , and just put the source code in the SRCDIR and specify PACKAGE\_PREFIX package.name. - -@example: - - example/ya.make - - JAVA_PROGRAM() - JAVA_SRCS(SRCDIR src/main/java **/*) - END() - - - example/src/main/java/ru/yandex/example/HelloWorld.java - - package ru.yandex.example; - public class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } - } - -Documentation: https://wiki.yandex-team.ru/yatool/java/#javasrcs - -###### Macro [JAVA\_TEST][] <a name="macro_JAVA_TEST"></a> -Not documented yet. - -###### Macro [JAVA\_TEST\_DEPS][] <a name="macro_JAVA_TEST_DEPS"></a> -Not documented yet. - +###### Macro [JAVA\_SRCS][](srcs) <a name="macro_JAVA_SRCS"></a> +Specify java source files and resources. A macro can be contained in any of four java modules. +Keywords: +1. X SRCDIR - specify the directory x is performed relatively to search the source code for these patterns. If there is no SRCDIR, the source will be searched relative to the module directory. +2. PACKAGE\_PREFIX x - use if source paths relative to the SRCDIR does not coincide with the full class names. For example, if all sources of module are in the same package, you can create a directory package/name , and just put the source code in the SRCDIR and specify PACKAGE\_PREFIX package.name. + +@example: + - example/ya.make + + JAVA_PROGRAM() + JAVA_SRCS(SRCDIR src/main/java **/*) + END() + + - example/src/main/java/ru/yandex/example/HelloWorld.java + + package ru.yandex.example; + public class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + +Documentation: https://wiki.yandex-team.ru/yatool/java/#javasrcs + +###### Macro [JAVA\_TEST][] <a name="macro_JAVA_TEST"></a> +Not documented yet. + +###### Macro [JAVA\_TEST\_DEPS][] <a name="macro_JAVA_TEST_DEPS"></a> +Not documented yet. + ###### Macro MODULE\_JDK(Version) <a name="macro_JDK_VERSION"></a> Specify JDK version for module -###### Macro [JOINSRC][]() _# deprecated, does-nothing_ <a name="macro_JOINSRC"></a> -This macro currently does nothing. Use JOIN\_SRCS and similar macros to make one file of set of sources. - -###### Macro [JOIN\_SRCS][](Out Src...) <a name="macro_JOIN_SRCS"></a> -Join set of sources into single file named Out and send it for further processing. -This macro doesn't place all file into Out, it emits #include<Src>... Use the for C++ source files only. -You should specify file name with the extension as Out. Futher processing will be done according this extension. - -###### Macro [JOIN\_SRCS\_GLOBAL][](Out Src...) <a name="macro_JOIN_SRCS_GLOBAL"></a> -Join set of sources into single file named Out and send it for further processing as if it were listed as SRCS(GLOBAL Out). -This macro doesn't place all file into Out, it emits #include<Src>... Use the for C++ source files only. +###### Macro [JOINSRC][]() _# deprecated, does-nothing_ <a name="macro_JOINSRC"></a> +This macro currently does nothing. Use JOIN\_SRCS and similar macros to make one file of set of sources. + +###### Macro [JOIN\_SRCS][](Out Src...) <a name="macro_JOIN_SRCS"></a> +Join set of sources into single file named Out and send it for further processing. +This macro doesn't place all file into Out, it emits #include<Src>... Use the for C++ source files only. +You should specify file name with the extension as Out. Futher processing will be done according this extension. + +###### Macro [JOIN\_SRCS\_GLOBAL][](Out Src...) <a name="macro_JOIN_SRCS_GLOBAL"></a> +Join set of sources into single file named Out and send it for further processing as if it were listed as SRCS(GLOBAL Out). +This macro doesn't place all file into Out, it emits #include<Src>... Use the for C++ source files only. You should specify file name with the extension as Out. Further processing will be done according to this extension. - -###### Macro [JVM\_ARGS][](Args...) <a name="macro_JVM_ARGS"></a> -Arguments to run Java programs in tests. - -Documentation: https://wiki.yandex-team.ru/yatool/test/ - + +###### Macro [JVM\_ARGS][](Args...) <a name="macro_JVM_ARGS"></a> +Arguments to run Java programs in tests. + +Documentation: https://wiki.yandex-team.ru/yatool/test/ + ###### Macro [KOTLINC\_FLAGS][](-flags) <a name="macro_KOTLINC_FLAGS"></a> Set additional Kotlin compilation flags. @@ -1610,23 +1610,23 @@ Use large file ether from working copy or from remote storage via placeholder <F If <File> is present locally (and not a symlink!) it will be copied to build directory. Otherwise macro will try to locate <File>.external, parse it retrieve ot during build phase. -###### Macro [LDFLAGS][](LinkerFlags...) <a name="macro_LDFLAGS"></a> -Add flags to the link command line of executable or shared library/dll. -Note: LDFLAGS are always global. When set in the LIBRARY module they will affect all programs/dlls/tests the library is linked into. -Note: remember about the incompatibility of flags for gcc and cl. - +###### Macro [LDFLAGS][](LinkerFlags...) <a name="macro_LDFLAGS"></a> +Add flags to the link command line of executable or shared library/dll. +Note: LDFLAGS are always global. When set in the LIBRARY module they will affect all programs/dlls/tests the library is linked into. +Note: remember about the incompatibility of flags for gcc and cl. + ###### Macro [LD\_REQUIREMENTS][]([cpu: <value>] [ram: <value>]) <a name="macro_LD_REQUIREMENTS"></a> Override CPU and RAM requirements for link command in the module ###### Macro [LIB\_REQUIREMENTS][]([cpu: <value>] [ram: <value>]) <a name="macro_LIB_REQUIREMENTS"></a> Override CPU and RAM requirements for library creation comand of a x\_LIBRARY modules -###### Macro [LICENSE][](licenses...) <a name="macro_LICENSE"></a> +###### Macro [LICENSE][](licenses...) <a name="macro_LICENSE"></a> Specify the licenses of the module, separated by spaces. Specifying multiple licenses interpreted as permission to use this library satisfying all conditions of any of the listed licenses. - -A license must be prescribed for contribs - + +A license must be prescribed for contribs + ###### Macro [LICENSE\_TEXTS][](File) <a name="macro_LICENSE_TEXTS"></a> This macro specifies the filename with all library licenses texts @@ -1639,38 +1639,38 @@ $usage: LINK\_EXEC\_DYN\_LIB\_IMPL(peers...) # internal ###### Macro [LINK\_EXE\_IMPL][] <a name="macro_LINK_EXE_IMPL"></a> $usage: LINK\_EXE\_IMPL(peers...) # internal -###### Macro [LINT][](<none|base|strict>) <a name="macro_LINT"></a> -Set linting levem for sources of the module - -###### Macro [LJ\_21\_ARCHIVE][](NAME Name LuaFiles...) _# deprecated_ <a name="macro_LJ_21_ARCHIVE"></a> -Precompile .lua files using LuaJIT 2.1 and archive both sources and results using sources names as keys - -###### Macro [LJ\_ARCHIVE][](NAME Name LuaFiles...) <a name="macro_LJ_ARCHIVE"></a> -Precompile .lua files using LuaJIT and archive both sources and results using sources names as keys - -###### Macro [LLVM\_BC][] <a name="macro_LLVM_BC"></a> -Not documented yet. - -###### Macro [LLVM\_COMPILE\_C][](Input Output Opts...) <a name="macro_LLVM_COMPILE_C"></a> +###### Macro [LINT][](<none|base|strict>) <a name="macro_LINT"></a> +Set linting levem for sources of the module + +###### Macro [LJ\_21\_ARCHIVE][](NAME Name LuaFiles...) _# deprecated_ <a name="macro_LJ_21_ARCHIVE"></a> +Precompile .lua files using LuaJIT 2.1 and archive both sources and results using sources names as keys + +###### Macro [LJ\_ARCHIVE][](NAME Name LuaFiles...) <a name="macro_LJ_ARCHIVE"></a> +Precompile .lua files using LuaJIT and archive both sources and results using sources names as keys + +###### Macro [LLVM\_BC][] <a name="macro_LLVM_BC"></a> +Not documented yet. + +###### Macro [LLVM\_COMPILE\_C][](Input Output Opts...) <a name="macro_LLVM_COMPILE_C"></a> Emit LLVM bytecode from .c file. BC\_CFLAGS, LLVM\_OPTS and C\_FLAGS\_PLATFORM are passed in, while CFLAGS are not. -Note: Output name is used as is, no extension added. - -###### Macro [LLVM\_COMPILE\_CXX][](Input Output Opts...) <a name="macro_LLVM_COMPILE_CXX"></a> +Note: Output name is used as is, no extension added. + +###### Macro [LLVM\_COMPILE\_CXX][](Input Output Opts...) <a name="macro_LLVM_COMPILE_CXX"></a> Emit LLVM bytecode from .cpp file. BC\_CXXFLAGS, LLVM\_OPTS and C\_FLAGS\_PLATFORM are passed in, while CFLAGS are not. -Note: Output name is used as is, no extension added. - -###### Macro [LLVM\_COMPILE\_LL][](Input Output Opts...) <a name="macro_LLVM_COMPILE_LL"></a> -Compile LLVM bytecode to object representation. -Note: Output name is used as is, no extension added. - -###### Macro [LLVM\_LINK][](Output Inputs...) <a name="macro_LLVM_LINK"></a> -Call llvm-link on set of Inputs to produce Output. -Note: Unlike many other macros output argument goes first. Output name is used as is, no extension added. - -###### Macro [LLVM\_OPT][](Input Output Opts...) <a name="macro_LLVM_OPT"></a> -Call llvm-opt with set of Opts on Input to produce Output. -Note: Output name is used as is, no extension added. - +Note: Output name is used as is, no extension added. + +###### Macro [LLVM\_COMPILE\_LL][](Input Output Opts...) <a name="macro_LLVM_COMPILE_LL"></a> +Compile LLVM bytecode to object representation. +Note: Output name is used as is, no extension added. + +###### Macro [LLVM\_LINK][](Output Inputs...) <a name="macro_LLVM_LINK"></a> +Call llvm-link on set of Inputs to produce Output. +Note: Unlike many other macros output argument goes first. Output name is used as is, no extension added. + +###### Macro [LLVM\_OPT][](Input Output Opts...) <a name="macro_LLVM_OPT"></a> +Call llvm-opt with set of Opts on Input to produce Output. +Note: Output name is used as is, no extension added. + ###### Macro [LOCAL\_JAR][](File) <a name="macro_LOCAL_JAR"></a> Not documented yet. @@ -1678,73 +1678,73 @@ Not documented yet. Not documented yet. ###### Macro [LUA][](script\_path args... [CWD dir] [ENV key=value...] [TOOL tools...] [IN inputs...] [OUT[\_NOAUTO] outputs...] [STDOUT[\_NOAUTO] output] [OUTPUT\_INCLUDES output\_includes...][ REQUIREMENTS reqs]) <a name="macro_LUA"></a> -Run a lua script. +Run a lua script. These macros are similar: RUN\_PROGRAM, LUA, PYTHON. - -Parameters: + +Parameters: - script\_path - Path to the script.3 -- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. -- CWD dir - Absolute path of the working directory. -- ENV key=value... - Environment variables. -- TOOL tools... - Auxiliary tool directories. -- IN inputs... - Input files. -- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. -- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. -- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. +- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. +- CWD dir - Absolute path of the working directory. +- ENV key=value... - Environment variables. +- TOOL tools... - Auxiliary tool directories. +- IN inputs... - Input files. +- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. +- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. +- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. - REQUIREMENTS - Override default requirements for CPU and RAM - -For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or -${CURDIR} and ${BINDIR} which are expanded where the outputs are used. - -###### Macro [MACROS\_WITH\_ERROR][] <a name="macro_MACROS_WITH_ERROR"></a> -Not documented yet. - -###### Macro [MAPKITIDL][](idl-file-name... <a name="macro_MAPKITIDL"></a> -[OUT\_DIR output-dir] -[IDL\_INCLUDES idl-dirs...] -[FILTER filters...]) -[FILTER\_OUT filters...]) -[GLOBAL\_OUTPUTS] -Generate bindings to target platform language. -(Used for mobile MapKit project) -1. idl-file-name... - a list of \*.idl files to process -2. output-dir - a base root of output directory -3. idl-dirs - a list of directories where to search for imported \*.idl files + +For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or +${CURDIR} and ${BINDIR} which are expanded where the outputs are used. + +###### Macro [MACROS\_WITH\_ERROR][] <a name="macro_MACROS_WITH_ERROR"></a> +Not documented yet. + +###### Macro [MAPKITIDL][](idl-file-name... <a name="macro_MAPKITIDL"></a> +[OUT\_DIR output-dir] +[IDL\_INCLUDES idl-dirs...] +[FILTER filters...]) +[FILTER\_OUT filters...]) +[GLOBAL\_OUTPUTS] +Generate bindings to target platform language. +(Used for mobile MapKit project) +1. idl-file-name... - a list of \*.idl files to process +2. output-dir - a base root of output directory +3. idl-dirs - a list of directories where to search for imported \*.idl files 4. filters - a list of extensions used to filter outputs and output includes - -###### Macro [MAPKIT\_ADDINCL][](Dirs...) <a name="macro_MAPKIT_ADDINCL"></a> -Not documented yet. - -###### Macro [MASMFLAGS][](compiler flags) <a name="macro_MASMFLAGS"></a> -Add the specified flags to the compilation command of .masm files. - -###### Macro [MAVEN\_GROUP\_ID][](group\_id\_for\_maven\_export) <a name="macro_MAVEN_GROUP_ID"></a> -Set maven export group id for JAVA\_PROGRAM() and JAVA\_LIBRARY(). -Have no effect on regular build. - -###### Macro [MESSAGE][]([severity] message) _# builtin_ <a name="macro_MESSAGE"></a> -Print message with given severity level (STATUS, FATAL\_ERROR) - -###### Macro [METAQUERYFILES][](filenames...) _#deprecated_ <a name="macro_METAQUERYFILES"></a> + +###### Macro [MAPKIT\_ADDINCL][](Dirs...) <a name="macro_MAPKIT_ADDINCL"></a> +Not documented yet. + +###### Macro [MASMFLAGS][](compiler flags) <a name="macro_MASMFLAGS"></a> +Add the specified flags to the compilation command of .masm files. + +###### Macro [MAVEN\_GROUP\_ID][](group\_id\_for\_maven\_export) <a name="macro_MAVEN_GROUP_ID"></a> +Set maven export group id for JAVA\_PROGRAM() and JAVA\_LIBRARY(). +Have no effect on regular build. + +###### Macro [MESSAGE][]([severity] message) _# builtin_ <a name="macro_MESSAGE"></a> +Print message with given severity level (STATUS, FATAL\_ERROR) + +###### Macro [METAQUERYFILES][](filenames...) _#deprecated_ <a name="macro_METAQUERYFILES"></a> This macro does nothing and will be removed - + ###### Macro [MSVC\_FLAGS][]([GLOBAL compiler\_flag]\* compiler\_flags) <a name="macro_MSVC_FLAGS"></a> Add the specified flags to the compilation line of C/C++files. Flags apply only if the compiler used is MSVC (cl.exe) -###### Macro [MX\_FORMULAS][](BinFiles...) _# deprecated, matrixnet_ <a name="macro_MX_FORMULAS"></a> -Create MatrixNet formulas archive - -###### Macro [NEED\_CHECK][]() <a name="macro_NEED_CHECK"></a> -Commits to the project marked with this macro will be blocked by pre-commit check and then will be -automatically merged to trunk only if there is no new broken build targets in check results. -The use of this macro is disabled by default. - -###### Macro [NEED\_REVIEW][]() _# deprecated_ <a name="macro_NEED_REVIEW"></a> -Mark the project as needing review. -Reviewers are listed in the macro OWNER. The use of this macro is disabled by default. -Details can be found here: https://clubs.at.yandex-team.ru/arcadia/6104 - +###### Macro [MX\_FORMULAS][](BinFiles...) _# deprecated, matrixnet_ <a name="macro_MX_FORMULAS"></a> +Create MatrixNet formulas archive + +###### Macro [NEED\_CHECK][]() <a name="macro_NEED_CHECK"></a> +Commits to the project marked with this macro will be blocked by pre-commit check and then will be +automatically merged to trunk only if there is no new broken build targets in check results. +The use of this macro is disabled by default. + +###### Macro [NEED\_REVIEW][]() _# deprecated_ <a name="macro_NEED_REVIEW"></a> +Mark the project as needing review. +Reviewers are listed in the macro OWNER. The use of this macro is disabled by default. +Details can be found here: https://clubs.at.yandex-team.ru/arcadia/6104 + ###### Macro [NGINX\_MODULES][](Modules...) <a name="macro_NGINX_MODULES"></a> Not documented yet. @@ -1753,23 +1753,23 @@ Materializes `node\_modules.tar` bundle according to the module's lockfile. @see [NPM\_CONTRIBS()](#module\_NPM\_CONTRIBS) -###### Macro [NO\_BUILD\_IF][](variables) _# builtin_ <a name="macro_NO_BUILD_IF"></a> -Print warning if some variable is true - -###### Macro [NO\_CHECK\_IMPORTS][]([patterns]) <a name="macro_NO_CHECK_IMPORTS"></a> -Do not run checks on imports of Python modules. -Optional parameter mask patterns describes the names of the modules that do not need to check. - -###### Macro [NO\_CLANG\_COVERAGE][]() <a name="macro_NO_CLANG_COVERAGE"></a> -Disable heavyweight clang coverage for the module - +###### Macro [NO\_BUILD\_IF][](variables) _# builtin_ <a name="macro_NO_BUILD_IF"></a> +Print warning if some variable is true + +###### Macro [NO\_CHECK\_IMPORTS][]([patterns]) <a name="macro_NO_CHECK_IMPORTS"></a> +Do not run checks on imports of Python modules. +Optional parameter mask patterns describes the names of the modules that do not need to check. + +###### Macro [NO\_CLANG\_COVERAGE][]() <a name="macro_NO_CLANG_COVERAGE"></a> +Disable heavyweight clang coverage for the module + ###### Macro [NO\_CLANG\_TIDY][]() <a name="macro_NO_CLANG_TIDY"></a> Not documented yet. -###### Macro [NO\_COMPILER\_WARNINGS][]() <a name="macro_NO_COMPILER_WARNINGS"></a> +###### Macro [NO\_COMPILER\_WARNINGS][]() <a name="macro_NO_COMPILER_WARNINGS"></a> Disable all compiler warnings in the module. -Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. - +Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. + ###### Macro [NO\_CPU\_CHECK][]() <a name="macro_NO_CPU_CHECK"></a> Compile module without startup CPU features check @@ -1777,9 +1777,9 @@ Compile module without startup CPU features check Disable cython and cythonized python coverage (CYTHONIZE\_PY) Implies NO\_CLANG\_COVERAGE() - right now, we can't disable instrumentation for .py.cpp files, but enable for .cpp -###### Macro [NO\_DEBUG\_INFO][]() <a name="macro_NO_DEBUG_INFO"></a> -Compile files without debug info collection. - +###### Macro [NO\_DEBUG\_INFO][]() <a name="macro_NO_DEBUG_INFO"></a> +Compile files without debug info collection. + ###### Macro [NO\_DOCTESTS][]() <a name="macro_NO_DOCTESTS"></a> Disable doctests in PY[|3|23\_]TEST @@ -1794,75 +1794,75 @@ Anyway, preferred way is to move such files into separate dir and don't use this Also see: https://docs.yandex-team.ru/ya-make/manual/python/vars#y\_python\_extended\_source\_search for details -###### Macro [NO\_JOIN\_SRC][]() _# deprecated, does-nothing_ <a name="macro_NO_JOIN_SRC"></a> +###### Macro [NO\_JOIN\_SRC][]() _# deprecated, does-nothing_ <a name="macro_NO_JOIN_SRC"></a> This macro currently does nothing. This is default behavior which cannot be overridden at module level. - -###### Macro [NO\_LIBC][]() <a name="macro_NO_LIBC"></a> -Exclude dependencies on C++ and C runtimes (including util, musl and libeatmydata). -Note: use this with care. libc most likely will be linked into executable anyway, -so using libc headers/functions may not be detected at build time and may lead to unpredictable behavors at configure time. - -###### Macro [NO\_LINT][]() <a name="macro_NO_LINT"></a> -Do not check for style files included in PY\_SRCS, TEST\_SRCS, JAVA\_SRCS. - + +###### Macro [NO\_LIBC][]() <a name="macro_NO_LIBC"></a> +Exclude dependencies on C++ and C runtimes (including util, musl and libeatmydata). +Note: use this with care. libc most likely will be linked into executable anyway, +so using libc headers/functions may not be detected at build time and may lead to unpredictable behavors at configure time. + +###### Macro [NO\_LINT][]() <a name="macro_NO_LINT"></a> +Do not check for style files included in PY\_SRCS, TEST\_SRCS, JAVA\_SRCS. + ###### Macro [NO\_MYPY][]() <a name="macro_NO_MYPY"></a> Not documented yet. -###### Macro [NO\_NEED\_CHECK][]() <a name="macro_NO_NEED_CHECK"></a> -Commits to the project marked with this macro will not be affected by higher-level NEED\_CHECK macro. - -###### Macro [NO\_OPTIMIZE][]() <a name="macro_NO_OPTIMIZE"></a> -Build code without any optimizations (-O0 mode). - +###### Macro [NO\_NEED\_CHECK][]() <a name="macro_NO_NEED_CHECK"></a> +Commits to the project marked with this macro will not be affected by higher-level NEED\_CHECK macro. + +###### Macro [NO\_OPTIMIZE][]() <a name="macro_NO_OPTIMIZE"></a> +Build code without any optimizations (-O0 mode). + ###### Macro [NO\_OPTIMIZE\_PY\_PROTOS][]() <a name="macro_NO_OPTIMIZE_PY_PROTOS"></a> Disable Python proto optimization using embedding corresponding C++ code into binary. Python protobuf runtime will use C++ implementation instead of Python one if former is available. This is default mode only for some system libraries. -###### Macro [NO\_PLATFORM][]() <a name="macro_NO_PLATFORM"></a> -Exclude dependencies on C++ and C runtimes (including util, musl and libeatmydata) and set NO\_PLATFORM variable for special processing. -Note: use this with care. libc most likely will be linked into executable anyway, -so using libc headers/functions may not be detected at build time and may lead to unpredictable behavors at configure time. - +###### Macro [NO\_PLATFORM][]() <a name="macro_NO_PLATFORM"></a> +Exclude dependencies on C++ and C runtimes (including util, musl and libeatmydata) and set NO\_PLATFORM variable for special processing. +Note: use this with care. libc most likely will be linked into executable anyway, +so using libc headers/functions may not be detected at build time and may lead to unpredictable behavors at configure time. + ###### Macro [NO\_PYTHON\_COVERAGE][]() <a name="macro_NO_PYTHON_COVERAGE"></a> Disable python coverage for module -###### Macro [NO\_RUNTIME][]() <a name="macro_NO_RUNTIME"></a> -This macro: -1. Sets the ENABLE(NOUTIL) + DISABLE(USE\_INTERNAL\_STL); -2. If the project that contains the macro NO\_RUNTIME(), peerdir-it project does not contain NO\_RUNTIME() => Warning. -Note: use this with care. Arcadia STL most likely will be linked into executable anyway, so using STL headers/functions/classes -may not be detected at build time and may lead to unpredictable behavors at configure time. - -###### Macro [NO\_SANITIZE][]() <a name="macro_NO_SANITIZE"></a> -Disable all sanitizers for the module. - -###### Macro [NO\_SANITIZE\_COVERAGE][]() <a name="macro_NO_SANITIZE_COVERAGE"></a> -Disable lightweight coverage (-fsanitize-coverage) for the module. - -###### Macro [NO\_SSE4][]() <a name="macro_NO_SSE4"></a> -Compile module without SSE4 - -###### Macro [NO\_UTIL][]() <a name="macro_NO_UTIL"></a> -Build module without dependency on util. -Note: use this with care. Util most likely will be linked into executable anyway, -so using util headers/functions/classes may not be detected at build time and may lead to unpredictable behavors at configure time. - -###### Macro [NO\_WERROR][]() <a name="macro_NO_WERROR"></a> -Override WERROR() behavior -Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. - -###### Macro [NO\_WSHADOW][]() <a name="macro_NO_WSHADOW"></a> -Disable C++ shadowing warnings. - +###### Macro [NO\_RUNTIME][]() <a name="macro_NO_RUNTIME"></a> +This macro: +1. Sets the ENABLE(NOUTIL) + DISABLE(USE\_INTERNAL\_STL); +2. If the project that contains the macro NO\_RUNTIME(), peerdir-it project does not contain NO\_RUNTIME() => Warning. +Note: use this with care. Arcadia STL most likely will be linked into executable anyway, so using STL headers/functions/classes +may not be detected at build time and may lead to unpredictable behavors at configure time. + +###### Macro [NO\_SANITIZE][]() <a name="macro_NO_SANITIZE"></a> +Disable all sanitizers for the module. + +###### Macro [NO\_SANITIZE\_COVERAGE][]() <a name="macro_NO_SANITIZE_COVERAGE"></a> +Disable lightweight coverage (-fsanitize-coverage) for the module. + +###### Macro [NO\_SSE4][]() <a name="macro_NO_SSE4"></a> +Compile module without SSE4 + +###### Macro [NO\_UTIL][]() <a name="macro_NO_UTIL"></a> +Build module without dependency on util. +Note: use this with care. Util most likely will be linked into executable anyway, +so using util headers/functions/classes may not be detected at build time and may lead to unpredictable behavors at configure time. + +###### Macro [NO\_WERROR][]() <a name="macro_NO_WERROR"></a> +Override WERROR() behavior +Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. + +###### Macro [NO\_WSHADOW][]() <a name="macro_NO_WSHADOW"></a> +Disable C++ shadowing warnings. + ###### Macro [NVCC\_DEVICE\_LINK][](file.cu...) <a name="macro_NVCC_DEVICE_LINK"></a> Run nvcc --device-link on objects compiled from srcs with --device-c. This generates a stub object devlink.o that supplies missing pieces for the host linker to link relocatable device objects into the final executable. -###### Macro [ONLY\_TAGS][](tags...) _# builtin_ <a name="macro_ONLY_TAGS"></a> -Instantiate from multimodule only variants with tags listed - +###### Macro [ONLY\_TAGS][](tags...) _# builtin_ <a name="macro_ONLY_TAGS"></a> +Instantiate from multimodule only variants with tags listed + ###### Macro [OPENSOURCE\_EXPORT\_REPLACEMENT][](CMAKE PkgName CMAKE\_TARGET PkgName::PkgTarget CONAN ConanRef CMAKE\_COMPONENT OptCmakePkgComponent) <a name="macro_OPENSOURCE_EXPORT_REPLACEMENT"></a> Use specified conan/system pacakcge when exporting cmake build scripts for arcadia C++ project for opensource publication. @@ -1872,68 +1872,68 @@ This macro specifies the source repository for contrib Does nothing now (just a placeholder for future functionality) See https://st.yandex-team.ru/DTCC-316 -###### Macro [OWNER][](owners...) _# builtin_ <a name="macro_OWNER"></a> -Add reviewers/responsibles of the code. -In the OWNER macro you can use: -1. login-s from staff.yandex-team.ru -2. Review group (to specify the Code-review group need to use the prefix g:) - -Ask devtools@yandex-team.ru if you need more information - -###### Macro [PACK][](archive\_type) <a name="macro_PACK"></a> +###### Macro [OWNER][](owners...) _# builtin_ <a name="macro_OWNER"></a> +Add reviewers/responsibles of the code. +In the OWNER macro you can use: +1. login-s from staff.yandex-team.ru +2. Review group (to specify the Code-review group need to use the prefix g:) + +Ask devtools@yandex-team.ru if you need more information + +###### Macro [PACK][](archive\_type) <a name="macro_PACK"></a> When placed inside the PACKAGE module, packs the build results tree to the archive with specified extension. Currently supported extensions are `tar` and `tar.gz` - + Is not allowed other module types than PACKAGE(). @see: [PACKAGE()](#module\_PACKAGE) -###### Macro [PACKAGE\_STRICT][]() <a name="macro_PACKAGE_STRICT"></a> -Not documented yet. - +###### Macro [PACKAGE\_STRICT][]() <a name="macro_PACKAGE_STRICT"></a> +Not documented yet. + ###### Macro [PACK\_GLOBALS\_IN\_LIBRARY][]() <a name="macro_PACK_GLOBALS_IN_LIBRARY"></a> Not documented yet. -###### Macro [PARTITIONED\_RECURSE][]([BALANCING\_CONFIG config] [LOCAL] dirs...) _# builtin_ <a name="macro_PARTITIONED_RECURSE"></a> -Add directories to the build -All projects must be reachable from the root chain RECURSE() for monorepo continuous integration functionality. -Arguments are processed in chunks - -###### Macro [PARTITIONED\_RECURSE\_FOR\_TESTS][]([BALANCING\_CONFIG config] [LOCAL] dirs...) _# builtin_ <a name="macro_PARTITIONED_RECURSE_FOR_TESTS"></a> -Add directories to the build if tests are demanded. -Arguments are processed in chunks - -###### Macro [PARTITIONED\_RECURSE\_ROOT\_RELATIVE][]([BALANCING\_CONFIG config] dirlist) _# builtin_ <a name="macro_PARTITIONED_RECURSE_ROOT_RELATIVE"></a> -In comparison with RECURSE(), in dirlist there must be a directory relative to the root (${ARCADIA\_ROOT}). -Arguments are processed in chunks - -###### Macro [PEERDIR][](dirs...) _# builtin_ <a name="macro_PEERDIR"></a> -Specify project dependencies -Indicates that the project depends on all of the projects from the list of dirs. -Libraries from these directories will be collected and linked to the current target if the target is executable or sharedlib/dll. -If the current target is a static library, the specified directories will not be built, but they will be linked to any executable target that will link the current library. -@params: +###### Macro [PARTITIONED\_RECURSE][]([BALANCING\_CONFIG config] [LOCAL] dirs...) _# builtin_ <a name="macro_PARTITIONED_RECURSE"></a> +Add directories to the build +All projects must be reachable from the root chain RECURSE() for monorepo continuous integration functionality. +Arguments are processed in chunks + +###### Macro [PARTITIONED\_RECURSE\_FOR\_TESTS][]([BALANCING\_CONFIG config] [LOCAL] dirs...) _# builtin_ <a name="macro_PARTITIONED_RECURSE_FOR_TESTS"></a> +Add directories to the build if tests are demanded. +Arguments are processed in chunks + +###### Macro [PARTITIONED\_RECURSE\_ROOT\_RELATIVE][]([BALANCING\_CONFIG config] dirlist) _# builtin_ <a name="macro_PARTITIONED_RECURSE_ROOT_RELATIVE"></a> +In comparison with RECURSE(), in dirlist there must be a directory relative to the root (${ARCADIA\_ROOT}). +Arguments are processed in chunks + +###### Macro [PEERDIR][](dirs...) _# builtin_ <a name="macro_PEERDIR"></a> +Specify project dependencies +Indicates that the project depends on all of the projects from the list of dirs. +Libraries from these directories will be collected and linked to the current target if the target is executable or sharedlib/dll. +If the current target is a static library, the specified directories will not be built, but they will be linked to any executable target that will link the current library. +@params: 1. As arguments PEERDIR you can only use the LIBRARY directory (the directory with the PROGRAM/DLL and derived from them are prohibited to use as arguments PEERDIR). -2. ADDINCL Keyword ADDINCL (written before the specified directory), adds the flag -I<path to library> the flags to compile the source code of the current project. -Perhaps it may be removed in the future (in favor of a dedicated ADDINCL) - +2. ADDINCL Keyword ADDINCL (written before the specified directory), adds the flag -I<path to library> the flags to compile the source code of the current project. +Perhaps it may be removed in the future (in favor of a dedicated ADDINCL) + ###### Macro [PIRE\_INLINE][](FILES...) <a name="macro_PIRE_INLINE"></a> Not documented yet. - + ###### Macro [PIRE\_INLINE\_CMD][](SRC) <a name="macro_PIRE_INLINE_CMD"></a> Not documented yet. - -###### Macro [PRINT\_MODULE\_TYPE][] <a name="macro_PRINT_MODULE_TYPE"></a> -Not documented yet. - -###### Macro [PROCESS\_DOCS][] <a name="macro_PROCESS_DOCS"></a> -Not documented yet. - + +###### Macro [PRINT\_MODULE\_TYPE][] <a name="macro_PRINT_MODULE_TYPE"></a> +Not documented yet. + +###### Macro [PROCESS\_DOCS][] <a name="macro_PROCESS_DOCS"></a> +Not documented yet. + ###### Macro PROGURAD\_RULES(ProguardRuleFiles...) <a name="macro_PROGUARD_RULES"></a> This macro is strictly prohibited to use outside of mapsmobi project -###### Macro [PROTO2FBS][](InputProto) <a name="macro_PROTO2FBS"></a> +###### Macro [PROTO2FBS][](InputProto) <a name="macro_PROTO2FBS"></a> Produce flatbuf schema out of protobuf description. - + ###### Macro [PROTO\_ADDINCL][]([GLOBAL] [WITH\_GEN] Path) <a name="macro_PROTO_ADDINCL"></a> This macro introduces proper ADDINCLs for .proto-files found in sources and .cpp/.h generated files, supplying them to appropriate commands and allowing @@ -1953,29 +1953,29 @@ PROTO\_LIBRARY with PROTO\_NAMESPACE(GLOBAL ) is enough at user side to correctl If generated .proto files are going to be used for building a module than use of WITH\_GEN parameter will add appropriate dir from the build root for .proto files search. -###### Macro [PROVIDES][](Name...) <a name="macro_PROVIDES"></a> -Specifies provided features. The names must be correct C identifiers. -This prevents different libraries providing the same features to be linked into one program. - +###### Macro [PROVIDES][](Name...) <a name="macro_PROVIDES"></a> +Specifies provided features. The names must be correct C identifiers. +This prevents different libraries providing the same features to be linked into one program. + ###### Macro [PYTHON][](script\_path args... [CWD dir] [ENV key=value...] [TOOL tools...] [IN inputs...] [OUT[\_NOAUTO] outputs...] [STDOUT[\_NOAUTO] output] [OUTPUT\_INCLUDES output\_includes...] [REQUIREMENTS reqs]) <a name="macro_PYTHON"></a> Run a python script with $(PYTHON)/python built from devtools/huge\_python. These macros are similar: RUN\_PROGRAM, LUA, PYTHON. - -Parameters: -- script\_path - Path to the script. -- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. -- CWD dir - Absolute path of the working directory. -- ENV key=value... - Environment variables. -- TOOL tools... - Auxiliary tool directories. -- IN inputs... - Input files. -- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. -- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. -- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. + +Parameters: +- script\_path - Path to the script. +- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. +- CWD dir - Absolute path of the working directory. +- ENV key=value... - Environment variables. +- TOOL tools... - Auxiliary tool directories. +- IN inputs... - Input files. +- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. +- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. +- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. - REQUIREMENTS - Override default requirements for CPU and RAM - -For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or -${CURDIR} and ${BINDIR} which are expanded where the outputs are used. - + +For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or +${CURDIR} and ${BINDIR} which are expanded where the outputs are used. + ###### Macro [PYTHON2\_ADDINCL][]() <a name="macro_PYTHON2_ADDINCL"></a> This macro adds include path for Python headers (Python 2.x variant) without PEERDIR. This should be used in 2 cases only: @@ -1987,35 +1987,35 @@ Never use this macro in PY2\_PROGRAM, PY2\_LIBRARY and PY23\_LIBRARY: they have Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs -###### Macro [PYTHON2\_MODULE][]() <a name="macro_PYTHON2_MODULE"></a> -Use in PY\_ANY\_MODULE to set it up for Python 2.x. - -###### Macro [PYTHON3\_ADDINCL][]() <a name="macro_PYTHON3_ADDINCL"></a> -This macro adds include path for Python headers (Python 3.x variant). -This should be used in 2 cases only: +###### Macro [PYTHON2\_MODULE][]() <a name="macro_PYTHON2_MODULE"></a> +Use in PY\_ANY\_MODULE to set it up for Python 2.x. + +###### Macro [PYTHON3\_ADDINCL][]() <a name="macro_PYTHON3_ADDINCL"></a> +This macro adds include path for Python headers (Python 3.x variant). +This should be used in 2 cases only: - In PY2MODULE since it compiles into .so and uses external Python runtime; -- In system Python libraries themselves since peerdir there may create a loop; -In all other cases use USE\_PYTHON3() macro instead. - -Never use this macro in PY3\_PROGRAM and PY3\_LIBRARY and PY23\_LIBRARY: they have everything by default. - -Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs - -###### Macro [PYTHON3\_MODULE][]() <a name="macro_PYTHON3_MODULE"></a> -Use in PY\_ANY\_MODULE to set it up for Python 3.x. - -###### Macro [PYTHON\_PATH][](Path) <a name="macro_PYTHON_PATH"></a> -Set path to Python that will be used to runs scripts in tests - +- In system Python libraries themselves since peerdir there may create a loop; +In all other cases use USE\_PYTHON3() macro instead. + +Never use this macro in PY3\_PROGRAM and PY3\_LIBRARY and PY23\_LIBRARY: they have everything by default. + +Documentation: https://wiki.yandex-team.ru/devtools/commandsandvars/py\_srcs + +###### Macro [PYTHON3\_MODULE][]() <a name="macro_PYTHON3_MODULE"></a> +Use in PY\_ANY\_MODULE to set it up for Python 3.x. + +###### Macro [PYTHON\_PATH][](Path) <a name="macro_PYTHON_PATH"></a> +Set path to Python that will be used to runs scripts in tests + ###### Macro [PY\_CONSTRUCTOR][](package.module[:func]) <a name="macro_PY_CONSTRUCTOR"></a> Specifies the module or function which will be started before python's main() init() is expected in the target module if no function is specified Can be considered as \_\_attribute\_\_((constructor)) for python -###### Macro PY\_DOCTEST(Packages...) <a name="macro_PY_DOCTESTS"></a> -Add to the test doctests for specified Python packages -The packages should be part of a test (listed as sources of the test or its PEERDIRs). - +###### Macro PY\_DOCTEST(Packages...) <a name="macro_PY_DOCTESTS"></a> +Add to the test doctests for specified Python packages +The packages should be part of a test (listed as sources of the test or its PEERDIRs). + ###### Macro [PY\_ENUMS\_SERIALIZATION][] <a name="macro_PY_ENUMS_SERIALIZATION"></a> Not documented yet. @@ -2023,19 +2023,19 @@ Not documented yet. Add extra Python files for linting. This macro allows adding Python files which has no .py extension. -###### Macro [PY\_MAIN][](package.module[:func]) <a name="macro_PY_MAIN"></a> -Specifies the module or function from which to start executing a python program - -Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#modulipyprogrampy3programimakrospymain - -###### Macro [PY\_NAMESPACE][](prefix) <a name="macro_PY_NAMESPACE"></a> -Sets default Python namespace for all python sources in the module. -Especially suitable in PROTO\_LIBRARY where Python sources are generated and there is no PY\_SRCS to place NAMESPACE parameter. - -###### Macro [PY\_PROTOS\_FOR][](path/to/module) _#builtin, deprecated_ <a name="macro_PY_PROTOS_FOR"></a> -Use PROTO\_LIBRARY() in order to have .proto compiled into Python. -Generates pb2.py files out of .proto files and saves those into PACKAGE module - +###### Macro [PY\_MAIN][](package.module[:func]) <a name="macro_PY_MAIN"></a> +Specifies the module or function from which to start executing a python program + +Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#modulipyprogrampy3programimakrospymain + +###### Macro [PY\_NAMESPACE][](prefix) <a name="macro_PY_NAMESPACE"></a> +Sets default Python namespace for all python sources in the module. +Especially suitable in PROTO\_LIBRARY where Python sources are generated and there is no PY\_SRCS to place NAMESPACE parameter. + +###### Macro [PY\_PROTOS\_FOR][](path/to/module) _#builtin, deprecated_ <a name="macro_PY_PROTOS_FOR"></a> +Use PROTO\_LIBRARY() in order to have .proto compiled into Python. +Generates pb2.py files out of .proto files and saves those into PACKAGE module + ###### Macro [PY\_PROTO\_PLUGIN][](Name Ext Tool DEPS <Dependencies>) <a name="macro_PY_PROTO_PLUGIN"></a> Define protoc plugin for python with given Name that emits extra output with provided Extension using Tool. Extra dependencies are passed via DEPS @@ -2045,45 +2045,45 @@ Define protoc plugin for python with given Name that emits 2 extra outputs with using Tool. Extra dependencies are passed via DEPS ###### Macro [PY\_REGISTER][]([package.]module\_name) <a name="macro_PY_REGISTER"></a> -Python knows about which built-ins can be imported, due to their registration in the Assembly or at the start of the interpreter. -All modules from the sources listed in PY\_SRCS() are registered automatically. -To register the modules from the sources in the SRCS(), you need to use PY\_REGISTER(). - -PY\_REGISTER(module\_name) initializes module globally via call to initmodule\_name() +Python knows about which built-ins can be imported, due to their registration in the Assembly or at the start of the interpreter. +All modules from the sources listed in PY\_SRCS() are registered automatically. +To register the modules from the sources in the SRCS(), you need to use PY\_REGISTER(). + +PY\_REGISTER(module\_name) initializes module globally via call to initmodule\_name() PY\_REGISTER(package.module\_name) initializes module in the specified package It renames its init function with CFLAGS(-Dinitmodule\_name=init7package11module\_name) or CFLAGS(-DPyInit\_module\_name=PyInit\_7package11module\_name) - -Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#makrospyregister - + +Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#makrospyregister + ###### Macro [PY\_REQUIREMENTS][]([cpu: <value>] [ram: <value>]) <a name="macro_PY_REQUIREMENTS"></a> Override CPU and RAM requirements for all Python build commands -###### Macro [PY\_SRCS][]({| CYTHON\_C} { | TOP\_LEVEL | NAMESPACE ns} Files...) <a name="macro_PY_SRCS"></a> +###### Macro [PY\_SRCS][]({| CYTHON\_C} { | TOP\_LEVEL | NAMESPACE ns} Files...) <a name="macro_PY_SRCS"></a> Build specified Python sources according to Arcadia binary Python build. Basically creates precompiled and source resources keyed with module paths. -The resources eventually are linked into final program and can be accessed as regular Python modules. -This custom loader linked into the program will add them to sys.meta\_path. - -PY\_SRCS also support .proto, .ev, .pyx and .swg files. The .proto and .ev are compiled to .py-code by protoc and than handled as usual .py files. -.pyx and .swg lead to C/C++ Python extensions generation, that are automatically registered in Python as built-in modules. - -By default .pyx files are built as C++-extensions. Use CYTHON\_C to build them as C (similar to BUILDWITH\_CYTHON\_C, but with the ability to specify namespace). - -\_\_init\_\_.py never required, but if present (and specified in PY\_SRCS), it will be imported when you import package modules with \_\_init\_\_.py Oh. - -@example - +The resources eventually are linked into final program and can be accessed as regular Python modules. +This custom loader linked into the program will add them to sys.meta\_path. + +PY\_SRCS also support .proto, .ev, .pyx and .swg files. The .proto and .ev are compiled to .py-code by protoc and than handled as usual .py files. +.pyx and .swg lead to C/C++ Python extensions generation, that are automatically registered in Python as built-in modules. + +By default .pyx files are built as C++-extensions. Use CYTHON\_C to build them as C (similar to BUILDWITH\_CYTHON\_C, but with the ability to specify namespace). + +\_\_init\_\_.py never required, but if present (and specified in PY\_SRCS), it will be imported when you import package modules with \_\_init\_\_.py Oh. + +@example + PY2_LIBRARY(mymodule) - PY_SRCS(a.py sub/dir/b.py e.proto sub/dir/f.proto c.pyx sub/dir/d.pyx g.swg sub/dir/h.swg) - END() - -PY\_SRCS honors Python2 and Python3 differences and adjusts itself to Python version of a current module. -PY\_SRCS can be used in any Arcadia Python build modules like PY\*\_LIBRARY, PY\*\_PROGRAM, PY\*TEST. + PY_SRCS(a.py sub/dir/b.py e.proto sub/dir/f.proto c.pyx sub/dir/d.pyx g.swg sub/dir/h.swg) + END() + +PY\_SRCS honors Python2 and Python3 differences and adjusts itself to Python version of a current module. +PY\_SRCS can be used in any Arcadia Python build modules like PY\*\_LIBRARY, PY\*\_PROGRAM, PY\*TEST. PY\_SRCS in LIBRARY or PROGRAM effectively converts these into PY2\_LIBRARY and PY2\_PROGRAM respectively. -It is strongly advised to make this conversion explicit. Never use PY\_SRCS in a LIBRARY if you plan to use it from external Python extension module. - -Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#modulipylibrarypy3libraryimakrospysrcs - +It is strongly advised to make this conversion explicit. Never use PY\_SRCS in a LIBRARY if you plan to use it from external Python extension module. + +Documentation: https://wiki.yandex-team.ru/arcadia/python/pysrcs/#modulipylibrarypy3libraryimakrospysrcs + ###### Macro [PY\_SSQLS\_SRCS][](Srcs...) <a name="macro_PY_SSQLS_SRCS"></a> Not documented yet. @@ -2096,28 +2096,28 @@ $usage: REAL\_LINK\_EXEC\_DYN\_LIB\_IMPL(peers...) # internal ###### Macro [REAL\_LINK\_EXE\_IMPL][] <a name="macro_REAL_LINK_EXE_IMPL"></a> $usage: REAL\_LINK\_EXE\_IMPL(peers...) # internal -###### Macro [RECURSE][]([LOCAL] dirs...) _# builtin_ <a name="macro_RECURSE"></a> -Add directories to the build -All projects must be reachable from the root chain RECURSE() for monorepo continuous integration functionality - -###### Macro [RECURSE\_FOR\_TESTS][]([LOCAL] dirs...) _# builtin_ <a name="macro_RECURSE_FOR_TESTS"></a> +###### Macro [RECURSE][]([LOCAL] dirs...) _# builtin_ <a name="macro_RECURSE"></a> +Add directories to the build +All projects must be reachable from the root chain RECURSE() for monorepo continuous integration functionality + +###### Macro [RECURSE\_FOR\_TESTS][]([LOCAL] dirs...) _# builtin_ <a name="macro_RECURSE_FOR_TESTS"></a> Add directories to the build if tests are demanded. Use --force-build-depends flag if you want to build testing modules without tests running - -###### Macro [RECURSE\_ROOT\_RELATIVE][](dirlist) _# builtin_ <a name="macro_RECURSE_ROOT_RELATIVE"></a> -In comparison with RECURSE(), in dirlist there must be a directory relative to the root (${ARCADIA\_ROOT}) - + +###### Macro [RECURSE\_ROOT\_RELATIVE][](dirlist) _# builtin_ <a name="macro_RECURSE_ROOT_RELATIVE"></a> +In comparison with RECURSE(), in dirlist there must be a directory relative to the root (${ARCADIA\_ROOT}) + ###### Macro [REGISTER\_SANDBOX\_IMPORT][] <a name="macro_REGISTER_SANDBOX_IMPORT"></a> Not documented yet. -###### Macro [REGISTER\_YQL\_PYTHON\_UDF][] <a name="macro_REGISTER_YQL_PYTHON_UDF"></a> -Not documented yet. - -###### Macro [REQUIREMENTS][]([cpu:<count>] [disk\_usage:<size>] [ram:<size>] [ram\_disk:<size>] [container:<id>] [network:<restricted|full>] [dns:dns64]) <a name="macro_REQUIREMENTS"></a> -Allows you to specify the requirements of the test. - -Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ - +###### Macro [REGISTER\_YQL\_PYTHON\_UDF][] <a name="macro_REGISTER_YQL_PYTHON_UDF"></a> +Not documented yet. + +###### Macro [REQUIREMENTS][]([cpu:<count>] [disk\_usage:<size>] [ram:<size>] [ram\_disk:<size>] [container:<id>] [network:<restricted|full>] [dns:dns64]) <a name="macro_REQUIREMENTS"></a> +Allows you to specify the requirements of the test. + +Documentation about the Arcadia test system: https://wiki.yandex-team.ru/yatool/test/ + ###### Macro [REQUIRES][](dirs...) <a name="macro_REQUIRES"></a> Specify list of dirs which this module must depend on indirectly. @@ -2136,43 +2136,43 @@ to be addressed by either ADDINCLs or marking them as TEXT. Please contact devto Add data (resources, random files, strings) to the program) The common usage is to place Src file into binary. The Key is used to access it using library/cpp/resource or library/python/resource. Alternative syntax with '- Key=Value' allows placing Value string as resource data into binary and make it accessible by Key. - -This is a simpler but less flexible option than ARCHIVE(), because in the case of ARCHIVE(), you have to use the data explicitly, + +This is a simpler but less flexible option than ARCHIVE(), because in the case of ARCHIVE(), you have to use the data explicitly, and in the case of RESOURCE(), the data will fall through SRCS() or SRCS(GLOBAL) to binary linking. - + Use the FORCE\_TEXT parameter to explicitly mark all Src files as text files: they will not be parsed unless used elsewhere. -@example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a2ispolzujjtekomanduresource - -@example: - - LIBRARY() +@example: https://wiki.yandex-team.ru/yatool/howtowriteyamakefiles/#a2ispolzujjtekomanduresource + +@example: + + LIBRARY() OWNER(user1) - + RESOURCE( path/to/file1 /key/in/program/1 path/to/file2 /key2 ) - END() - + END() + ###### Macro [RESOURCE\_FILES][]([DONT\_PARSE] [PREFIX {prefix}] [STRIP prefix\_to\_strip] {path}) <a name="macro_RESOURCE_FILES"></a> This macro expands into RESOURCE([DONT\_PARSE] {path} resfs/file/{prefix}{path} - resfs/src/resfs/file/{prefix}{remove\_prefix(path, prefix\_to\_strip)}={rootrel\_arc\_src(path)} -) - -resfs/src/{key} stores a source root (or build root) relative path of the -source of the value of the {key} resource. - -resfs/file/{key} stores any value whose source was a file on a filesystem. -resfs/src/resfs/file/{key} must store its path. - +) + +resfs/src/{key} stores a source root (or build root) relative path of the +source of the value of the {key} resource. + +resfs/file/{key} stores any value whose source was a file on a filesystem. +resfs/src/resfs/file/{key} must store its path. + DONT\_PARSE disables parsing for source code files (determined by extension) Please don't abuse: use separate DONT\_PARSE macro call only for files subject to parsing -This form is for use from other plugins: -RESOURCE\_FILES([DEST {dest}] {path}) expands into RESOURCE({path} resfs/file/{dest}) - +This form is for use from other plugins: +RESOURCE\_FILES([DEST {dest}] {path}) expands into RESOURCE({path} resfs/file/{dest}) + @see: https://wiki.yandex-team.ru/devtools/commandsandvars/resourcefiles/ ###### Macro [RESTRICT\_LICENSES][](ALLOW\_ONLY|DENY LicenseProperty...) <a name="macro_RESTRICT_LICENSES"></a> @@ -2189,18 +2189,18 @@ All macro invocation for the same module must use same constraints type (DENY or ###### Macro [RESTRICT\_PATH][] <a name="macro_RESTRICT_PATH"></a> Not documented yet. -###### Macro [RUN][] <a name="macro_RUN"></a> -Not documented yet. - +###### Macro [RUN][] <a name="macro_RUN"></a> +Not documented yet. + ###### Macro [RUN\_ANTLR][](Args...) <a name="macro_RUN_ANTLR"></a> Macro to invoke ANTLR3 generator (general case) - + ###### Macro [RUN\_ANTLR4][](Args...) <a name="macro_RUN_ANTLR4"></a> Macro to invoke ANTLR4 generator (general case) - + ###### Macro [RUN\_ANTLR4\_CPP][](GRAMMAR, OUTPUT\_INCLUDES, LISTENER, VISITOR, Args...) <a name="macro_RUN_ANTLR4_CPP"></a> Macro to invoke ANTLR4 generator (Cpp) - + ###### Macro [RUN\_ANTLR4\_GO][](GRAMMAR, OUTPUT\_INCLUDES, LISTENER, VISITOR, Args...) <a name="macro_RUN_ANTLR4_GO"></a> Macro to invoke ANTLR4 generator (Go) @@ -2208,166 +2208,166 @@ Macro to invoke ANTLR4 generator (Go) Not documented yet. ###### Macro [RUN\_PROGRAM][](tool\_path args... [CWD dir] [ENV key=value...] [TOOL tools...] [IN inputs...] [OUT[\_NOAUTO] outputs...] [STDOUT[\_NOAUTO] output] [OUTPUT\_INCLUDES output\_includes...] [REQUIREMENTS reqs]) <a name="macro_RUN_PROGRAM"></a> -Run a program from arcadia. +Run a program from arcadia. These macros are similar: RUN\_PROGRAM, LUA, PYTHON. - -Parameters: -- tool\_path - Path to the directory of the tool. -- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. -- CWD dir - Absolute path of the working directory. -- ENV key=value... - Environment variables. -- TOOL tools... - Auxiliary tool directories. + +Parameters: +- tool\_path - Path to the directory of the tool. +- args... - Program arguments. Relative paths listed in TOOL, IN, OUT, STDOUT become absolute. +- CWD dir - Absolute path of the working directory. +- ENV key=value... - Environment variables. +- TOOL tools... - Auxiliary tool directories. - IN inputs... - Input files -- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. -- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. -- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. +- OUT[\_NOAUTO] outputs... - Output files. NOAUTO outputs are not automatically added to the build process. +- STDOUT[\_NOAUTO] output - Redirect the standard output to the output file. +- OUTPUT\_INCLUDES output\_includes... - Includes of the output files that are needed to build them. - REQUIREMENTS - Override default requirements for CPU and RAM - -For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or -${CURDIR} and ${BINDIR} which are expanded where the outputs are used. + +For absolute paths use ${ARCADIA\_ROOT} and ${ARCADIA\_BUILD\_ROOT}, or +${CURDIR} and ${BINDIR} which are expanded where the outputs are used. Note that Tool is always built for the host platform, so be careful to provide that tool can be built for all Arcadia major host platforms (Linux, MacOS and Windows). - -###### Macro [RUN\_PYTHON][](Args...) <a name="macro_RUN_PYTHON"></a> -Version of RUN() macro to invoke Python scripts -@see: [RUN()](#macro\_RUN) - + +###### Macro [RUN\_PYTHON][](Args...) <a name="macro_RUN_PYTHON"></a> +Version of RUN() macro to invoke Python scripts +@see: [RUN()](#macro\_RUN) + ###### Macro [SDBUS\_CPP\_ADAPTOR][](File) <a name="macro_SDBUS_CPP_ADAPTOR"></a> Not documented yet. ###### Macro [SDBUS\_CPP\_PROXY][](File) <a name="macro_SDBUS_CPP_PROXY"></a> Not documented yet. -###### Macro [SET][](varname value) _#builtin_ <a name="macro_SET"></a> -Sets varname to value - -###### Macro [SETUP\_EXECTEST][] <a name="macro_SETUP_EXECTEST"></a> -Not documented yet. - +###### Macro [SET][](varname value) _#builtin_ <a name="macro_SET"></a> +Sets varname to value + +###### Macro [SETUP\_EXECTEST][] <a name="macro_SETUP_EXECTEST"></a> +Not documented yet. + ###### Macro [SETUP\_PYTEST\_BIN][] <a name="macro_SETUP_PYTEST_BIN"></a> -Not documented yet. - -###### Macro [SETUP\_RUN\_PYTHON][] <a name="macro_SETUP_RUN_PYTHON"></a> -Not documented yet. - -###### Macro [SET\_APPEND][](varname appendvalue) _#builtin_ <a name="macro_SET_APPEND"></a> -Appends appendvalue to varname's value using space as a separator - -###### Macro [SET\_APPEND\_WITH\_GLOBAL][](varname appendvalue) _#builtin_ <a name="macro_SET_APPEND_WITH_GLOBAL"></a> -Appends appendvalue to varname's value using space as a separator. -New value is propagated to dependants - +Not documented yet. + +###### Macro [SETUP\_RUN\_PYTHON][] <a name="macro_SETUP_RUN_PYTHON"></a> +Not documented yet. + +###### Macro [SET\_APPEND][](varname appendvalue) _#builtin_ <a name="macro_SET_APPEND"></a> +Appends appendvalue to varname's value using space as a separator + +###### Macro [SET\_APPEND\_WITH\_GLOBAL][](varname appendvalue) _#builtin_ <a name="macro_SET_APPEND_WITH_GLOBAL"></a> +Appends appendvalue to varname's value using space as a separator. +New value is propagated to dependants + ###### Macro [SET\_COMPILE\_OUTPUTS\_MODIFIERS][](NOREL?";norel":"") <a name="macro_SET_COMPILE_OUTPUTS_MODIFIERS"></a> Not documented yet. -###### Macro [SIZE][](SMALL/MEDIUM/LARGE) <a name="macro_SIZE"></a> +###### Macro [SIZE][](SMALL/MEDIUM/LARGE) <a name="macro_SIZE"></a> Set the 'size' for the test. Each 'size' has own set of resrtictions, SMALL bein the most restricted and LARGE being the list. -See documentation on test system for more details. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [SKIP\_TEST][](Reason) <a name="macro_SKIP_TEST"></a> -Skip the suite defined by test module. Provide a reason to be output in test execution report. - +See documentation on test system for more details. + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [SKIP\_TEST][](Reason) <a name="macro_SKIP_TEST"></a> +Skip the suite defined by test module. Provide a reason to be output in test execution report. + ###### Macro [SOURCE\_GROUP][](...) _#builtin, deprecated_ <a name="macro_SOURCE_GROUP"></a> -Ignored - -###### Macro [SPLIT\_CODEGEN][](tool prefix opts... [OUT\_NUM num] [OUTPUT\_INCLUDES output\_includes...]) <a name="macro_SPLIT_CODEGEN"></a> -Generator of a certain number of parts of the .cpp file + one header .h file from .in - -Supports keywords: -1. OUT\_NUM <the number of generated Prefix.N.cpp default 25 (N varies from 0 to 24)> -2. OUTPUT\_INCLUDES <path to files that will be included in generalnyj of macro files> - -###### Macro [SPLIT\_DWARF][]() <a name="macro_SPLIT_DWARF"></a> -Emit debug info for the PROGRAM/DLL as a separate file <module\_name>.debug. +Ignored + +###### Macro [SPLIT\_CODEGEN][](tool prefix opts... [OUT\_NUM num] [OUTPUT\_INCLUDES output\_includes...]) <a name="macro_SPLIT_CODEGEN"></a> +Generator of a certain number of parts of the .cpp file + one header .h file from .in + +Supports keywords: +1. OUT\_NUM <the number of generated Prefix.N.cpp default 25 (N varies from 0 to 24)> +2. OUTPUT\_INCLUDES <path to files that will be included in generalnyj of macro files> + +###### Macro [SPLIT\_DWARF][]() <a name="macro_SPLIT_DWARF"></a> +Emit debug info for the PROGRAM/DLL as a separate file <module\_name>.debug. NB: It does not help you to save process RSS but can add problems (see e.g. BEGEMOT-2147). - -###### Macro [SPLIT\_FACTOR][](x) <a name="macro_SPLIT_FACTOR"></a> -Sets the number of chunks for parallel run tests when used in test module with FORK\_TESTS() or FORK\_SUBTESTS(). -If none of those is specified this macro implies FORK\_TESTS(). - -Supports C++ ut and PyTest. - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [SRC][](File Flags...) <a name="macro_SRC"></a> -Compile single file with extra Flags. -Compilation is driven by the last extension of the File and Flags are specific to corresponding compilation command - -###### Macro [SRCDIR][](dirlist) _# builtin_ <a name="macro_SRCDIR"></a> -Add the specified directories to the list of those in which the source files will be searched -Available only for arcadia/contrib - -###### Macro [SRCS][](<[GLOBAL] File> ...) <a name="macro_SRCS"></a> -Source files of the project. Files are built according to their extension and put int module output or fed to ultimate PROGRAM/DLL depending on GLOBAL presence. -Arcadia Paths from the root and is relative to the project's LIST are supported - -GLOBAL marks next file as direct input to link phase of the program/shared library project built into. This prevents symbols of the file to be excluded by linker as unused. + +###### Macro [SPLIT\_FACTOR][](x) <a name="macro_SPLIT_FACTOR"></a> +Sets the number of chunks for parallel run tests when used in test module with FORK\_TESTS() or FORK\_SUBTESTS(). +If none of those is specified this macro implies FORK\_TESTS(). + +Supports C++ ut and PyTest. + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [SRC][](File Flags...) <a name="macro_SRC"></a> +Compile single file with extra Flags. +Compilation is driven by the last extension of the File and Flags are specific to corresponding compilation command + +###### Macro [SRCDIR][](dirlist) _# builtin_ <a name="macro_SRCDIR"></a> +Add the specified directories to the list of those in which the source files will be searched +Available only for arcadia/contrib + +###### Macro [SRCS][](<[GLOBAL] File> ...) <a name="macro_SRCS"></a> +Source files of the project. Files are built according to their extension and put int module output or fed to ultimate PROGRAM/DLL depending on GLOBAL presence. +Arcadia Paths from the root and is relative to the project's LIST are supported + +GLOBAL marks next file as direct input to link phase of the program/shared library project built into. This prevents symbols of the file to be excluded by linker as unused. The scope of the GLOBAL keyword is the following file (that is, in the case of SRCS(GLOBAL foo.cpp bar.cpp) global will be only foo.cpp) - -@example: - - LIBRARY(test_global) - SRCS(GLOBAL foo.cpp) - END() - -This will produce foo.o and feed it to any PROGRAM/DLL module transitively depending on test\_global library. The library itself will be empty and won't produce .a file. - -###### Macro [SRC\_CPP\_AVX][](File Flags...) <a name="macro_SRC_CPP_AVX"></a> -Compile single .cpp-file with AVX and extra Flags. - -###### Macro [SRC\_CPP\_AVX2][](File Flags...) <a name="macro_SRC_CPP_AVX2"></a> -Compile single .cpp-file with AVX2 and extra Flags. - + +@example: + + LIBRARY(test_global) + SRCS(GLOBAL foo.cpp) + END() + +This will produce foo.o and feed it to any PROGRAM/DLL module transitively depending on test\_global library. The library itself will be empty and won't produce .a file. + +###### Macro [SRC\_CPP\_AVX][](File Flags...) <a name="macro_SRC_CPP_AVX"></a> +Compile single .cpp-file with AVX and extra Flags. + +###### Macro [SRC\_CPP\_AVX2][](File Flags...) <a name="macro_SRC_CPP_AVX2"></a> +Compile single .cpp-file with AVX2 and extra Flags. + ###### Macro [SRC\_CPP\_PIC][](File Flags...) <a name="macro_SRC_CPP_PIC"></a> Compile single .c-file with -fPIC and extra Flags. -###### Macro [SRC\_CPP\_SSE2][](File Flags...) <a name="macro_SRC_CPP_SSE2"></a> -Compile single .cpp-file with SSE2 and extra Flags. - -###### Macro [SRC\_CPP\_SSE3][](File Flags...) <a name="macro_SRC_CPP_SSE3"></a> -Compile single .cpp-file with SSE3 and extra Flags. - -###### Macro [SRC\_CPP\_SSE4][](File Flags...) <a name="macro_SRC_CPP_SSE4"></a> -Compile single .cpp-file with SSE4 (SSE4.1, SSE4.2 and POPCNT) and extra Flags. - -###### Macro [SRC\_CPP\_SSE41][](File Flags...) <a name="macro_SRC_CPP_SSE41"></a> -Compile single .cpp-file with SSE4.1 and extra Flags. - -###### Macro [SRC\_CPP\_SSSE3][](File Flags...) <a name="macro_SRC_CPP_SSSE3"></a> -Compile single .cpp-file with SSSE3 and extra Flags. - -###### Macro [SRC\_C\_AVX][](File Flags...) <a name="macro_SRC_C_AVX"></a> -Compile single .c-file with AVX and extra Flags. - -###### Macro [SRC\_C\_AVX2][](File Flags...) <a name="macro_SRC_C_AVX2"></a> -Compile single .c-file with AVX2 and extra Flags. - -###### Macro [SRC\_C\_SSE2][](File Flags...) <a name="macro_SRC_C_SSE2"></a> -Compile single .c-file with SSE2 and extra Flags. - -###### Macro [SRC\_C\_SSE3][](File Flags...) <a name="macro_SRC_C_SSE3"></a> -Compile single .c-file with SSE3 and extra Flags. - -###### Macro [SRC\_C\_SSE4][](File Flags...) <a name="macro_SRC_C_SSE4"></a> -Compile single .c-file with SSE4 (SSE4.1, SSE4.2 and POPCNT) and extra Flags. - -###### Macro [SRC\_C\_SSE41][](File Flags...) <a name="macro_SRC_C_SSE41"></a> -Compile single .c-file with SSE4.1 and extra Flags. - -###### Macro [SRC\_C\_SSSE3][](File Flags...) <a name="macro_SRC_C_SSSE3"></a> -Compile single .c-file with SSSE3 and extra Flags. - +###### Macro [SRC\_CPP\_SSE2][](File Flags...) <a name="macro_SRC_CPP_SSE2"></a> +Compile single .cpp-file with SSE2 and extra Flags. + +###### Macro [SRC\_CPP\_SSE3][](File Flags...) <a name="macro_SRC_CPP_SSE3"></a> +Compile single .cpp-file with SSE3 and extra Flags. + +###### Macro [SRC\_CPP\_SSE4][](File Flags...) <a name="macro_SRC_CPP_SSE4"></a> +Compile single .cpp-file with SSE4 (SSE4.1, SSE4.2 and POPCNT) and extra Flags. + +###### Macro [SRC\_CPP\_SSE41][](File Flags...) <a name="macro_SRC_CPP_SSE41"></a> +Compile single .cpp-file with SSE4.1 and extra Flags. + +###### Macro [SRC\_CPP\_SSSE3][](File Flags...) <a name="macro_SRC_CPP_SSSE3"></a> +Compile single .cpp-file with SSSE3 and extra Flags. + +###### Macro [SRC\_C\_AVX][](File Flags...) <a name="macro_SRC_C_AVX"></a> +Compile single .c-file with AVX and extra Flags. + +###### Macro [SRC\_C\_AVX2][](File Flags...) <a name="macro_SRC_C_AVX2"></a> +Compile single .c-file with AVX2 and extra Flags. + +###### Macro [SRC\_C\_SSE2][](File Flags...) <a name="macro_SRC_C_SSE2"></a> +Compile single .c-file with SSE2 and extra Flags. + +###### Macro [SRC\_C\_SSE3][](File Flags...) <a name="macro_SRC_C_SSE3"></a> +Compile single .c-file with SSE3 and extra Flags. + +###### Macro [SRC\_C\_SSE4][](File Flags...) <a name="macro_SRC_C_SSE4"></a> +Compile single .c-file with SSE4 (SSE4.1, SSE4.2 and POPCNT) and extra Flags. + +###### Macro [SRC\_C\_SSE41][](File Flags...) <a name="macro_SRC_C_SSE41"></a> +Compile single .c-file with SSE4.1 and extra Flags. + +###### Macro [SRC\_C\_SSSE3][](File Flags...) <a name="macro_SRC_C_SSSE3"></a> +Compile single .c-file with SSSE3 and extra Flags. + ###### Macro [SRC\_RESOURCE][](Id) <a name="macro_SRC_RESOURCE"></a> Not documented yet. -###### Macro [STRIP][]() <a name="macro_STRIP"></a> -Strip debug info from a PROGRAM, DLL or TEST. -This macro doesn't work in LIBRARY's, UNION's and PACKAGE's. - -###### Macro [STRUCT\_CODEGEN][](Prefix) <a name="macro_STRUCT_CODEGEN"></a> -A special case BASE\_CODEGEN, in which the kernel/struct\_codegen/codegen\_tool tool is used. - +###### Macro [STRIP][]() <a name="macro_STRIP"></a> +Strip debug info from a PROGRAM, DLL or TEST. +This macro doesn't work in LIBRARY's, UNION's and PACKAGE's. + +###### Macro [STRUCT\_CODEGEN][](Prefix) <a name="macro_STRUCT_CODEGEN"></a> +A special case BASE\_CODEGEN, in which the kernel/struct\_codegen/codegen\_tool tool is used. + ###### Macro [STYLE][](Globs...) <a name="macro_STYLE"></a> Not documented yet. @@ -2389,39 +2389,39 @@ and tsan.supp for thread sanitizer suppressions respectively. See https://clang.llvm.org/docs/AddressSanitizer.html#suppressing-memory-leaks for details. -###### Macro [SYMLINK][](from to) <a name="macro_SYMLINK"></a> -Add symlink - -###### Macro [SYSTEM\_PROPERTIES][]([<Key Value>...] [<File Path>...]) <a name="macro_SYSTEM_PROPERTIES"></a> -List of Key,Value pairs that will be available to test via System.getProperty(). -FILE means that parst should be read from file specifies as Path. - -Documentation: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [TAG][] ([tag...]) <a name="macro_TAG"></a> -Each test can have one or more tags used to filter tests list for running. -There are also special tags affecting test behaviour, for example ya:external, sb:ssd. - -Documentation: https://wiki.yandex-team.ru/yatool/test/#obshhieponjatija - -###### Macro [TASKLET][]() <a name="macro_TASKLET"></a> -Not documented yet. - -###### Macro [TASKLET\_REG][](Name, Lang, Impl, Includes...) <a name="macro_TASKLET_REG"></a> -Not documented yet. - +###### Macro [SYMLINK][](from to) <a name="macro_SYMLINK"></a> +Add symlink + +###### Macro [SYSTEM\_PROPERTIES][]([<Key Value>...] [<File Path>...]) <a name="macro_SYSTEM_PROPERTIES"></a> +List of Key,Value pairs that will be available to test via System.getProperty(). +FILE means that parst should be read from file specifies as Path. + +Documentation: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [TAG][] ([tag...]) <a name="macro_TAG"></a> +Each test can have one or more tags used to filter tests list for running. +There are also special tags affecting test behaviour, for example ya:external, sb:ssd. + +Documentation: https://wiki.yandex-team.ru/yatool/test/#obshhieponjatija + +###### Macro [TASKLET][]() <a name="macro_TASKLET"></a> +Not documented yet. + +###### Macro [TASKLET\_REG][](Name, Lang, Impl, Includes...) <a name="macro_TASKLET_REG"></a> +Not documented yet. + ###### Macro [TASKLET\_REG\_EXT][](Name, Lang, Impl, Wrapper, Includes...) <a name="macro_TASKLET_REG_EXT"></a> Not documented yet. -###### Macro [TEST\_CWD][](path) <a name="macro_TEST_CWD"></a> -Defines working directory for test runs. Othen used in conjunction with DATA() macro. -Is only used inside of the TEST modules. - -Documentation: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [TEST\_DATA][] <a name="macro_TEST_DATA"></a> -Not documented yet. - +###### Macro [TEST\_CWD][](path) <a name="macro_TEST_CWD"></a> +Defines working directory for test runs. Othen used in conjunction with DATA() macro. +Is only used inside of the TEST modules. + +Documentation: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [TEST\_DATA][] <a name="macro_TEST_DATA"></a> +Not documented yet. + ###### Macro [TEST\_JAVA\_CLASSPATH\_CMD\_TYPE][](Type) <a name="macro_TEST_JAVA_CLASSPATH_CMD_TYPE"></a> Availible types: MANIFEST(default), COMMAND\_FILE, LIST Method for passing a classpath value to a java command line @@ -2429,34 +2429,34 @@ MANIFEST via empty jar file with manifest that cantains Class-Path attribute COMMAND\_FILE via @command\_file LIST via flat args -###### Macro [TEST\_SRCS][](Files...) <a name="macro_TEST_SRCS"></a> +###### Macro [TEST\_SRCS][](Files...) <a name="macro_TEST_SRCS"></a> In PY2TEST, PY3TEST and PY\*\_LIBRARY modules used as PY\_SRCS macro and additionally used to mine test cases to be executed by testing framework. - -Documentation: https://wiki.yandex-team.ru/yatool/test/#testynapytest - -###### Macro [TIMEOUT][](TIMEOUT) <a name="macro_TIMEOUT"></a> -Sets a timeout on test execution - -Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ - -###### Macro [UBERJAR][]() <a name="macro_UBERJAR"></a> + +Documentation: https://wiki.yandex-team.ru/yatool/test/#testynapytest + +###### Macro [TIMEOUT][](TIMEOUT) <a name="macro_TIMEOUT"></a> +Sets a timeout on test execution + +Documentation about the system test: https://wiki.yandex-team.ru/yatool/test/ + +###### Macro [UBERJAR][]() <a name="macro_UBERJAR"></a> UBERJAR is a single all-in-one jar-archive that includes all its Java dependencies (reachable PEERDIR). -It also supports shading classes inside the archive by moving them to a different package (similar to the maven-shade-plugin). -Use UBERJAR inside JAVA\_PROGRAM module. - -You can use the following macros to configure the archive: -1. UBERJAR\_HIDING\_PREFIX prefix for classes to shade (classes remain in their packages by default) +It also supports shading classes inside the archive by moving them to a different package (similar to the maven-shade-plugin). +Use UBERJAR inside JAVA\_PROGRAM module. + +You can use the following macros to configure the archive: +1. UBERJAR\_HIDING\_PREFIX prefix for classes to shade (classes remain in their packages by default) 2. UBERJAR\_HIDE\_EXCLUDE\_PATTERN exclude classes matching this patterns from shading (if enabled). -3. UBERJAR\_PATH\_EXCLUDE\_PREFIX the prefix for classes that should not get into the jar archive (all classes are placed into the archive by default) +3. UBERJAR\_PATH\_EXCLUDE\_PREFIX the prefix for classes that should not get into the jar archive (all classes are placed into the archive by default) 4. UBERJAR\_MANIFEST\_TRANSFORMER\_MAIN add ManifestResourceTransformer class to uberjar processing and specify main-class 5. UBERJAR\_MANIFEST\_TRANSFORMER\_ATTRIBUTE add ManifestResourceTransformer class to uberjar processing and specify some attribute 6. UBERJAR\_APPENDING\_TRANSFORMER add AppendingTransformer class to uberjar processing 7. UBERJAR\_SERVICES\_RESOURCE\_TRANSFORMER add ServicesResourceTransformer class to uberjar processing - -Documentation: https://wiki.yandex-team.ru/yatool/java/ - -@see: [JAVA\_PROGRAM](#module\_JAVA\_PROGRAM), [UBERJAR\_HIDING\_PREFIX](#macro\_UBERJAR\_HIDING\_PREFIX), [UBERJAR\_HIDE\_EXCLUDE\_PATTERN](#macro\_UBERJAR\_HIDE\_EXCLUDE\_PATTERN), [UBERJAR\_PATH\_EXCLUDE\_PREFIX](#macro\_UBERJAR\_PATH\_EXCLUDE\_PREFIX) - + +Documentation: https://wiki.yandex-team.ru/yatool/java/ + +@see: [JAVA\_PROGRAM](#module\_JAVA\_PROGRAM), [UBERJAR\_HIDING\_PREFIX](#macro\_UBERJAR\_HIDING\_PREFIX), [UBERJAR\_HIDE\_EXCLUDE\_PATTERN](#macro\_UBERJAR\_HIDE\_EXCLUDE\_PATTERN), [UBERJAR\_PATH\_EXCLUDE\_PREFIX](#macro\_UBERJAR\_PATH\_EXCLUDE\_PREFIX) + ###### Macro [UBERJAR\_APPENDING\_TRANSFORMER][](Resource) <a name="macro_UBERJAR_APPENDING_TRANSFORMER"></a> Add AppendingTransformer for UBERJAR() java programs @@ -2465,19 +2465,19 @@ Parameters: @see: [UBERJAR](#macro\_UBERJAR) -###### Macro [UBERJAR\_HIDE\_EXCLUDE\_PATTERN][](Args...) <a name="macro_UBERJAR_HIDE_EXCLUDE_PATTERN"></a> -Exculude classes matching this patterns from shading (if enabled). -Pattern may contain '\*' and '\*\*' globs. -Shading is enabled for UBERJAR program using UBERJAR\_HIDING\_PREFIX macro. If this macro is not specified all classes are shaded. - -@see: [UBERJAR](#macro\_UBERJAR), [UBERJAR\_HIDING\_PREFIX](#macro\_UBERJAR\_HIDING\_PREFIX) - -###### Macro [UBERJAR\_HIDING\_PREFIX][](Arg) <a name="macro_UBERJAR_HIDING_PREFIX"></a> -Set prefix for classes to shade. All classes in UBERJAR will be moved into package prefixed with Arg. -Classes remain in their packages by default. - -@see: [UBERJAR](#macro\_UBERJAR) - +###### Macro [UBERJAR\_HIDE\_EXCLUDE\_PATTERN][](Args...) <a name="macro_UBERJAR_HIDE_EXCLUDE_PATTERN"></a> +Exculude classes matching this patterns from shading (if enabled). +Pattern may contain '\*' and '\*\*' globs. +Shading is enabled for UBERJAR program using UBERJAR\_HIDING\_PREFIX macro. If this macro is not specified all classes are shaded. + +@see: [UBERJAR](#macro\_UBERJAR), [UBERJAR\_HIDING\_PREFIX](#macro\_UBERJAR\_HIDING\_PREFIX) + +###### Macro [UBERJAR\_HIDING\_PREFIX][](Arg) <a name="macro_UBERJAR_HIDING_PREFIX"></a> +Set prefix for classes to shade. All classes in UBERJAR will be moved into package prefixed with Arg. +Classes remain in their packages by default. + +@see: [UBERJAR](#macro\_UBERJAR) + ###### Macro [UBERJAR\_MANIFEST\_TRANSFORMER\_ATTRIBUTE][](Key, Value) <a name="macro_UBERJAR_MANIFEST_TRANSFORMER_ATTRIBUTE"></a> Transform manifest.mf for UBERJAR() java programs, set attribute @@ -2488,12 +2488,12 @@ Transform manifest.mf for UBERJAR() java programs, set main-class attribute @see: [UBERJAR](#macro\_UBERJAR) -###### Macro [UBERJAR\_PATH\_EXCLUDE\_PREFIX][](Args...) <a name="macro_UBERJAR_PATH_EXCLUDE_PREFIX"></a> -Exculude classes matching this patterns from UBERJAR. -By default all dependencies of UBERJAR program will lend in a .jar archive. - -@see: [UBERJAR](#macro\_UBERJAR) - +###### Macro [UBERJAR\_PATH\_EXCLUDE\_PREFIX][](Args...) <a name="macro_UBERJAR_PATH_EXCLUDE_PREFIX"></a> +Exculude classes matching this patterns from UBERJAR. +By default all dependencies of UBERJAR program will lend in a .jar archive. + +@see: [UBERJAR](#macro\_UBERJAR) + ###### Macro [UBERJAR\_SERVICES\_RESOURCE\_TRANSFORMER][]() <a name="macro_UBERJAR_SERVICES_RESOURCE_TRANSFORMER"></a> Add ServicesResourceTransformer for UBERJAR() java programs @@ -2512,9 +2512,9 @@ Not documented yet. Add dependency on C++ runtime Note: This macro is inteneded for use in \_GO\_BASE\_UNIT like module when the module is built without C++ runtime by default -###### Macro [USE\_ERROR\_PRONE][]() <a name="macro_USE_ERROR_PRONE"></a> -Use errorprone instead of javac for .java compilation. - +###### Macro [USE\_ERROR\_PRONE][]() <a name="macro_USE_ERROR_PRONE"></a> +Use errorprone instead of javac for .java compilation. + ###### Macro [USE\_EXT\_PROTO][](peerdir\_tag...) <a name="macro_USE_EXT_PROTO"></a> Configure module to use proto files from existing PROTO\_LIBRARY module. Additional PEERDIR tags required to build a module can be passed through @@ -2535,37 +2535,37 @@ Use lld linker for a program. This doesn't work in libraries ###### Macro [USE\_PERL\_514\_LIB][]() <a name="macro_USE_PERL_514_LIB"></a> Add dependency on Perl 5.14 to your LIBRARY -###### Macro [USE\_PERL\_LIB][]() <a name="macro_USE_PERL_LIB"></a> -Add dependency on Perl to your LIBRARY - +###### Macro [USE\_PERL\_LIB][]() <a name="macro_USE_PERL_LIB"></a> +Add dependency on Perl to your LIBRARY + ###### Macro [USE\_PLANTUML][]() <a name="macro_USE_PLANTUML"></a> Use PlantUML plug-in for yfm builder to render UML diagrams into documentation ###### Macro [USE\_PYTHON2][]() <a name="macro_USE_PYTHON2"></a> -This adds Python 2.x runtime library to your LIBRARY and makes it Python2-compatible. -Compatibility means proper PEERDIRs, ADDINCLs and variant selection on PEERDIRs to multimodules. - +This adds Python 2.x runtime library to your LIBRARY and makes it Python2-compatible. +Compatibility means proper PEERDIRs, ADDINCLs and variant selection on PEERDIRs to multimodules. + If you'd like to use #include <Python.h> with Python2 specify USE\_PYTHON2 or better make it PY2\_LIBRARY. -If you'd like to use #include <Python.h> with Python3 specify USE\_PYTHON3 or better make it PY3\_LIBRARY. -If you'd like to use #include <Python.h> with both Python2 and Python3 convert your LIBRARY to PY23\_LIBRARY. - +If you'd like to use #include <Python.h> with Python3 specify USE\_PYTHON3 or better make it PY3\_LIBRARY. +If you'd like to use #include <Python.h> with both Python2 and Python3 convert your LIBRARY to PY23\_LIBRARY. + @see: [PY2\_LIBRARY](#module\_PY2\_LIBRARY), [PY3\_LIBRARY](#module\_PY3\_LIBRARY), [PY23\_LIBRARY](#multimodule\_PY23\_LIBRARY) - + ###### Macro [USE\_PYTHON3][]() <a name="macro_USE_PYTHON3"></a> -This adds Python3 library to your LIBRARY and makes it Python3-compatible. -Compatibility means proper PEERDIRs, ADDINCLs and variant selection on PEERDIRs to multimodules. - -If you'd like to use #include <Python.h> with Python3 specify USE\_PYTHON3 or better make it PY3\_LIBRARY. +This adds Python3 library to your LIBRARY and makes it Python3-compatible. +Compatibility means proper PEERDIRs, ADDINCLs and variant selection on PEERDIRs to multimodules. + +If you'd like to use #include <Python.h> with Python3 specify USE\_PYTHON3 or better make it PY3\_LIBRARY. If you'd like to use #include <Python.h> with Python2 specify USE\_PYTHON2 or better make it PY2\_LIBRARY. -If you'd like to use #include <Python.h> with both Python2 and Python3 convert your LIBRARY to PY23\_LIBRARY. - +If you'd like to use #include <Python.h> with both Python2 and Python3 convert your LIBRARY to PY23\_LIBRARY. + @see: [PY2\_LIBRARY](#module\_PY2\_LIBRARY), [PY3\_LIBRARY](#module\_PY3\_LIBRARY), [PY23\_LIBRARY](#multimodule\_PY23\_LIBRARY) - -###### Macro [USE\_RECIPE][](path [arg1 arg2...]) <a name="macro_USE_RECIPE"></a> -Provides prepared environment via recipe for test. - -Documentation: https://wiki.yandex-team.ru/yatool/test/recipes - + +###### Macro [USE\_RECIPE][](path [arg1 arg2...]) <a name="macro_USE_RECIPE"></a> +Provides prepared environment via recipe for test. + +Documentation: https://wiki.yandex-team.ru/yatool/test/recipes + ###### Macro [USE\_SKIFF][]() _#wip, do not use_ <a name="macro_USE_SKIFF"></a> Use mapreduce/yt/skiff\_proto/plugin for C++ @@ -2577,18 +2577,18 @@ Note: This macro is intended for use in \_GO\_BASE\_UNIT like module when the mo Change uid for resource validation tests. May be useful when sandbox resource ttl is changed, but test status is cached in CI. You can change ext to change test's uid. For example VALIDATE\_DATA\_RESTART(X), where is X is current revision. -###### Macro [VERSION][](Args...) <a name="macro_VERSION"></a> -Specify version of a module. Currently unused by build system, only informative. - +###### Macro [VERSION][](Args...) <a name="macro_VERSION"></a> +Specify version of a module. Currently unused by build system, only informative. + ###### Macro [VISIBILITY][](level) <a name="macro_VISIBILITY"></a> This macro sets visibility level for symbols compiled for the current module. 'level' may take only one of the following values: DEFAULT, HIDDEN. -###### Macro [WERROR][]() <a name="macro_WERROR"></a> -Consider warnings as errors in the current module. -In the bright future will be removed, since WERROR is the default. -Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. - +###### Macro [WERROR][]() <a name="macro_WERROR"></a> +Consider warnings as errors in the current module. +In the bright future will be removed, since WERROR is the default. +Priorities: NO\_COMPILER\_WARNINGS > NO\_WERROR > WERROR\_MODE > WERROR. + ###### Macro [WINDOWS\_MANIFEST][](Manifest) <a name="macro_WINDOWS_MANIFEST"></a> Not documented yet. @@ -2603,9 +2603,9 @@ Include dynamic libraries as extra PROGRAM/DLL outputs ###### Macro [WITH\_GROOVY][]() <a name="macro_WITH_GROOVY"></a> Compile groovy source code in this java module -###### Macro [WITH\_JDK][]() <a name="macro_WITH_JDK"></a> +###### Macro [WITH\_JDK][]() <a name="macro_WITH_JDK"></a> Add directory with JDK to JAVA\_PROGRAM output - + ###### Macro [WITH\_KOTLIN][]() <a name="macro_WITH_KOTLIN"></a> Compile kotlin source code in this java module @@ -2615,19 +2615,19 @@ Enable allopen kotlin compiler plugin https://kotlinlang.org/docs/all-open-plugi ###### Macro [WITH\_KOTLINC\_NOARG][](-flags) <a name="macro_WITH_KOTLINC_NOARG"></a> Enable noarg kotlin compiler plugin https://kotlinlang.org/docs/no-arg-plugin.html -###### Macro [XS\_PROTO][](InputProto Dir Outputs...) _# deprecated_ <a name="macro_XS_PROTO"></a> -Generate Perl code from protobuf. -In order to use this macro one should predict all outputs protoc will emit from input\_proto file and enlist those as outputs. - -###### Macro [YABS\_GENERATE\_CONF][] <a name="macro_YABS_GENERATE_CONF"></a> -Not documented yet. - -###### Macro [YABS\_GENERATE\_PHANTOM\_CONF\_PATCH][] <a name="macro_YABS_GENERATE_PHANTOM_CONF_PATCH"></a> -Not documented yet. - -###### Macro [YABS\_GENERATE\_PHANTOM\_CONF\_TEST\_CHECK][] <a name="macro_YABS_GENERATE_PHANTOM_CONF_TEST_CHECK"></a> -Not documented yet. - +###### Macro [XS\_PROTO][](InputProto Dir Outputs...) _# deprecated_ <a name="macro_XS_PROTO"></a> +Generate Perl code from protobuf. +In order to use this macro one should predict all outputs protoc will emit from input\_proto file and enlist those as outputs. + +###### Macro [YABS\_GENERATE\_CONF][] <a name="macro_YABS_GENERATE_CONF"></a> +Not documented yet. + +###### Macro [YABS\_GENERATE\_PHANTOM\_CONF\_PATCH][] <a name="macro_YABS_GENERATE_PHANTOM_CONF_PATCH"></a> +Not documented yet. + +###### Macro [YABS\_GENERATE\_PHANTOM\_CONF\_TEST\_CHECK][] <a name="macro_YABS_GENERATE_PHANTOM_CONF_TEST_CHECK"></a> +Not documented yet. + ###### Macro [YDL\_DESC\_USE\_BINARY][]() <a name="macro_YDL_DESC_USE_BINARY"></a> Used in conjunction with BUILD\_YDL\_DESC. When enabled, all generated descriptors are binary. @@ -2640,17 +2640,17 @@ Used in conjunction with BUILD\_YDL\_DESC. When enabled, all generated descripto This will generate descriptor Event.ydld in a binary format. -###### Macro [YMAPS\_SPROTO][](ProtoFiles...) _# maps-specific_ <a name="macro_YMAPS_SPROTO"></a> -Maps-specific .proto handling: generate .sproto.h files using maps/libs/sproto/sprotoc. - +###### Macro [YMAPS\_SPROTO][](ProtoFiles...) _# maps-specific_ <a name="macro_YMAPS_SPROTO"></a> +Maps-specific .proto handling: generate .sproto.h files using maps/libs/sproto/sprotoc. + ###### Macro [YP\_PROTO\_YSON][](Files... OUT\_OPTS Opts...) <a name="macro_YP_PROTO_YSON"></a> Genereate .yson.go from .proto using yp/go/yson/internal/proto-yson-gen/cmd/proto-yson-gen -###### Macro [YQL\_ABI\_VERSION][](major minor release)) <a name="macro_YQL_ABI_VERSION"></a> -Specifying the supported ABI for YQL\_UDF. - -@see: [YQL\_UDF()](#multimodule\_YQL\_UDF) - +###### Macro [YQL\_ABI\_VERSION][](major minor release)) <a name="macro_YQL_ABI_VERSION"></a> +Specifying the supported ABI for YQL\_UDF. + +@see: [YQL\_UDF()](#multimodule\_YQL\_UDF) + ###### Macro [YQL\_LAST\_ABI\_VERSION][]() <a name="macro_YQL_LAST_ABI_VERSION"></a> Use the last ABI for YQL\_UDF |