Add example input and output for the jq script

hcho3 · Nov 22, 2024 · 0dac170 · 0dac170
1 parent cc6dff7
commit 0dac170
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/ops/docker/extract_build_args.jq b/ops/docker/extract_build_args.jq
@@ -1,3 +1,7 @@
+## Example input:
+##   xgb-ci.gpu_build_r_rockylinux8
+## Example output:
+##   --build-arg CUDA_VERSION_ARG=12.4.1 --build-arg R_VERSION_ARG=4.3.2
 def compute_build_args($input; $container_id):
   $input |
   .[$container_id] |

diff --git a/ops/docker/extract_build_args.sh b/ops/docker/extract_build_args.sh
@@ -1,6 +1,11 @@
 #!/bin/bash
 ## Extract container definition and build args from ops/docker/ci_container.yml,
 ## given the container ID.
+##
+## Example input:
+##   xgb-ci.clang_tidy
+## Example output:
+##   CONTAINER_DEF='clang_tidy' BUILD_ARGS='--build-arg CUDA_VERSION_ARG=12.4.1'
 
 if [ "$#" -ne 1 ]; then
     echo "Usage: $0 [container_id]"