summaryrefslogtreecommitdiffstats
path: root/build
diff options
context:
space:
mode:
authorr-vetrov <[email protected]>2023-09-12 07:57:23 +0300
committerr-vetrov <[email protected]>2023-09-12 08:23:42 +0300
commit00b007a9fcb5f5db8ea11be6e1ea5cd9a83a1e5a (patch)
tree88d2ca85674d0e005e7972971114664c5faa13ca /build
parent6d41c4665a2e125f9a10dd44eabc136cc4991460 (diff)
[Docs] Better documentation for Sandbox macroses
Diffstat (limited to 'build')
-rw-r--r--build/ymake.core.conf50
1 files changed, 36 insertions, 14 deletions
diff --git a/build/ymake.core.conf b/build/ymake.core.conf
index 0d5319ff3a9..5c94d00209d 100644
--- a/build/ymake.core.conf
+++ b/build/ymake.core.conf
@@ -2371,19 +2371,17 @@ macro TEST_CWD(Arg) {
SET(TEST_CWD_VALUE $Arg)
}
-# tag:sandbox-specific
-### @usage: SANDBOX_TASK([Name])
+# tag:sandbox-specific tag:deprecated
+### @usage: SANDBOX_TASK([Name]) # deprecated
###
-### Multimodule describing Sandbox task (Python code that can be executed by Sandbox system).
+### Deprecated. Use SANDBOX_PY23_TASK, SANDBOX_PY3_TASK or SANDBOX_PY23_3_TASK instead.
###
-### When being a final target, this multimodule builds Sandbox binary task. It may PEERDIR other SANDBOX_TASKs as libraries.
+### When being a final target, this multimodule builds Python 2.x 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.
+### As PEERDIR target, it works like regular PY2_LIBRARY with predefined dependencies on Sandbox SDK.
###
-### Documentation: https://wiki.yandex-team.ru/sandbox/tasks/binary
+### Documentation: https://docs.yandex-team.ru/sandbox/dev/binary-task
multimodule SANDBOX_TASK {
module SB_TASK_BIN: _PY2_PROGRAM {
PY_MAIN(sandbox.taskbox.binary)
@@ -2409,6 +2407,19 @@ multimodule SANDBOX_TASK {
}
# tag:sandbox-specific
+### @usage: SANDBOX_PY23_3_TASK([Name])
+###
+### Multimodule describing Sandbox task – code that can be executed by Sandbox system.
+###
+### When being a final target, this multimodule builds Python 3.x Sandbox binary task.
+### It may PEERDIR other SANDBOX_PY3_TASK/SANDBOX_PY23_3_TASK as libraries.
+### The final artifact is provided when SANDBOX_PY23_3_TASK is referred to by DEPENDS and BUNDLE macros.
+### As PEERDIR target, it works like regular PY23_LIBRARY with predefined dependencies on Sandbox SDK.
+###
+### Sandbox supports Python 3.x only in binary tasks, both variants will be compatible only with Python 3.x and py23 libraries
+### and will select multimodule variants accordingly.
+###
+### Documentation: https://docs.yandex-team.ru/sandbox/dev/binary-task#python3
multimodule SANDBOX_PY23_3_TASK {
module SB_TASK_BIN: PY3_PROGRAM_BIN {
.IGNORED=RUN_ANTLR4_PYTHON
@@ -2442,6 +2453,16 @@ multimodule SANDBOX_PY23_3_TASK {
}
# tag:sandbox-specific
+### @usage: SANDBOX_PY23_TASK([Name])
+###
+### Multimodule describing Sandbox task – code that can be executed by Sandbox system.
+###
+### When being a final target, this multimodule builds Python 2.x Sandbox binary task.
+### It may PEERDIR other SANDBOX_PY23_TASKs as libraries.
+### The final artifact is provided when SANDBOX_PY23_TASK is referred to by DEPENDS and BUNDLE macros.
+### As PEERDIR target, it works like regular PY23_LIBRARY with predefined dependencies on Sandbox SDK.
+###
+### Documentation: https://docs.yandex-team.ru/sandbox/dev/binary-task
multimodule SANDBOX_PY23_TASK {
module SB_TASK_BIN: _PY2_PROGRAM {
.RESTRICTED=RUN_ANTLR4_PYTHON
@@ -2471,16 +2492,17 @@ multimodule SANDBOX_PY23_TASK {
# tag:sandbox-specific
### @usage: SANDBOX_PY3_TASK([Name])
###
-### Multimodule describing Sandbox task (Python3 code that can be executed by Sandbox system).
+### Multimodule describing Sandbox task – code that can be executed by Sandbox system.
###
-### When being a final target, this multimodule builds Sandbox binary task. It may PEERDIR other SANDBOX_PY3_TASKs as libraries.
+### When being a final target, this multimodule builds Python 3.x Sandbox binary task.
+### It may PEERDIR other SANDBOX_PY3_TASK/SANDBOX_PY23_3_TASK as libraries.
### The final artifact is provided when SANDBOX_PY3_TASK is referred to by DEPENDS and BUNDLE macros.
-### As PEERDIR target, it works like regular PY3_LIBRARY with predefined dependencies on Sandbox SDK to allow code reuse among SANDBOX_PY3_TASKs.
+### As PEERDIR target, it works like regular PY3_LIBRARY with predefined dependencies on Sandbox SDK.
###
-### Currently Sandbox supports Python 3.x only in binary tasks, both variants will be compatible only with Python 3.x and py23 libraries
+### Sandbox supports Python 3.x only in binary tasks, both variants will be compatible only with Python 3.x and py23 libraries
### and will select multimodule variants accordingly.
###
-### Documentation: https://wiki.yandex-team.ru/sandbox/tasks/binary
+### Documentation: https://docs.yandex-team.ru/sandbox/dev/binary-task#python3
multimodule SANDBOX_PY3_TASK {
module SB_TASK_BIN: PY3_PROGRAM_BIN {
.IGNORED=RUN_ANTLR4_PYTHON