Comandos y opciones

En esta página, se describen las opciones disponibles con varios comandos de Bazel, como bazel build, bazel run y bazel test. Esta página es complementaria a la lista de comandos de Bazel en Cómo compilar con Bazel.

Sintaxis de destino

Algunos comandos, como build o test, pueden operar en una lista de objetivos. Usan una sintaxis más flexible que las etiquetas, que se documenta en Especificación de destinos para compilar.

Opciones

En las siguientes secciones, se describen las opciones disponibles durante una compilación. Cuando se usa --long en un comando de ayuda, los mensajes de ayuda en línea proporcionan información de resumen sobre el significado, el tipo y el valor predeterminado de cada opción.

La mayoría de las opciones solo se pueden especificar una vez. Cuando se especifica varias veces, gana la última instancia. Las opciones que se pueden especificar varias veces se identifican en la ayuda en línea con el texto "se puede usar varias veces".

Ubicación del paquete

--package_path

ADVERTENCIA: La opción --package_path dejó de estar disponible. Bazel prefiere que los paquetes del repositorio principal estén debajo de la raíz del espacio de trabajo.

Esta opción especifica el conjunto de directorios que se buscan para encontrar el archivo BUILD de un paquete determinado.

Bazel busca sus paquetes en la ruta de acceso del paquete. Esta es una lista ordenada de directorios de Bazel, separados por dos puntos, cada uno de los cuales es la raíz de un árbol de fuentes parcial.

Para especificar una ruta de acceso de paquete personalizada con la opción --package_path, haz lo siguiente:

  % bazel build --package_path %workspace%:/some/other/root

Los elementos de la ruta de acceso del paquete se pueden especificar en tres formatos:

1. Si el primer carácter es /, la ruta es absoluta.
2. Si la ruta de acceso comienza con %workspace%, se toma en relación con el directorio bazel más cercano. Por ejemplo, si tu directorio de trabajo es /home/bob/clients/bob_client/bazel/foo, la cadena %workspace% en package-path se expande a /home/bob/clients/bob_client/bazel.
3. Todo lo demás se toma en relación con el directorio de trabajo. Por lo general, no es lo que quieres hacer y puede comportarse de forma inesperada si usas Bazel desde directorios debajo del espacio de trabajo de Bazel. Por ejemplo, si usas el elemento package-path . y, luego, cd en el directorio /home/bob/clients/bob_client/bazel/foo, los paquetes se resolverán desde el directorio /home/bob/clients/bob_client/bazel/foo.

Si usas una ruta de acceso de paquete no predeterminada, especifícala en tu archivo de configuración de Bazel para mayor comodidad.

Bazel no requiere que ningún paquete esté en el directorio actual, por lo que puedes realizar una compilación desde un espacio de trabajo de Bazel en blanco si todos los paquetes necesarios se pueden encontrar en otro lugar de la ruta de acceso del paquete.

Ejemplo: Cómo compilar desde un cliente vacío

  % mkdir -p foo/bazel
  % cd foo/bazel
  % touch MODULE.bazel
  % bazel build --package_path /some/other/path //foo

--deleted_packages

Esta opción especifica una lista separada por comas de paquetes que Bazel debería considerar borrados y no intentar cargar desde ningún directorio en la ruta del paquete. Se puede usar para simular la eliminación de paquetes sin borrarlos. Esta opción se puede pasar varias veces, en cuyo caso se concatenan las listas individuales.

Verificación de errores

Estas opciones controlan las verificaciones de errores o las advertencias de Bazel.

--[no]check_visibility

Si se establece como falsa, las verificaciones de visibilidad se degradan a advertencias. El valor predeterminado de esta opción es verdadero, por lo que, de forma predeterminada, se realiza la verificación de visibilidad.

--output_filter=regex

La opción --output_filter solo mostrará advertencias de compilación y compilación para los destinos que coincidan con la expresión regular. Si un objetivo no coincide con la expresión regular proporcionada y su ejecución se realiza correctamente, se descartan su salida estándar y su error estándar.

Estos son algunos valores típicos para esta opción:

Marcas de herramientas

Estas opciones controlan qué opciones pasará Bazel a otras herramientas.

--copt=cc-option

Esta opción toma un argumento que se pasará al compilador. El argumento se pasará al compilador cada vez que se invoque para el procesamiento previo, la compilación o el ensamblado de código C, C++ o ensamblador. No se pasará cuando se realice la vinculación.

Esta opción se puede usar varias veces. Por ejemplo:

  % bazel build --copt="-g0" --copt="-fpic" //foo

compilará la biblioteca foo sin tablas de depuración y generará código independiente de la posición.

--host_copt=cc-option

Esta opción toma un argumento que se pasará al compilador para los archivos de origen que se compilan en la configuración de exec. Esto es similar a la opción --copt, pero solo se aplica a la configuración de exec.

--host_conlyopt=cc-option

Esta opción toma un argumento que se pasará al compilador para los archivos de origen C que se compilan en la configuración de exec. Esto es similar a la opción --conlyopt, pero solo se aplica a la configuración de exec.

--host_cxxopt=cc-option

Esta opción toma un argumento que se pasará al compilador para los archivos de origen C++ que se compilan en la configuración de ejecución. Esto es similar a la opción --cxxopt, pero solo se aplica a la configuración de exec.

--host_linkopt=linker-option

Esta opción toma un argumento que se pasará al vinculador para los archivos fuente que se compilan en la configuración de exec. Esto es similar a la opción --linkopt, pero solo se aplica a la configuración de exec.

--conlyopt=cc-option

Esta opción toma un argumento que se pasará al compilador cuando se compilen archivos de origen C.

Esto es similar a --copt, pero solo se aplica a la compilación de C, no a la compilación o vinculación de C++. Por lo tanto, puedes pasar opciones específicas de C (como -Wno-pointer-sign) con --conlyopt.

--cxxopt=cc-option

Esta opción toma un argumento que se pasará al compilador cuando se compilen archivos de origen C++.

Esto es similar a --copt, pero solo se aplica a la compilación de C++, no a la compilación o vinculación de C. Por lo tanto, puedes pasar opciones específicas de C++ (como -fpermissive o -fno-implicit-templates) con --cxxopt.

Por ejemplo:

  % bazel build --cxxopt="-fpermissive" --cxxopt="-Wno-error" //foo/cruddy_code

--linkopt=linker-option

Esta opción toma un argumento que se pasará al compilador cuando se realice la vinculación.

Esto es similar a --copt, pero solo se aplica a la vinculación, no a la compilación. Por lo tanto, puedes pasar opciones del compilador que solo tienen sentido durante el tiempo de vinculación (como -lssp o -Wl,--wrap,abort) con --linkopt. Por ejemplo:

  % bazel build --copt="-fmudflap" --linkopt="-lmudflap" //foo/buggy_code

Las reglas de compilación también pueden especificar opciones de vinculación en sus atributos. La configuración de esta opción siempre tiene prioridad. Consulta también cc_library.linkopts.

--strip (always|never|sometimes)

Esta opción determina si Bazel quitará la información de depuración de todos los objetos binarios y las bibliotecas compartidas invocando al vinculador con la opción -Wl,--strip-debug. --strip=always significa quitar siempre la información de depuración. --strip=never significa que nunca se debe quitar la información de depuración. El valor predeterminado de --strip=sometimes significa quitar si --compilation_mode es fastbuild.

  % bazel build --strip=always //foo:bar

compilará el destino mientras quita la información de depuración de todos los objetos binarios generados.

La opción --strip de Bazel corresponde a la opción --strip-debug de ld: solo quita la información de depuración. Si por algún motivo quieres quitar todos los símbolos, no solo los símbolos de depuración, deberás usar la opción --strip-all de ld, que puedes hacer pasando --linkopt=-Wl,--strip-all a Bazel. Además, ten en cuenta que configurar la marca --strip de Bazel anulará --linkopt=-Wl,--strip-all, por lo que solo debes configurar una de las dos.

Si solo compilas un objeto binario y quieres quitar todos los símbolos, también puedes pasar --stripopt=--strip-all y compilar de forma explícita la versión //foo:bar.stripped del destino. Como se describe en la sección sobre --stripopt, esto aplica una acción de eliminación después de que se vincula el objeto binario final, en lugar de incluir la eliminación en todas las acciones de vinculación de la compilación.

--stripopt=strip-option

Esta es una opción adicional para pasar al comando strip cuando se genera un objeto binario *.stripped. El valor predeterminado es -S -p. Esta opción se puede usar varias veces.

--fdo_instrument=profile-output-dir

La opción --fdo_instrument habilita la generación de resultados de perfiles de FDO (optimización dirigida por comentarios) cuando se ejecuta el binario C/C++ compilado. En GCC, el argumento proporcionado se usa como un prefijo de directorio para un árbol de directorios de archivos .gcda por objeto que contiene información de perfil para cada archivo .o.

Una vez que se haya generado el árbol de datos de perfil, este se debe comprimir y proporcionar a la opción Bazel --fdo_optimize=profile-zip para habilitar la compilación optimizada por FDO.

Para el compilador LLVM, el argumento también es el directorio en el que se vuelcan los archivos de datos de perfil sin procesar de LLVM. Por ejemplo: --fdo_instrument=/path/to/rawprof/dir/

Las opciones --fdo_instrument y --fdo_optimize no se pueden usar al mismo tiempo.

--fdo_optimize=profile-zip

La opción --fdo_optimize habilita el uso de la información de perfil de archivo por objeto para realizar optimizaciones de FDO (optimización dirigida por comentarios) durante la compilación. Para GCC, el argumento proporcionado es el archivo ZIP que contiene el árbol de archivos generado anteriormente de archivos .gcda que contienen información de perfil para cada archivo .o.

Como alternativa, el argumento proporcionado puede apuntar a un perfil automático que identifica la extensión .afdo.

Para el compilador LLVM, el argumento proporcionado debe apuntar al archivo de salida de perfil de LLVM indexado que prepara la herramienta llvm-profdata y debe tener la extensión .profdata.

Las opciones --fdo_instrument y --fdo_optimize no se pueden usar al mismo tiempo.

--java_language_version=version

Esta opción especifica la versión de las fuentes de Java. Por ejemplo:

  % bazel build --java_language_version=8 java/com/example/common/foo:all

compila y permite solo construcciones compatibles con la especificación de Java 8. El valor predeterminado es 11. --> Los valores posibles son 8, 9, 10, 11, 17 y 21, y se pueden extender registrando cadenas de herramientas de Java personalizadas con default_java_toolchain.

--tool_java_language_version=version

Es la versión del lenguaje Java que se usa para compilar herramientas que se ejecutan durante una compilación. El valor predeterminado es 11.

--java_runtime_version=version

Esta opción especifica la versión de JVM que se usará para ejecutar el código y las pruebas. Por ejemplo:

  % bazel run --java_runtime_version=remotejdk_11 java/com/example/common/foo:java_application

descarga JDK 11 desde un repositorio remoto y ejecuta la aplicación de Java con él.

El valor predeterminado es local_jdk. Los valores posibles son local_jdk, local_jdk_version, remotejdk_11, remotejdk_17 y remotejdk_21. Para extender los valores, registra una JVM personalizada con las reglas del repositorio local_java_repository o remote_java_repository.

--tool_java_runtime_version=version

Es la versión de JVM que se usa para ejecutar las herramientas necesarias durante una compilación. El valor predeterminado es remotejdk_11.

--jvmopt=jvm-option

Esta opción permite que se pasen argumentos de opción a la VM de Java. Se puede usar con un argumento grande o varias veces con argumentos individuales. Por ejemplo:

  % bazel build --jvmopt="-server -Xms256m" java/com/example/common/foo:all

usará la VM del servidor para iniciar todos los objetos binarios de Java y establecer el tamaño del montón de inicio de la VM en 256 MB.

--javacopt=javac-option

Esta opción permite pasar argumentos de opción a javac. Se puede usar con un argumento grande o varias veces con argumentos individuales. Por ejemplo:

  % bazel build --javacopt="-g:source,lines" //myprojects:prog

Volverá a compilar un java_binary con la información de depuración predeterminada de javac (en lugar de la predeterminada de bazel).

La opción se pasa a javac después de las opciones predeterminadas integradas de Bazel para javac y antes de las opciones por regla. La última especificación de cualquier opción para javac gana. Las opciones predeterminadas para javac son las siguientes:

  -source 8 -target 8 -encoding UTF-8

--strict_java_deps (default|strict|off|warn|error)

Esta opción controla si javac verifica si faltan dependencias directas. Los destinos de Java deben declarar de forma explícita todos los destinos que se usan directamente como dependencias. Esta marca le indica a javac que determine los archivos JAR que se usan realmente para la verificación de tipos de cada archivo Java y que emita una advertencia o un error si no son el resultado de una dependencia directa del destino actual.

• off significa que la verificación está inhabilitada.
• warn significa que javac generará advertencias de Java estándar del tipo [strict] para cada dependencia directa faltante.
• default, strict y error significan que javac generará errores en lugar de advertencias, lo que hará que no se compile el destino actual si se encuentran dependencias directas faltantes. Este también es el comportamiento predeterminado cuando no se especifica la marca.

Semántica de compilación

Estas opciones afectan los comandos de compilación o el contenido del archivo de salida.

--compilation_mode (fastbuild|opt|dbg) (-c)

La opción --compilation_mode (a menudo abreviada como -c, especialmente -c opt) toma un argumento de fastbuild, dbg o opt, y afecta a varias opciones de generación de código de C/C++, como el nivel de optimización y la finalización de las tablas de depuración. Bazel usa un directorio de salida diferente para cada modo de compilación, por lo que puedes cambiar de modo sin tener que volver a compilar cada vez.

• fastbuild significa compilar lo más rápido posible: genera información de depuración mínima (-gmlt -Wl,-S) y no la optimiza. Es el valor predeterminado. Nota: -DNDEBUG no se establecerá.
• dbg significa compilación con depuración habilitada (-g), para que puedas usar gdb (o cualquier otro depurador).
• opt significa compilar con la optimización habilitada y con las llamadas a assert() inhabilitadas (-O2 -DNDEBUG). No se generará información de depuración en el modo opt, a menos que también pases --copt -g.

--cpu=cpu

Esta opción especifica la arquitectura de CPU objetivo que se usará para la compilación de objetos binarios durante la compilación.

--action_env=VAR=VALUE

Especifica el conjunto de variables de entorno disponibles durante la ejecución de todas las acciones. Las variables se pueden especificar por nombre, en cuyo caso el valor se tomará del entorno de invocación, o por el par name=value, que establece el valor independientemente del entorno de invocación.

Esta marca --action_env se puede especificar varias veces. Si se asigna un valor a la misma variable en varias marcas --action_env, la asignación más reciente prevalece.

--experimental_action_listener=label

La opción experimental_action_listener le indica a Bazel que use detalles de la regla action_listener especificada por label para insertar extra_actions en el gráfico de compilación.

--[no]experimental_extra_action_top_level_only

Si esta opción se establece como verdadera, las acciones adicionales especificadas por la opción de línea de comandos --experimental_action_listener solo se programarán para los objetivos de nivel superior.

--experimental_extra_action_filter=regex

La opción experimental_extra_action_filter le indica a Bazel que filtre el conjunto de destinos para programar extra_actions.

Esta marca solo se aplica en combinación con la marca --experimental_action_listener.

De forma predeterminada, todos los extra_actions en el cierre transitivo de los objetivos de compilación solicitados se programan para su ejecución. --experimental_extra_action_filter restringirá la programación a extra_actions, cuya etiqueta del propietario coincida con la expresión regular especificada.

En el siguiente ejemplo, se limitará la programación de extra_actions para que solo se aplique a las acciones cuya etiqueta del propietario contenga "/bar/":

% bazel build --experimental_action_listener=//test:al //foo/... \
  --experimental_extra_action_filter=.*/bar/.*

--host_cpu=cpu

Esta opción especifica el nombre de la arquitectura de la CPU que se debe usar para compilar herramientas de host.

--android_platforms=platform[,platform]*

Son las plataformas para compilar el deps transitivo de las reglas android_binary (específicamente para dependencias nativas como C++). Por ejemplo, si aparece un cc_library en el deps transitivo de una regla android_binary, se compila una vez para cada plataforma especificada con --android_platforms para la regla android_binary y se incluye en el resultado final.

No hay un valor predeterminado para esta marca: se debe definir y usar una plataforma de Android personalizada.

Se crea un archivo .so y se empaqueta en el APK para cada plataforma especificada con --android_platforms. El nombre del archivo .so antepone el nombre de la regla android_binary con "lib". Por ejemplo, si el nombre de android_binary es "foo", el archivo es libfoo.so.

--per_file_copt=[+-]regex[,[+-]regex]...@option[,option]...

Cuando esté presente, se compilará con las opciones proporcionadas cualquier archivo C++ con una etiqueta o una ruta de ejecución que coincida con una de las expresiones de regex de inclusión y que no coincida con ninguna de las expresiones de exclusión. La coincidencia de etiquetas usa la forma canónica de la etiqueta (es decir, //package:label_name).

La ruta de ejecución es la ruta de acceso relativa al directorio de tu espacio de trabajo, incluido el nombre básico (incluida la extensión) del archivo C++. También incluye cualquier prefijo dependiente de la plataforma.

Para que coincidan con los archivos generados (como los resultados de genrule), Bazel solo puede usar la ruta de ejecución. En este caso, la regex no debe comenzar con '//', ya que no coincide con ninguna ruta de ejecución. Los nombres de los paquetes se pueden usar de la siguiente manera: --per_file_copt=base/.*\.pb\.cc@-g0. Esto coincidirá con todos los archivos .pb.cc en un directorio llamado base.

Esta opción se puede usar varias veces.

La opción se aplica independientemente del modo de compilación que se use. Por ejemplo, es posible compilar con --compilation_mode=opt y compilar de forma selectiva algunos archivos con la optimización más potente activada o inhabilitada.

Precaución: Si algunos archivos se compilan de forma selectiva con símbolos de depuración, es posible que se quiten durante la vinculación. Para evitar esto, configura --strip=never.

Sintaxis: [+-]regex[,[+-]regex]...@option[,option]..., en la que regex representa una expresión regular que puede tener el prefijo + para identificar patrones de inclusión y - para identificar patrones de exclusión. option significa una opción arbitraria que se pasa al compilador de C++. Si una opción contiene un ,, debe ir entre comillas de la siguiente manera: \,. Las opciones también pueden contener @, ya que solo se usa el primer @ para separar las expresiones regulares de las opciones.

Ejemplo: --per_file_copt=//foo:.*\.cc,-//foo:file\.cc@-O0,-fprofile-arcs agrega las opciones -O0 y -fprofile-arcs a la línea de comandos del compilador de C++ para todos los archivos .cc en //foo/, excepto file.cc.

--dynamic_mode=mode

Determina si los objetos binarios de C++ se vincularán de forma dinámica, interactuando con el atributo linkstatic en las reglas de compilación.

Modos:

• default: Permite que Bazel elija si vincular de forma dinámica. Consulta linkstatic para obtener más información.
• fully: Vincula todos los destinos de forma dinámica. Esto acelerará el tiempo de vinculación y reducirá el tamaño de los objetos binarios resultantes.
• off: Vincula todos los destinos en el modo mayoritariamente estático. Si se establece -static en linkopts, los destinos cambiarán a completamente estáticos.

--fission (yes|no|[dbg][,opt][,fastbuild])

Habilita Fission, que escribe información de depuración de C++ en archivos .dwo dedicados en lugar de archivos .o, donde iría de otra manera. Esto reduce significativamente el tamaño de entrada a los vínculos y puede reducir los tiempos de vinculación.

Cuando se establece en [dbg][,opt][,fastbuild] (por ejemplo, --fission=dbg,fastbuild), Fission se habilita solo para el conjunto especificado de modos de compilación. Esto es útil para la configuración de bazelrc. Cuando se establece en yes, Fission se habilita de forma universal. Cuando se establece en no, Fission se inhabilita de forma universal. La cantidad predeterminada es no.

--force_ignore_dash_static

Si se establece esta marca, se ignoran las opciones -static en linkopts de los archivos BUILD de reglas cc_*. Esto solo se diseñó como una solución alternativa para las compilaciones de endurecimiento de C++.

--[no]force_pic

Si está habilitada, todas las compilaciones de C++ producen código independiente de la posición ("-fPIC"), las vinculaciones prefieren las bibliotecas compiladas previamente de PIC en lugar de las bibliotecas no PIC, y las vinculaciones producen ejecutables independientes de la posición ("-pie"). La opción predeterminada está inhabilitada.

--android_resource_shrinking

Selecciona si se debe realizar la reducción de recursos para las reglas android_binary. Establece el valor predeterminado del atributo shrink_resources en las reglas android_binary. Consulta la documentación de esa regla para obtener más detalles. La configuración predeterminada es desactivada.

--custom_malloc=malloc-library-target

Cuando se especifique, usa siempre la implementación de malloc determinada, anula todos los atributos malloc="target", incluidos aquellos objetivos que usan el valor predeterminado (sin especificar ningún malloc).

--crosstool_top=label

Esta opción especifica la ubicación del paquete de compiladores de herramientas cruzadas que se usará para toda la compilación de C++ durante una compilación. Bazel buscará en esa ubicación un archivo CROSSTOOL y lo usará para determinar automáticamente la configuración de --compiler.

--host_crosstool_top=label

Si no se especifica, Bazel usa el valor de --crosstool_top para compilar código en la configuración de ejecución, como las herramientas que se ejecutan durante la compilación. El objetivo principal de esta marca es habilitar la compilación cruzada.

--apple_crosstool_top=label

Es el compilador cruzado que se usará para compilar reglas de C/C++ en el deps transitivo de las reglas objc*, ios* y apple*. Para esos destinos, esta marca reemplaza a --crosstool_top.

--compiler=version

Esta opción especifica la versión del compilador C/C++ (como gcc-4.1.0) que se usará para la compilación de objetos binarios durante la compilación. Si deseas compilar con un compilador cruzado personalizado, debes usar un archivo CROSSTOOL en lugar de especificar esta marca.

--android_sdk=label

Obsoleta. Esto no se debe especificar directamente.

Esta opción especifica la cadena de herramientas del SDK o la plataforma de Android y la biblioteca del entorno de ejecución de Android que se usarán para compilar cualquier regla relacionada con Android.

El SDK de Android se seleccionará automáticamente si se define una regla android_sdk_repository en el archivo WORKSPACE.

--java_toolchain=label

No realiza ninguna acción. Se conserva solo para la retrocompatibilidad.

--host_java_toolchain=label

No realiza ninguna acción. Se conserva solo para la retrocompatibilidad.

--javabase=(label)

No realiza ninguna acción. Se conserva solo para la retrocompatibilidad.

--host_javabase=label

No realiza ninguna acción. Se conserva solo para la retrocompatibilidad.

Estrategia de ejecución

Estas opciones afectan la forma en que Bazel ejecutará la compilación. No deberían tener ningún efecto significativo en los archivos de salida que genera la compilación. Por lo general, su efecto principal es en la velocidad de la compilación.

--spawn_strategy=strategy

Esta opción controla dónde y cómo se ejecutan los comandos.

• standalone hace que los comandos se ejecuten como subprocesos locales. Este valor dejó de estar disponible. En su lugar, utiliza local.
• sandboxed hace que los comandos se ejecuten dentro de una zona de pruebas en la máquina local. Esto requiere que todos los archivos de entrada, las dependencias de datos y las herramientas se enumeren como dependencias directas en los atributos srcs, data y tools. Bazel habilita la zona de pruebas local de forma predeterminada en los sistemas que admiten la ejecución en zona de pruebas.
• local hace que los comandos se ejecuten como subprocesos locales.
• worker hace que los comandos se ejecuten con un trabajador persistente, si está disponible.
• docker hace que los comandos se ejecuten dentro de una zona de pruebas de Docker en la máquina local. Esto requiere que Docker esté instalado.
• remote hace que los comandos se ejecuten de forma remota. Esta opción solo está disponible si se configuró un ejecutor remoto por separado.

--strategy mnemonic=strategy

Esta opción controla dónde y cómo se ejecutan los comandos, anula --spawn_strategy (y --genrule_strategy con Genrule mnemónico) de forma individual. Consulta --spawn_strategy para conocer las estrategias compatibles y sus efectos.

--strategy_regexp=<filter,filter,...>=<strategy>

Esta opción especifica qué estrategia se debe usar para ejecutar comandos que tengan descripciones que coincidan con un regex_filter determinado. Consulta --per_file_copt para obtener detalles sobre la coincidencia de regex_filter. Consulta --spawn_strategy para conocer las estrategias compatibles y sus efectos.

Se usa el último regex_filter que coincide con la descripción. Esta opción anula otras marcas para especificar la estrategia.

• Ejemplo: --strategy_regexp=//foo.*\\.cc,-//foo/bar=local significa ejecutar acciones con la estrategia local si sus descripciones coinciden con //foo.*.cc, pero no con //foo/bar.
• Ejemplo: --strategy_regexp='Compiling.*/bar=local' --strategy_regexp=Compiling=sandboxed ejecuta "Compiling //foo/bar/baz" con la estrategia sandboxed, pero invertir el orden lo ejecuta con local.
• Ejemplo: --strategy_regexp='Compiling.*/bar=local,sandboxed' ejecuta "Compiling //foo/bar/baz" con la estrategia local y recurre a sandboxed si falla.

--genrule_strategy=strategy

Esta es una abreviatura obsoleta de --strategy=Genrule=strategy.

--jobs=n (-j)

Esta opción, que toma un argumento de número entero, especifica un límite para la cantidad de trabajos que se deben ejecutar de forma simultánea durante la fase de ejecución de la compilación.

--progress_report_interval=n

Bazel imprime periódicamente un informe de progreso sobre los trabajos que aún no están terminados (como las pruebas de larga duración). Esta opción establece la frecuencia de los informes. El progreso se imprimirá cada n segundos.

El valor predeterminado es 0, lo que significa un algoritmo incremental: el primer informe se imprimirá después de 10 segundos, luego de 30 segundos y, después, el progreso se informará una vez por minuto.

Cuando bazel usa el control del cursor, como se especifica en --curses, el progreso se informa cada segundo.

--local_{ram,cpu}_resources resources or resource expression

Estas opciones especifican la cantidad de recursos locales (RAM en MB y cantidad de núcleos lógicos de CPU) que Bazel puede tener en cuenta cuando programa actividades de compilación y prueba para que se ejecuten de forma local. Toman un número entero o una palabra clave (HOST_RAM o HOST_CPUS), opcionalmente seguida de [-|*flotante] (por ejemplo, --local_cpu_resources=2, --local_ram_resources=HOST_RAM*.5, --local_cpu_resources=HOST_CPUS-1). Las marcas son independientes; se puede establecer una o ambas. De forma predeterminada, Bazel estima la cantidad de RAM y la cantidad de núcleos de CPU directamente desde la configuración del sistema local.

--[no]build_runfile_links

Esta opción, que está habilitada de forma predeterminada, especifica si los symlinks de runfiles para pruebas y objetos binarios se deben compilar en el directorio de salida. El uso de --nobuild_runfile_links puede ser útil para validar si todos los destinos se compilan sin incurrir en la sobrecarga para compilar los árboles de runfiles.

Cuando se ejecutan pruebas (o aplicaciones), sus dependencias de datos de tiempo de ejecución se reúnen en un solo lugar. Dentro del árbol de salida de Bazel, este árbol de "runfiles" suele tener la raíz como un hermano de la prueba o el objeto binario correspondiente. Durante la ejecución de pruebas, se puede acceder a los archivos de ejecución con rutas de acceso del tipo $TEST_SRCDIR/canonical_repo_name/packagename/filename. El árbol de runfiles garantiza que las pruebas tengan acceso a todos los archivos sobre los que tienen una dependencia declarada y nada más. De forma predeterminada, el árbol de runfiles se implementa mediante la construcción de un conjunto de vínculos simbólicos a los archivos necesarios. A medida que crece el conjunto de vínculos, también lo hace el costo de esta operación y, en el caso de algunas compilaciones grandes, puede contribuir de manera significativa al tiempo de compilación general, en particular porque cada prueba individual (o aplicación) requiere su propio árbol de archivos de ejecución.

--[no]build_runfile_manifests

Esta opción, que está habilitada de forma predeterminada, especifica si los manifiestos de runfiles se deben escribir en el árbol de salida. Inhabilitarlo implica --nobuild_runfile_links.

Se puede inhabilitar cuando se ejecutan pruebas de forma remota, ya que los árboles de runfiles se crearán de forma remota a partir de manifiestos en memoria.

--[no]discard_analysis_cache

Cuando esta opción está habilitada, Bazel descartará la caché de análisis justo antes de que comience la ejecución, lo que liberará memoria adicional (alrededor del 10%) para la fase de ejecución. La desventaja es que las compilaciones incrementales posteriores serán más lentas. Consulta también el modo de ahorro de memoria.

--[no]keep_going (-k)

Al igual que en GNU Make, la fase de ejecución de una compilación se detiene cuando se encuentra el primer error. A veces, es útil intentar compilar todo lo posible, incluso ante errores. Esta opción habilita ese comportamiento y, cuando se especifica, la compilación intentará compilar todos los destinos cuyos requisitos previos se compilaron correctamente, pero ignorará los errores.

Si bien esta opción suele asociarse con la fase de ejecución de una compilación, también afecta la fase de análisis: si se especifican varios destinos en un comando de compilación, pero solo algunos de ellos se pueden analizar correctamente, la compilación se detendrá con un error, a menos que se especifique --keep_going, en cuyo caso la compilación continuará con la fase de ejecución, pero solo para los destinos que se analizaron correctamente.

--[no]use_ijars

Esta opción cambia la forma en que Bazel compila los destinos de java_library. En lugar de usar el resultado de un java_library para compilar destinos java_library dependientes, Bazel creará archivos JAR de interfaz que contengan solo las firmas de miembros no privados (métodos y campos de acceso públicos, protegidos y predeterminados (paquete)) y usará los archivos JAR de interfaz para compilar los destinos dependientes. Esto permite evitar la compilación nuevamente cuando solo se realizan cambios en los cuerpos de métodos o en los miembros privados de una clase.

--[no]interface_shared_objects

Esta opción habilita los objetos compartidos de interfaz, lo que hace que los objetos binarios y otras bibliotecas compartidas dependan de la interfaz de un objeto compartido, en lugar de su implementación. Cuando solo cambia la implementación, Bazel puede evitar volver a compilar objetivos que dependen de la biblioteca compartida modificada de forma innecesaria.

Selección de salida

Estas opciones determinan qué se compilará o probará.

--[no]build

Esta opción hace que se produzca la fase de ejecución de la compilación. Está activada de forma predeterminada. Cuando se desactiva, seomite la fase de ejecución y solo se producen las dos primeras fases, carga y análisis.

Esta opción puede ser útil para validar archivos BUILD y detectar errores en las entradas, sin compilar nada.

--[no]build_tests_only

Si se especifica, Bazel compilará solo lo necesario para ejecutar las reglas *_test y test_suite que no se filtraron debido a su tamaño, tiempo de espera, etiqueta o lenguaje. Si se especifica, Bazel ignorará otros destinos especificados en la línea de comandos. De forma predeterminada, esta opción está inhabilitada y Bazel compilará todo lo solicitado, incluidas las reglas *_test y test_suite que se filtran de las pruebas. Esto es útil porque ejecutar bazel test --build_tests_only foo/... puede no detectar todas las fallas de compilación en el árbol foo.

--[no]check_up_to_date

Esta opción hace que Bazel no realice una compilación, sino que solo verifique si todos los destinos especificados están actualizados. Si es así, la compilación se completa correctamente, como de costumbre. Sin embargo, si alguno de los archivos está desactualizado, en lugar de compilarse, se informa un error y la compilación falla. Esta opción puede ser útil para determinar si se realizó una compilación más recientemente que una edición de fuente (por ejemplo, para verificaciones previas al envío) sin incurrir en el costo de una compilación.

Consulta también --check_tests_up_to_date.

--[no]compile_one_dependency

Compila una sola dependencia de los archivos de argumentos. Esto es útil para verificar la sintaxis de los archivos fuente en IDEs, por ejemplo, cuando se vuelve a compilar un solo destino que depende del archivo fuente para detectar errores lo antes posible en el ciclo de edición, compilación y prueba. Este argumento afecta la forma en que se interpretan todos los argumentos que no son de marca: cada argumento debe ser una etiqueta de destino de archivo o un nombre de archivo simple en relación con el directorio de trabajo actual, y se compila una regla que depende de cada nombre de archivo de origen. Para las fuentes de C++ y Java, se eligen de preferencia las reglas en el mismo espacio de lenguaje. Para varias reglas con la misma preferencia, se elige la que aparece primero en el archivo BUILD. Un patrón de destino con un nombre explícito que no hace referencia a un archivo fuente genera un error.

--save_temps

La opción --save_temps hace que se guarden los resultados temporales del compilador. Estos incluyen archivos .s (código del ensamblador), .i (C preprocesado) y .ii (C++ preprocesado). Estos resultados suelen ser útiles para la depuración. Los archivos temporales solo se generarán para el conjunto de destinos especificados en la línea de comandos.

Actualmente, la marca --save_temps solo funciona para las reglas cc_*

Para asegurarte de que Bazel imprima la ubicación de los archivos de salida adicionales, verifica que la configuración de --show_result n sea lo suficientemente alta.

--build_tag_filters=tag[,tag]*

Si se especifica, Bazel solo compilará los destinos que tengan al menos una etiqueta obligatoria (si se especifica alguna) y que no tengan etiquetas excluidas. El filtro de etiquetas de compilación se especifica como una lista de palabras clave de etiquetas separadas por comas, opcionalmente, precedida del signo "-" que se usa para indicar las etiquetas excluidas. Las etiquetas obligatorias también pueden tener un signo "+" anterior.

Cuando se ejecutan pruebas, Bazel ignora --build_tag_filters para los destinos de prueba, que se compilan y ejecutan incluso si no coinciden con este filtro. Para evitar compilarlos, filtra los objetivos de prueba con --test_tag_filters o excluyéndolos de forma explícita.

--test_size_filters=size[,size]*

Si se especifica, Bazel probará (o compilará si también se especifica --build_tests_only) solo los destinos de prueba con el tamaño determinado. El filtro de tamaño de prueba se especifica como una lista delimitada por comas de valores de tamaño de prueba permitidos (pequeño, mediano, grande o enorme), opcionalmente precedido por el signo “-” que se usa para indicar los tamaños de prueba excluidos. Por ejemplo:

  % bazel test --test_size_filters=small,medium //foo:all

y

  % bazel test --test_size_filters=-large,-enormous //foo:all

solo probará pruebas pequeñas y medianas dentro de //foo.

De forma predeterminada, no se aplica el filtrado de tamaño de prueba.

--test_timeout_filters=timeout[,timeout]*

Si se especifica, Bazel probará (o compilará si también se especifica --build_tests_only) solo los destinos de prueba con el tiempo de espera determinado. El filtro de tiempo de espera de la prueba se especifica como una lista separada por comas de valores de tiempo de espera de prueba permitidos (corto, moderado, largo o eterno), opcionalmente, precedido por el signo "-" que se usa para indicar los tiempos de espera de prueba excluidos. Consulta --test_size_filters para ver un ejemplo de sintaxis.

De forma predeterminada, no se aplica el filtrado de tiempo de espera de la prueba.

--test_tag_filters=tag[,tag]*

Si se especifica, Bazel probará (o compilará si también se especifica --build_tests_only) solo los destinos de prueba que tengan al menos una etiqueta obligatoria (si se especifica alguna de ellas) y no tengan etiquetas excluidas. El filtro de etiquetas de prueba se especifica como una lista de palabras clave de etiquetas separadas por comas, opcionalmente, precedida del signo "-" que se usa para indicar las etiquetas excluidas. Las etiquetas obligatorias también pueden tener un signo "+" anterior.

Por ejemplo:

  % bazel test --test_tag_filters=performance,stress,-flaky //myproject:all

probará los destinos etiquetados con la etiqueta performance o stress, pero que no están etiquetados con la etiqueta flaky.

De forma predeterminada, no se aplica el filtrado de etiquetas de prueba. Ten en cuenta que también puedes filtrar las pruebas de las etiquetas size y local de esta manera.

--test_lang_filters=string[,string]*

Especifica una lista de cadenas separadas por comas que hacen referencia a nombres de clases de reglas de prueba. Para hacer referencia a la clase de regla foo_test, usa la cadena "foo". Bazel probará (o compilará, si también se especifica --build_tests_only) solo los destinos de las clases de reglas a las que se hace referencia. Para excluir esos destinos, usa la cadena "-foo". Por ejemplo:

  % bazel test --test_lang_filters=foo,bar //baz/...

solo probará los objetivos que sean instancias de foo_test o bar_test en //baz/..., mientras que

  % bazel test --test_lang_filters=-foo,-bar //baz/...

probará todos los destinos en //baz/..., excepto las instancias de foo_test y bar_test.

--test_filter=filter-expression

Especifica un filtro que el ejecutor de pruebas puede usar para elegir un subconjunto de pruebas para ejecutar. Se compilan todos los destinos especificados en la invocación, pero, según la expresión, solo se pueden ejecutar algunos. En algunos casos, solo se ejecutan ciertos métodos de prueba.

La interpretación particular de filter-expression depende del framework de pruebas responsable de ejecutar la prueba. Puede ser un glob, una subcadena o una regex. --test_filter es una comodidad para pasar diferentes argumentos de filtro --test_arg, pero no todos los frameworks lo admiten.

Verbosidad

Estas opciones controlan la verbosidad del resultado de Bazel, ya sea en la terminal o en archivos de registro adicionales.

--explain=logfile

Esta opción, que requiere un argumento de nombre de archivo, hace que el verificador de dependencias en la fase de ejecución de bazel build explique, para cada paso de compilación, por qué se está ejecutando o que está actualizado. La explicación se escribe en logfile.

Si encuentras recompilaciones inesperadas, esta opción puede ayudarte a comprender el motivo. Agrega la opción a tu .bazelrc para que se realice el registro en todas las compilaciones posteriores y, luego, inspecciona el registro cuando veas que se ejecuta un paso de ejecución de forma inesperada. Esta opción puede generar una pequeña penalización de rendimiento, por lo que te recomendamos que la quites cuando ya no sea necesaria.

--verbose_explanations

Esta opción aumenta la verbosidad de las explicaciones generadas cuando se habilita la opción --explain.

En particular, si se habilitan las explicaciones detalladas y se vuelve a compilar un archivo de salida porque cambió el comando que se usó para compilarlo, el resultado en el archivo de explicación incluirá los detalles completos del comando nuevo (al menos para la mayoría de los comandos).

El uso de esta opción puede aumentar significativamente la longitud del archivo de explicación generado y la penalización de rendimiento de usar --explain.

Si --explain no está habilitado, --verbose_explanations no tiene ningún efecto.

--profile=file

Esta opción, que toma un argumento de nombre de archivo, hace que Bazel escriba datos de generación de perfiles en un archivo. Luego, los datos se pueden analizar o analizar con el comando bazel analyze-profile. El perfil de compilación puede ser útil para comprender dónde está invirtiendo su tiempo el comando build de Bazel.

--[no]show_loading_progress

Esta opción hace que Bazel genere mensajes de progreso de carga de paquetes. Si está inhabilitada, no se mostrarán los mensajes.

--[no]show_progress

Esta opción hace que se muestren mensajes de progreso. Está activada de forma predeterminada. Cuando se inhabilita, se suprimen los mensajes de progreso.

--show_progress_rate_limit=n

Esta opción hace que bazel muestre, como máximo, un mensaje de progreso por n segundos, donde n es un número real. El valor predeterminado para esta opción es 0.02, lo que significa que bazel limitará los mensajes de progreso a uno por cada 0.02 segundos.

--show_result=n

Esta opción controla la impresión de la información de los resultados al final de un comando bazel build. De forma predeterminada, si se especificó un solo objetivo de compilación, Bazel imprime un mensaje que indica si el objetivo se actualizó correctamente y, de ser así, la lista de archivos de salida que creó el objetivo. Si se especificaron varios objetivos, no se mostrará la información de los resultados.

Si bien la información de los resultados puede ser útil para compilaciones de un solo objetivo o de algunos, en el caso de compilaciones grandes (como un árbol de proyecto de nivel superior completo), esta información puede ser abrumadora y distraer. Esta opción permite controlarla. --show_result toma un argumento de número entero, que es la cantidad máxima de objetivos para los que se debe imprimir la información de resultados completa. De forma predeterminada, el valor es 1. Por encima de este umbral, no se muestra información de resultados para los objetivos individuales. Por lo tanto, cero hace que la información del resultado siempre se suprima, y un valor muy grande hace que el resultado siempre se imprima.

Es posible que los usuarios deseen elegir un valor intermedio si alternan con frecuencia entre la compilación de un grupo pequeño de destinos (por ejemplo, durante el ciclo de compilación, edición y prueba) y un grupo grande de destinos (por ejemplo, cuando se establece un espacio de trabajo nuevo o se ejecutan pruebas de regresión). En el primer caso, la información del resultado es muy útil, mientras que en el segundo caso es menos útil. Al igual que con todas las opciones, esto se puede especificar de forma implícita a través del archivo .bazelrc.

Los archivos se imprimen para facilitar la copia y el pegado del nombre del archivo en la shell, de modo que se ejecuten los ejecutables compilados. Las secuencias de comandos que generan una compilación pueden analizar fácilmente los mensajes "actualizados" o "con errores" de cada destino.

--sandbox_debug

Esta opción hace que Bazel imprima información de depuración adicional cuando se usa la zona de pruebas para la ejecución de acciones. Esta opción también conserva los directorios de zona de pruebas, de modo que se puedan examinar los archivos visibles para las acciones durante la ejecución.

--subcommands (-s)

Esta opción hace que la fase de ejecución de Bazel imprima la línea de comandos completa para cada comando antes de ejecutarlo.

  >>>>> # //examples/cpp:hello-world [action 'Linking examples/cpp/hello-world']
  (cd /home/johndoe/.cache/bazel/_bazel_johndoe/4c084335afceb392cfbe7c31afee3a9f/bazel && \
    exec env - \
    /usr/bin/gcc -o bazel-out/local-fastbuild/bin/examples/cpp/hello-world -B/usr/bin/ -Wl,-z,relro,-z,now -no-canonical-prefixes -pass-exit-codes -Wl,-S -Wl,@bazel-out/local_linux-fastbuild/bin/examples/cpp/hello-world-2.params)

Siempre que sea posible, los comandos se imprimen en una sintaxis compatible con la shell de Bourne para que se puedan copiar y pegar fácilmente en un símbolo del sistema de shell. (Los paréntesis que lo rodean se proporcionan para proteger tu shell de las llamadas cd y exec. Asegúrate de copiarlos). Sin embargo, algunos comandos se implementan de forma interna en Bazel, como la creación de árboles de symlink. Para estos, no hay una línea de comandos para mostrar.

Se puede pasar --subcommands=pretty_print para imprimir los argumentos del comando como una lista en lugar de una sola línea. Esto puede ayudar a que las líneas de comandos largas sean más legibles.

Consulta también --verbose_failures a continuación.

Para registrar subcomandos en un archivo en un formato compatible con herramientas, consulta --execution_log_json_file y --execution_log_binary_file.

--verbose_failures

Esta opción hace que la fase de ejecución de Bazel imprima la línea de comandos completa para los comandos que fallaron. Esto puede ser muy útil para depurar una compilación que falla.

Los comandos que fallan se imprimen en una sintaxis compatible con la shell de Bourne, adecuada para copiar y pegar en un mensaje de shell.

Estado de Workspace

Usa estas opciones para “timbrar” los objetos binarios compilados con Bazel: para incorporar información adicional en los objetos binarios, como la revisión del control de código fuente o cualquier otra información relacionada con el lugar de trabajo. Puedes usar este mecanismo con reglas que admitan el atributo stamp, como genrule, cc_binary y mucho más.

--workspace_status_command=program

Esta marca te permite especificar un objeto binario que Bazel ejecuta antes de cada compilación. El programa puede informar información sobre el estado del lugar de trabajo, como la revisión actual del control de código fuente.

El valor de la marca debe ser una ruta de acceso a un programa nativo. En Linux o macOS, puede ser cualquier ejecutable. En Windows, debe ser un archivo binario nativo, por lo general, un archivo ".exe", ".bat" o ".cmd".

El programa debe imprimir cero o más pares clave-valor en el resultado estándar, una entrada en cada línea y, luego, salir con cero (de lo contrario, la compilación fallará). Los nombres de las claves pueden ser cualquier cosa, pero solo pueden usar letras mayúsculas y guiones bajos. El primer espacio después del nombre de la clave lo separa del valor. El valor es el resto de la línea (incluidos los espacios en blanco adicionales). Ni la clave ni el valor pueden abarcar varias líneas. Las claves no deben estar duplicadas.

Bazel particiona las claves en dos buckets: "estable" y "volátil". (Los nombres "estable" y "volátil" son un poco contraintuitivos, así que no te preocupes demasiado por ellos).

Luego, Bazel escribe los pares clave-valor en dos archivos:

• bazel-out/stable-status.txt contiene todas las claves y los valores en los que el nombre de la clave comienza con STABLE_.
• bazel-out/volatile-status.txt contiene el resto de las claves y sus valores.

El contrato es el siguiente:

• Si es posible, los valores de las claves "estables" deben cambiar con poca frecuencia. Si cambia el contenido de bazel-out/stable-status.txt, Bazel invalida las acciones que dependen de él. En otras palabras, si cambia el valor de una clave estable, Bazel volverá a ejecutar las acciones estampadas. Por lo tanto, el estado estable no debe contener elementos como marcas de tiempo, ya que cambian todo el tiempo y harían que Bazel vuelva a ejecutar acciones con marcas con cada compilación.

  Bazel siempre genera las siguientes claves estables:

  • BUILD_EMBED_LABEL: Es el valor de --embed_label.
  • BUILD_HOST: Es el nombre de la máquina host en la que se ejecuta Bazel.
  • BUILD_USER: Es el nombre del usuario con el que se ejecuta Bazel.

• Los valores de las claves "volátiles" pueden cambiar con frecuencia. Bazel espera que cambien todo el tiempo, como lo hacen las marcas de tiempo, y actualiza el archivo bazel-out/volatile-status.txt de forma adecuada. Sin embargo, para evitar que se vuelvan a ejecutar las acciones estampadas todo el tiempo, Bazel finge que el archivo volátil nunca cambia. En otras palabras, si el archivo de estado volátil es el único cuyo contenido cambió, Bazel no invalidará las acciones que dependen de él. Si cambiaron otras entradas de las acciones, Bazel vuelve a ejecutar esa acción, y la acción verá el estado volátil actualizado, pero el cambio solo del estado volátil no invalidará la acción.

  Bazel siempre genera las siguientes claves volátiles:

  • BUILD_TIMESTAMP: Es la hora de la compilación en segundos desde la época de Unix (el valor de System.currentTimeMillis() dividido por mil).
  • FORMATTED_DATE: Es la hora de la compilación con el formato yyyy MMM d HH mm ss EEE(por ejemplo, 2023 Jun 2 01 44 29 Fri) en UTC.

En Linux o macOS, puedes pasar --workspace_status_command=/bin/true para inhabilitar la recuperación del estado del espacio de trabajo, ya que true no hace nada, se cierra correctamente (con cero) y no imprime ningún resultado. En Windows, puedes pasar la ruta de acceso de true.exe de MSYS para obtener el mismo efecto.

Si el comando de estado del espacio de trabajo falla (sale con un valor distinto de cero) por algún motivo, la compilación fallará.

Ejemplo de programa en Linux con Git:

#!/bin/bash
echo "CURRENT_TIME $(date +%s)"
echo "RANDOM_HASH $(cat /proc/sys/kernel/random/uuid)"
echo "STABLE_GIT_COMMIT $(git rev-parse HEAD)"
echo "STABLE_USER_NAME $USER"

Pasa la ruta de acceso de este programa con --workspace_status_command, y el archivo de estado estable incluirá las líneas STABLE, y el archivo de estado volátil incluirá el resto de las líneas.

--[no]stamp

Esta opción, junto con el atributo de regla stamp, controla si se incorpora información de compilación en objetos binarios.

El estampado se puede habilitar o inhabilitar de forma explícita por regla con el atributo stamp. Consulta la Enciclopedia de compilaciones para obtener más información. Cuando una regla establece stamp = -1 (el valor predeterminado para las reglas *_binary), esta opción determina si se habilita el estampado.

Bazel nunca marca los objetos binarios que se compilan para la configuración de ejecución, independientemente de esta opción o del atributo stamp. En el caso de las reglas que establecen stamp = 0 (el valor predeterminado para las reglas *_test), el estampado está inhabilitado independientemente de --[no]stamp. Especificar --stamp no obliga a que se vuelvan a compilar los destinos si sus dependencias no cambiaron.

Por lo general, se recomienda establecer --nostamp para el rendimiento de la compilación, ya que reduce la volatilidad de la entrada y maximiza el almacenamiento en caché de la compilación.

Plataforma

Usa estas opciones para controlar el host y las plataformas de destino que configuran el funcionamiento de las compilaciones y para controlar qué cadenas de herramientas y plataformas de ejecución están disponibles para las reglas de Bazel.

Consulta la información de referencia sobre las plataformas y las cadenas de herramientas.

--platforms=labels

Las etiquetas de las reglas de la plataforma que describen las plataformas de destino para el comando actual

--host_platform=label

Es la etiqueta de una regla de plataforma que describe el sistema host.

--extra_execution_platforms=labels

Son las plataformas disponibles como plataformas de ejecución para ejecutar acciones. Las plataformas se pueden especificar por destino exacto o como un patrón de destino. Estas plataformas se considerarán antes de las declaradas en los archivos MODULE.bazel por register_execution_platforms(). Esta opción acepta una lista de plataformas separadas por comas en orden de prioridad. Si se pasa la marca varias veces, se anula la más reciente.

--extra_toolchains=labels

Son las reglas de la cadena de herramientas que se deben tener en cuenta durante la resolución de la cadena de herramientas. Las cadenas de herramientas se pueden especificar por destino exacto o como un patrón de destino. Estas cadenas de herramientas se considerarán antes de las declaradas en los archivos MODULE.bazel con register_toolchains().

--toolchain_resolution_debug=regex

Imprime información de depuración mientras buscas cadenas de herramientas si el tipo de cadena de herramientas coincide con la regex. Puedes separar varias regex con comas. Para negar la regex, usa un - al principio. Esto podría ayudar a los desarrolladores de reglas de Bazel o Starlark con fallas de depuración debido a cadenas de herramientas faltantes.

Varios

--flag_alias=alias_name=target_path

Es una marca de conveniencia que se usa para vincular una configuración de compilación de Starlark más larga a un nombre más corto. Para obtener más detalles, consulta Configuraciones de Starlark.

--symlink_prefix=string

Cambia el prefijo de los symlinks de conveniencia generados. El valor predeterminado para el prefijo de symlink es bazel-, que creará los symlinks bazel-bin, bazel-testlogs y bazel-genfiles.

Si por algún motivo no se pueden crear los vínculos simbólicos, se emite una advertencia, pero la compilación se considera exitosa. En particular, esto te permite compilar en un directorio de solo lectura o en uno en el que no tienes permiso para escribir. Todas las rutas impresas en los mensajes informativos al final de una compilación solo usarán la forma corta relativa a symlink si los symlinks apuntan a la ubicación esperada. En otras palabras, puedes confiar en la exactitud de esas rutas, incluso si no puedes confiar en que se creen los symlinks.

Estos son algunos valores comunes de esta opción:

• Suprime la creación de symlinks: --symlink_prefix=/ hará que Bazel no cree ni actualice ningún symlink, incluidos los symlinks bazel-out y bazel-<workspace>. Usa esta opción para suprimir por completo la creación de symlinks.

• Reduce la confusión: --symlink_prefix=.bazel/ hará que Bazel cree symlinks llamados bin (etc.) dentro de un directorio oculto .bazel.

--platform_suffix=string

Agrega un sufijo al nombre corto de la configuración, que se usa para determinar el directorio de salida. Si configuras esta opción en diferentes valores, los archivos se colocan en directorios diferentes, por ejemplo, para mejorar las tasas de acierto de la caché de compilaciones que, de otro modo, se superponen entre sí, o para mantener los archivos de salida para las comparaciones.

--default_visibility=(private|public)

Marca temporal para probar los cambios de visibilidad predeterminados de bazel. No está diseñado para uso general, pero se documenta para que sea más completo.

--starlark_cpu_profile=_file_

Esta marca, cuyo valor es el nombre de un archivo, hace que Bazel recopile estadísticas sobre el uso de la CPU por parte de todos los subprocesos de Starlark y escriba el perfil, en formato pprof, en el archivo nombrado.

Usa esta opción para identificar las funciones de Starlark que hacen que la carga y el análisis sean lentos debido a un procesamiento excesivo. Por ejemplo:

$ bazel build --nobuild --starlark_cpu_profile=/tmp/pprof.gz my/project/...
$ pprof /tmp/pprof.gz
(pprof) top
Type: CPU
Time: Feb 6, 2020 at 12:06pm (PST)
Duration: 5.26s, Total samples = 3.34s (63.55%)
Showing nodes accounting for 3.34s, 100% of 3.34s total
      flat  flat%   sum%        cum   cum%
     1.86s 55.69% 55.69%      1.86s 55.69%  sort_source_files
     1.02s 30.54% 86.23%      1.02s 30.54%  expand_all_combinations
     0.44s 13.17% 99.40%      0.44s 13.17%  range
     0.02s   0.6%   100%      3.34s   100%  sorted
         0     0%   100%      1.38s 41.32%  my/project/main/BUILD
         0     0%   100%      1.96s 58.68%  my/project/library.bzl
         0     0%   100%      3.34s   100%  main

Para obtener diferentes vistas de los mismos datos, prueba los comandos pprof svg, web y list.

Usa Bazel para lanzamientos

Los ingenieros de software usan Bazel durante el ciclo de desarrollo y los ingenieros de lanzamientos lo usan cuando preparan objetos binarios para la implementación en producción. En esta sección, se proporciona una lista de sugerencias para los ingenieros de lanzamiento que usan Bazel.

Opciones significativas

Cuando se usa Bazel para compilaciones de lanzamiento, surgen los mismos problemas que con otras secuencias de comandos que realizan una compilación. Para obtener más detalles, consulta Cómo llamar a Bazel desde secuencias de comandos. En particular, se recomiendan las siguientes opciones:

• --bazelrc=/dev/null
• --nokeep_state_after_build

Estas opciones también son importantes:

• --package_path
• --symlink_prefix: Para administrar compilaciones para varias configuraciones, puede ser conveniente distinguir cada compilación con un identificador distinto, como "64 bits" en comparación con "32 bits". Esta opción diferencia los symlinks bazel-bin (etc.).

Cómo ejecutar pruebas

Para compilar y ejecutar pruebas con bazel, escribe bazel test seguido del nombre de los destinos de prueba.

De forma predeterminada, este comando realiza una actividad de compilación y prueba simultánea, compila todos los destinos especificados (incluidos los destinos que no son de prueba especificados en la línea de comandos) y prueba los destinos *_test y test_suite en cuanto se compilan sus requisitos previos, lo que significa que la ejecución de la prueba se intercala con la compilación. Por lo general, esto genera mejoras significativas en la velocidad.

Opciones para bazel test

--cache_test_results=(yes|no|auto) (-t)

Si esta opción se establece en "auto" (la opción predeterminada), Bazel solo volverá a ejecutar una prueba si se aplica alguna de las siguientes condiciones:

• Bazel detecta cambios en la prueba o sus dependencias.
• La prueba se marca como external.
• Se solicitaron varias ejecuciones de prueba con --runs_per_test.
• se produjo un error en la prueba.

Si es "no", todas las pruebas se ejecutarán de forma incondicional.

Si es "sí", el comportamiento de almacenamiento en caché será el mismo que el automático, excepto que puede almacenar en caché las fallas de prueba y las ejecuciones de prueba con --runs_per_test.

Los usuarios que habilitaron esta opción de forma predeterminada en su archivo .bazelrc pueden considerar convenientes las abreviaturas -t (activada) o -t- (desactivada) para anular la configuración predeterminada en una ejecución en particular.

--check_tests_up_to_date

Esta opción le indica a Bazel que no ejecute las pruebas, sino que solo verifique y, luego, informe los resultados de las pruebas almacenados en caché. Si hay pruebas que no se compilaron ni ejecutaron previamente, o cuyos resultados están desactualizados (por ejemplo, porque el código fuente o las opciones de compilación cambiaron), Bazel informará un mensaje de error ("El resultado de la prueba no está actualizado"), registrará el estado de la prueba como "NO STATUS" (en rojo, si la salida de color está habilitada) y mostrará un código de salida distinto de cero.

Esta opción también implica el comportamiento de --check_up_to_date.

Esta opción puede ser útil para las verificaciones previas al envío.

--test_verbose_timeout_warnings

Esta opción le indica a Bazel que le avise explícitamente al usuario si el tiempo de espera de una prueba es considerablemente más largo que el tiempo de ejecución real de la prueba. Si bien el tiempo de espera de una prueba debe establecerse de modo que no sea inestable, una prueba que tiene un tiempo de espera muy generoso puede ocultar problemas reales que surgen de forma inesperada.

Por ejemplo, una prueba que normalmente se ejecuta en uno o dos minutos no debe tener un tiempo de espera de ETERNAL o LONG, ya que son demasiado generosos.

Esta opción es útil para ayudar a los usuarios a decidir un buen valor de tiempo de espera o verificar la validez de los valores de tiempo de espera existentes.

--[no]test_keep_going

De forma predeterminada, todas las pruebas se ejecutan hasta completarse. Sin embargo, si esta marca está inhabilitada, la compilación se aborta en cualquier prueba que no se apruebe. No se ejecutan los pasos de compilación ni las invocaciones de prueba posteriores, y se cancelan las invocaciones en curso. No especifiques --notest_keep_going y --keep_going a la vez.

--flaky_test_attempts=attempts

Esta opción especifica la cantidad máxima de veces que se debe intentar una prueba si falla por algún motivo. Una prueba que falla al principio, pero que finalmente se realiza correctamente, se informa como FLAKY en el resumen de la prueba. Sin embargo, se considera que se aprobó cuando se trata de identificar el código de salida de Bazel o la cantidad total de pruebas aprobadas. Las pruebas que fallan en todos los intentos permitidos se consideran fallidas.

De forma predeterminada (cuando no se especifica esta opción o cuando se configura como predeterminada), solo se permite un intento para las pruebas normales y 3 para las reglas de prueba con el atributo flaky establecido. Puedes especificar un valor de número entero para anular el límite máximo de intentos de prueba. Bazel permite un máximo de 10 intentos de prueba para evitar el abuso del sistema.

--runs_per_test=[regex@]number

Esta opción especifica la cantidad de veces que se debe ejecutar cada prueba. Todas las ejecuciones de pruebas se tratan como pruebas independientes (la funcionalidad de resguardo se aplicará a cada una de ellas de forma independiente).

El estado de un objetivo con ejecuciones fallidas depende del valor de la marca --runs_per_test_detects_flakes:

• Si no se incluye, cualquier ejecución con errores hará que falle toda la prueba.
• Si está presente y dos ejecuciones del mismo fragmento muestran los resultados APROBADA y NO APROBADA, la prueba recibirá un estado de inestable (a menos que otras ejecuciones con errores la hagan fallar).

Si se especifica un solo número, todas las pruebas se ejecutarán esa cantidad de veces. Como alternativa, se puede especificar una expresión regular con la sintaxis expresión_regular@número. Esto restringe el efecto de --runs_per_test a los objetivos que coinciden con la regex (--runs_per_test=^//pizza:.*@4 ejecuta todas las pruebas en //pizza/ 4 veces). Este tipo de --runs_per_test se puede especificar más de una vez.

--[no]runs_per_test_detects_flakes

Si se especifica esta opción (no es el valor predeterminado), Bazel detectará fragmentos de prueba inestables a través de --runs_per_test. Si una o más ejecuciones de un solo fragmento fallan y una o más ejecuciones del mismo fragmento pasan, el objetivo se considerará inestable con la marca. Si no se especifica, el objetivo informará un estado de error.

--test_summary=output_style

Especifica cómo se debe mostrar el resumen de los resultados de la prueba.

• short imprime los resultados de cada prueba junto con el nombre del archivo que contiene el resultado de la prueba si esta falla. Este es el valor predeterminado.
• terse es como short, pero aún más breve: solo imprime información sobre las pruebas que no se aprobaron.
• detailed imprime cada caso de prueba individual que falló, no solo cada prueba. Se omiten los nombres de los archivos de salida de la prueba.
• none no imprime el resumen de la prueba.

--test_output=output_style

Especifica cómo se debe mostrar el resultado de la prueba:

• summary muestra un resumen de si cada prueba se aprobó o no. También muestra el nombre del archivo de registro de salida de las pruebas que fallaron. El resumen se imprimirá al final de la compilación (durante la compilación, solo se verán mensajes de progreso simples cuando comiencen, aprueben o fallen las pruebas). Este es el comportamiento predeterminado.
• errors envía el resultado combinado de stdout/stderr de las pruebas fallidas solo a stdout inmediatamente después de que se completa la prueba, lo que garantiza que el resultado de las pruebas simultáneas no se entrelace entre sí. Imprime un resumen en la compilación según el resultado del resumen anterior.
• all es similar a errors, pero imprime el resultado de todas las pruebas, incluidas las que se aprobaron.
• streamed transmite el resultado de stdout/stderr de cada prueba en tiempo real.

--java_debug

Esta opción hace que la máquina virtual de Java de una prueba de Java espere una conexión de un depurador compatible con JDWP antes de iniciar la prueba. Esta opción implica --test_output=streamed.

--[no]verbose_test_summary

De forma predeterminada, esta opción está habilitada, lo que hace que los tiempos de prueba y otra información adicional (como los intentos de prueba) se impriman en el resumen de la prueba. Si se especifica --noverbose_test_summary, el resumen de la prueba solo incluirá el nombre, el estado y el indicador de prueba almacenado en caché, y tendrá el formato para mantenerse dentro de 80 caracteres cuando sea posible.

--test_tmpdir=path

Especifica el directorio temporal para las pruebas que se ejecutan de forma local. Cada prueba se ejecutará en un subdirectorio independiente dentro de este directorio. El directorio se limpiará al comienzo de cada comando bazel test. De forma predeterminada, bazel colocará este directorio en el directorio base de salida de Bazel.

--test_timeout=seconds O --test_timeout=seconds,seconds,seconds,seconds

Anula el valor de tiempo de espera de todas las pruebas usando la cantidad especificada de segundos como un nuevo valor de tiempo de espera. Si solo se proporciona un valor, se usará para todas las categorías de tiempo de espera de la prueba.

Como alternativa, se pueden proporcionar cuatro valores separados por comas que especifiquen tiempos de espera individuales para pruebas cortas, moderadas, largas y eternas (en ese orden). En cualquiera de los formatos, cero o un valor negativo para cualquiera de los tamaños de prueba se reemplazará por el tiempo de espera predeterminado para las categorías de tiempo de espera determinadas, como se define en la página Writing Tests. De forma predeterminada, Bazel usará estos tiempos de espera para todas las pruebas infiriendo el límite de tiempo de espera del tamaño de la prueba, ya sea que el tamaño se establezca de forma implícita o explícita.

Las pruebas que indiquen explícitamente su categoría de tiempo de espera como distinta de su tamaño recibirán el mismo valor que si la etiqueta de tamaño hubiera establecido ese tiempo de espera de forma implícita. Por lo tanto, una prueba de tamaño "pequeño" que declare un tiempo de espera "largo" tendrá el mismo tiempo de espera efectivo que una prueba "grande" sin un tiempo de espera explícito.

--test_arg=arg

Pasa opciones, marcas o argumentos de la línea de comandos a cada proceso de prueba. Esta opción se puede usar varias veces para pasar varios argumentos. Por ejemplo, --test_arg=--logtostderr --test_arg=--v=3.

Ten en cuenta que, a diferencia del comando bazel run, no puedes pasar argumentos de prueba directamente como en bazel test -- target --logtostderr --v=3. Esto se debe a que los argumentos externos que se pasan a bazel test se interpretan como objetivos de prueba adicionales. Es decir, --logtostderr y --v=3 se interpretarían como un objetivo de prueba. Esta ambigüedad no existe para un comando bazel run, que solo acepta un objetivo.

Se puede pasar --test_arg a un comando bazel run, pero se ignora, a menos que el objetivo que se ejecuta sea un objetivo de prueba. (Al igual que con cualquier otra marca, si se pasa en un comando bazel run después de un token --, Bazel no lo procesa, sino que lo reenvía de forma literal al destino ejecutado).

--test_env=variable=_value_ O --test_env=variable

Especifica las variables adicionales que se deben insertar en el entorno de prueba para cada prueba. Si no se especifica value, se heredará del entorno de shell que se usa para iniciar el comando bazel test.

Se puede acceder al entorno desde una prueba con System.getenv("var") (Java), getenv("var") (C o C++).

--run_under=command-prefix

Esto especifica un prefijo que el ejecutor de pruebas insertará antes del comando de prueba antes de ejecutarlo. El command-prefix se divide en palabras con las reglas de tokenización de la shell de Bourne y, luego, la lista de palabras se agrega al principio del comando que se ejecutará.

Si la primera palabra es una etiqueta completamente calificada (comienza con //), se compila. Luego, la etiqueta se sustituye por la ubicación ejecutable correspondiente que se agrega al principio del comando que se ejecutará junto con las otras palabras.

Se aplican algunas advertencias:

• Es posible que la RUTA DE ACCESO que se usa para ejecutar pruebas sea diferente de la RUTA DE ACCESO de tu entorno, por lo que es posible que debas usar una ruta de acceso absoluta para el comando --run_under (la primera palabra en command-prefix).
• stdin no está conectado, por lo que no se puede usar --run_under para comandos interactivos.

Ejemplos:

        --run_under=/usr/bin/strace
        --run_under='/usr/bin/strace -c'
        --run_under=/usr/bin/valgrind
        --run_under='/usr/bin/valgrind --quiet --num-callers=20'

Selección de pruebas

Como se documenta en Opciones de selección de resultados, puedes filtrar las pruebas por tamaño, tiempo de espera, etiqueta o lenguaje. Un filtro de nombre general conveniente puede reenviar argumentos de filtro particulares al ejecutor de pruebas.

Otras opciones para bazel test

La sintaxis y las opciones restantes son exactamente como bazel build.

Cómo ejecutar ejecutables

El comando bazel run es similar a bazel build, excepto que se usa para compilar y ejecutar un solo destino. Esta es una sesión típica (//java/myapp:myapp saluda y muestra sus argumentos):

  % bazel run java/myapp:myapp -- --arg1 --arg2
  INFO: Analyzed target //java/myapp:myapp (13 packages loaded, 27 targets configured).
  INFO: Found 1 target...
  Target //java/myapp:myapp up-to-date:
    bazel-bin/java/myapp/myapp
  INFO: Elapsed time: 14.290s, Critical Path: 5.54s, ...
  INFO: Build completed successfully, 4 total actions
  INFO: Running command line: bazel-bin/java/myapp/myapp <args omitted>
  Hello there
  $EXEC_ROOT/java/myapp/myapp
  --arg1
  --arg2

bazel run es similar, pero no idéntico, a invocar directamente el binario compilado por Bazel, y su comportamiento es diferente según si el binario que se invocar es una prueba o no.

Cuando el objeto binario no sea una prueba, el directorio de trabajo actual será el árbol de archivos de ejecución del objeto binario.

Cuando el binario es una prueba, el directorio de trabajo actual será la raíz de ejecución y se intentará de buena fe replicar el entorno en el que se suelen ejecutar las pruebas. Sin embargo, la emulación no es perfecta, y las pruebas que tienen varios fragmentos no se pueden ejecutar de esta manera (se puede usar la opción de línea de comandos --test_sharding_strategy=disabled para solucionar este problema).

Las siguientes variables de entorno adicionales también están disponibles para el objeto binario:

• BUILD_WORKSPACE_DIRECTORY: Es la raíz del espacio de trabajo en el que se ejecutó la compilación.
• BUILD_WORKING_DIRECTORY: Es el directorio de trabajo actual desde el que se ejecutó Bazel.
• BUILD_ID: El ID de compilación de la invocación de bazel run. Por lo general, es único, a menos que Bazel se haya ejecutado con --script_path y se vuelva a usar la secuencia de comandos resultante.
• BUILD_EXECROOT: Es la raíz de ejecución de la invocación de bazel run.

Se pueden usar, por ejemplo, para interpretar los nombres de archivo en la línea de comandos de una manera fácil de usar.

Opciones para bazel run

--run_under=command-prefix

Esto tiene el mismo efecto que la opción --run_under para bazel test (consulta más arriba), excepto que se aplica al comando que ejecuta bazel run en lugar de a las pruebas que ejecuta bazel test y no se puede ejecutar con la etiqueta.

Cómo filtrar los resultados de registro de Bazel

Cuando se invoca un objeto binario con bazel run, Bazel imprime el resultado del registro de Bazel y el objeto binario en la invocación. Para que los registros sean menos ruidosos, puedes suprimir los resultados de Bazel con las marcas --ui_event_filters y --noshow_progress.

Por ejemplo: bazel run --ui_event_filters=-info,-stdout,-stderr --noshow_progress //java/myapp:myapp

Ejecución de pruebas

bazel run también puede ejecutar objetos binarios de prueba, lo que tiene el efecto de ejecutar la prueba en una aproximación cercana al entorno que se describe en Cómo escribir pruebas. Ten en cuenta que ninguno de los argumentos --test_* tiene efecto cuando se ejecuta una prueba de esta manera, excepto --test_arg.

Cómo limpiar los resultados de la compilación

El comando clean

Bazel tiene un comando clean, análogo al de Make. Borra los directorios de salida de todas las configuraciones de compilación que realiza esta instancia de Bazel, o todo el árbol de trabajo que crea esta instancia de Bazel, y restablece las cachés internas. Si se ejecuta sin ninguna opción de línea de comandos, se limpiará el directorio de salida de todas las configuraciones.

Recuerda que cada instancia de Bazel está asociada con un solo espacio de trabajo, por lo que el comando clean borrará todos los resultados de todas las compilaciones que hayas hecho con esa instancia de Bazel en ese espacio de trabajo.

Para quitar por completo todo el árbol de trabajo que crea una instancia de Bazel, puedes especificar la opción --expunge. Cuando se ejecuta con --expunge, el comando clean simplemente quita todo el árbol de base de salida que, además del resultado de la compilación, contiene todos los archivos temporales que crea Bazel. También detiene el servidor de Bazel después de la limpieza, lo que equivale al comando shutdown. Por ejemplo, para limpiar todos los registros de disco y memoria de una instancia de Bazel, puedes especificar lo siguiente:

  % bazel clean --expunge

Como alternativa, puedes borrar en segundo plano con --expunge_async. Es seguro invocar un comando de Bazel en el mismo cliente mientras se sigue ejecutando la eliminación asíncrona.

El comando clean se proporciona principalmente como un medio para recuperar espacio en disco para los espacios de trabajo que ya no se necesitan. Es posible que las recompilaciones incrementales de Bazel no sean perfectas, por lo que se puede usar clean para recuperar un estado coherente cuando surjan problemas.

El diseño de Bazel es tal que estos problemas se pueden solucionar y estos errores son de alta prioridad. Si encuentras una compilación incremental incorrecta, envía un informe de errores y, luego, informa los errores en las herramientas en lugar de usar clean.

Cómo consultar el gráfico de dependencias

Bazel incluye un lenguaje de consulta para hacer preguntas sobre el gráfico de dependencias que se usa durante la compilación. El lenguaje de consulta se usa con dos comandos: query y cquery. La principal diferencia entre los dos comandos es que la consulta se ejecuta después de la fase de carga y cquery se ejecuta después de la fase de análisis. Estas herramientas son una ayuda invaluable para muchas tareas de ingeniería de software.

El lenguaje de consulta se basa en la idea de operaciones algebraicas sobre gráficos y se documenta en detalle en

Referencia de consultas de Bazel. Consulta ese documento como referencia, para ver ejemplos y opciones de línea de comandos específicas de la consulta.

La herramienta de consulta acepta varias opciones de línea de comandos. --output selecciona el formato de salida. --[no]keep_going (inhabilitado de forma predeterminada) hace que la herramienta de consulta siga avanzando cuando se producen errores. Este comportamiento se puede inhabilitar si no se acepta un resultado incompleto en caso de errores.

La opción --[no]tool_deps, que está habilitada de forma predeterminada, hace que las dependencias en configuraciones que no son de destino se incluyan en el gráfico de dependencias sobre el que opera la consulta.

La opción --[no]implicit_deps, habilitada de forma predeterminada, hace que se incluyan dependencias implícitas en el gráfico de dependencias sobre el que opera la consulta. Una dependencia implícita es aquella que no se especifica de forma explícita en el archivo BUILD, pero que agrega Bazel.

Ejemplo: "Muestra las ubicaciones de las definiciones (en archivos BUILD) de todos los genrules necesarios para compilar todas las pruebas en el árbol PEBL".

  bazel query --output location 'kind(genrule, deps(kind(".*_test rule", foo/bar/pebl/...)))'

Cómo consultar el gráfico de acciones

El comando aquery te permite consultar acciones en tu gráfico de compilación. Opera en el gráfico de destino configurado después del análisis y expone información sobre las acciones, los artefactos y sus relaciones.

La herramienta acepta varias opciones de línea de comandos. --output selecciona el formato de salida. El formato de salida predeterminado (text) es legible por humanos. Usa proto o textproto para el formato legible por máquinas. En particular, el comando aquery se ejecuta sobre una compilación normal de Bazel y hereda el conjunto de opciones disponibles durante una compilación.

Admite el mismo conjunto de funciones que también está disponible para query tradicional, pero siblings, buildfiles y tests.

Para obtener más detalles, consulta Consulta del gráfico de acciones.

Comandos y opciones misceláneos

help

El comando help proporciona ayuda en línea. De forma predeterminada, muestra un resumen de los comandos y temas de ayuda disponibles, como se muestra en Cómo compilar con Bazel. Si especificas un argumento, se mostrará ayuda detallada sobre un tema en particular. La mayoría de los temas son comandos de Bazel, como build o query, pero hay algunos temas de ayuda adicionales que no corresponden a comandos.

--[no]long (-l)

De forma predeterminada, bazel help [topic] solo imprime un resumen de las opciones relevantes para un tema. Si se especifica la opción --long, también se imprimen el tipo, el valor predeterminado y la descripción completa de cada opción.

shutdown

Los procesos del servidor de Bazel se pueden detener con el comando shutdown. Este comando hace que el servidor de Bazel se cierre en cuanto se vuelve inactivo (por ejemplo, después de que se completen las compilaciones o otros comandos que estén en curso). Para obtener más información, consulta la sección sobre implementación de cliente-servidor.

Los servidores de Bazel se detienen después de un tiempo de espera inactivo, por lo que este comando raramente es necesario. Sin embargo, puede ser útil en secuencias de comandos cuando se sabe que no se realizarán más compilaciones en un espacio de trabajo determinado.

shutdown acepta una opción, --iff_heap_size_greater_than _n_, que requiere un argumento de número entero (en MB). Si se especifica, esto hace que el apagado dependa de la cantidad de memoria que ya se consumió. Esto es útil para las secuencias de comandos que inician muchas compilaciones, ya que cualquier filtración de memoria en el servidor de Bazel podría hacer que falle de forma inesperada en ocasiones. Realizar un reinicio condicional anula esta condición.

info

El comando info imprime varios valores asociados con la instancia del servidor de Bazel o con una configuración de compilación específica. (Las secuencias de comandos que dirigen una compilación pueden usarlas).

El comando info también permite un solo argumento (opcional), que es el nombre de una de las claves de la siguiente lista. En este caso, bazel info key solo imprimirá el valor de esa clave. (Esto es especialmente conveniente cuando se escribe una secuencia de comandos de Bazel, ya que evita la necesidad de canalizar el resultado a través de sed -ne /key:/s/key://p:

Datos independientes de la configuración

• release: Es la etiqueta de lanzamiento de esta instancia de Bazel o "versión de desarrollo" si no es un objeto binario lanzado.
• workspace la ruta de acceso absoluta al directorio del lugar de trabajo base.

• install_base: Es la ruta de acceso absoluta al directorio de instalación que usa esta instancia de Bazel para el usuario actual. Bazel instala sus ejecutables necesarios de forma interna debajo de este directorio.

• output_base: Es la ruta de acceso absoluta al directorio de salida base que usa esta instancia de Bazel para la combinación de usuario y espacio de trabajo actuales. Bazel coloca todos sus resultados de compilación y de cero debajo de este directorio.

• execution_root: Es la ruta de acceso absoluta al directorio raíz de ejecución en output_base. Este directorio es la raíz de todos los archivos a los que pueden acceder los comandos que se ejecutan durante la compilación y es el directorio de trabajo de esos comandos. Si el directorio del lugar de trabajo es de escritura, se coloca un symlink llamado bazel-<workspace> que apunta a este directorio.

• output_path: Es la ruta de acceso absoluta al directorio de salida debajo de la raíz de ejecución que se usa para todos los archivos que se generan como resultado de los comandos de compilación. Si el directorio del lugar de trabajo es legible, se coloca un symlink llamado bazel-out que apunta a este directorio.

• server_pid: El ID del proceso del servidor de Bazel.

• server_log: Es la ruta de acceso absoluta al archivo de registro de depuración del servidor de Bazel. Este archivo contiene información de depuración para todos los comandos durante el ciclo de vida del servidor de Bazel y está destinado al consumo humano por parte de los desarrolladores y usuarios avanzados de Bazel.

• command_log: Es la ruta de acceso absoluta al archivo de registro de comandos. Contiene los flujos intercalados de stdout y stderr del comando Bazel más reciente. Ten en cuenta que ejecutar bazel info reemplazará el contenido de este archivo, ya que se convierte en el comando de Bazel más reciente. Sin embargo, la ubicación del archivo de registro de comandos no cambiará, a menos que cambies la configuración de las opciones --output_base o --output_user_root.

• used-heap-size, committed-heap-size y max-heap-size: Informa varios parámetros de tamaño del montón de JVM. Respectivamente: memoria que se usa actualmente, memoria que se garantiza que está disponible para la JVM desde el sistema y asignación máxima posible.

• gc-count, gc-time: El recuento acumulativo de las limpiezas de basura desde el inicio de este servidor de Bazel y el tiempo dedicado a realizarlas. Ten en cuenta que estos valores no se restablecen al comienzo de cada compilación.

• package_path: Es una lista de rutas separadas por dos puntos en las que Bazel buscará paquetes. Tiene el mismo formato que el argumento de línea de comandos de compilación --package_path.

Ejemplo: el ID del proceso del servidor de Bazel.

% bazel info server_pid
1285

Datos específicos de la configuración

Estos datos pueden verse afectados por las opciones de configuración que se pasan a bazel info, por ejemplo, --cpu, --compilation_mode, etc. El comando info acepta todas las opciones que controlan el análisis de dependencias, ya que algunas de ellas determinan la ubicación del directorio de salida de una compilación, la elección del compilador, etc.

• bazel-bin, bazel-testlogs y bazel-genfiles: Informa la ruta de acceso absoluta a los directorios bazel-* en los que se encuentran los programas generados por la compilación. Por lo general, aunque no siempre, es el mismo que los symlinks bazel-* creados en el directorio del lugar de trabajo base después de una compilación correcta. Sin embargo, si el directorio del lugar de trabajo es de solo lectura, no se pueden crear symlinks bazel-*. Las secuencias de comandos que usan el valor que informa bazel info, en lugar de suponer la existencia del symlink, serán más sólidas.
• El entorno “Make” completo. Si se especifica la marca --show_make_env, también se muestran todas las variables del entorno "Make" de la configuración actual (como CC, GLIBC_VERSION, etcétera). Estas son las variables a las que se accede con la sintaxis $(CC) o varref("CC") dentro de los archivos BUILD.

Ejemplo: El compilador de C++ para la configuración actual. Esta es la variable $(CC) en el entorno "Make", por lo que se necesita la marca --show_make_env.

  % bazel info --show_make_env -c opt COMPILATION_MODE
  opt

Ejemplo: el directorio de salida bazel-bin para la configuración actual Se garantiza que sea correcto incluso en los casos en que no se pueda crear el symlink bazel-bin por algún motivo (por ejemplo, si compilas desde un directorio de solo lectura).

% bazel info --cpu=piii bazel-bin
/var/tmp/_bazel_johndoe/fbd0e8a34f61ce5d491e3da69d959fe6/execroot/io_bazel/bazel-out/piii-opt/bin
% bazel info --cpu=k8 bazel-bin
/var/tmp/_bazel_johndoe/fbd0e8a34f61ce5d491e3da69d959fe6/execroot/io_bazel/bazel-out/k8-opt/bin

version y --version

El comando version imprime detalles de la versión sobre el objeto binario de Bazel compilado, incluida la lista de cambios en la que se compiló y la fecha. Estos son particularmente útiles para determinar si tienes la versión más reciente de Bazel o si informas errores. Algunos de los valores interesantes son los siguientes:

• changelist: Es la lista de cambios en la que se lanzó esta versión de Bazel.
• label: Es la etiqueta de lanzamiento de esta instancia de Bazel o "versión de desarrollo" si no es un objeto binario lanzado. Es muy útil cuando se informan errores.

bazel --version, sin otros argumentos, emitirá el mismo resultado que bazel version --gnu_format, excepto sin el efecto secundario de iniciar un servidor de Bazel o descomprimir el archivo del servidor. bazel --version se puede ejecutar desde cualquier lugar, no requiere un directorio de lugar de trabajo.

mobile-install

El comando mobile-install instala apps en dispositivos móviles. Actualmente, solo se admiten dispositivos Android que ejecutan ART.

Consulta bazel mobile-install para obtener más información.

Se admiten las siguientes opciones:

--incremental

Si se establece, Bazel intenta instalar la app de forma incremental, es decir, solo aquellas partes que cambiaron desde la última compilación. No se pueden actualizar los recursos a los que se hace referencia desde AndroidManifest.xml, el código nativo ni los recursos de Java (como los que hace referencia Class.getResource()). Si estos elementos cambian, se debe omitir esta opción. Contrario al espíritu de Bazel y debido a las limitaciones de la plataforma de Android, es responsabilidad del usuario saber cuándo este comando es suficiente y cuándo se necesita una instalación completa.

Si usas un dispositivo con Marshmallow o versiones posteriores, considera usar la marca --split_apks.

--split_apks

Indica si se deben usar APKs divididos para instalar y actualizar la aplicación en el dispositivo. Solo funciona con dispositivos que tengan Marshmallow o versiones posteriores. Ten en cuenta que la marca --incremental no es necesaria cuando usas --split_apks.

--start_app

Inicia la app en un estado limpio después de la instalación. Equivale a --start=COLD.

--debug_app

Espera a que se adjunte el depurador antes de iniciar la app en un estado limpio después de la instalación. Equivale a --start=DEBUG.

--start=_start_type_

Indica cómo se debe iniciar la app después de instalarla. Los _start_types_ admitidos son los siguientes:

• NO No inicia la app. Esta es la opción predeterminada.
• COLD Inicia la app desde un estado limpio después de la instalación.
• WARM Conserva y restablece el estado de la aplicación en las instalaciones incrementales.
• DEBUG Espera al depurador antes de iniciar la app en un estado limpio después de la instalación.

--adb=path

Indica el objeto binario adb que se usará.

La opción predeterminada es usar el adb en el SDK de Android que especifica --android_sdk.

--adb_arg=serial

Argumentos adicionales para adb. Estos se colocan antes del subcomando en la línea de comandos y, por lo general, se usan para especificar en qué dispositivo se debe instalar. Por ejemplo, para seleccionar el dispositivo o emulador de Android que se usará, haz lo siguiente:

% bazel mobile-install --adb_arg=-s --adb_arg=deadbeef

invoca adb como

adb -s deadbeef install ...

--incremental_install_verbosity=number

Es el nivel de detalle de la instalación incremental. Establece el valor en 1 para que el registro de depuración se imprima en la consola.

dump

El comando dump imprime en stdout un volcado del estado interno del servidor de Bazel. Este comando está destinado principalmente a los desarrolladores de Bazel, por lo que el resultado de este comando no se especifica y está sujeto a cambios.

De forma predeterminada, el comando solo imprimirá un mensaje de ayuda que describe las posibles opciones para volcar áreas específicas del estado de Bazel. Para volcar el estado interno, se debe especificar al menos una de las opciones.

Se admiten las siguientes opciones:

• --action_cache vuelca el contenido de la caché de acciones.
• --packages vuelca el contenido de la caché del paquete.
• --skyframe vuelca el estado del gráfico de dependencias interno de Bazel.
• --rules vuelca el resumen de reglas para cada regla y clase de aspecto, incluidos los recuentos y los recuentos de acciones. Esto incluye las reglas nativas y de Starlark. Si el seguimiento de memoria está habilitado, también se imprime el consumo de memoria de las reglas.
• --skylark_memory descarta un archivo .gz compatible con pprof en la ruta de acceso especificada. Para que esto funcione, debes habilitar el seguimiento de memoria.

Seguimiento de la memoria

Algunos comandos dump requieren el seguimiento de la memoria. Para activar esta opción, debes pasar marcas de inicio a Bazel:

• --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar
• --host_jvm_args=-DRULE_MEMORY_TRACKER=1

El agente de Java se marca en Bazel en third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar, así que asegúrate de ajustar $BAZEL para la ubicación en la que guardas tu repositorio de Bazel.

No olvides seguir pasando estas opciones a Bazel para cada comando, o el servidor se reiniciará.

Ejemplo:

    % bazel --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
    --host_jvm_args=-DRULE_MEMORY_TRACKER=1 \
    build --nobuild <targets>

    # Dump rules
    % bazel --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
    --host_jvm_args=-DRULE_MEMORY_TRACKER=1 \
    dump --rules

    # Dump Starlark heap and analyze it with pprof
    % bazel --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
    --host_jvm_args=-DRULE_MEMORY_TRACKER=1 \
    dump --skylark_memory=$HOME/prof.gz
    % pprof -flame $HOME/prof.gz

analyze-profile

El comando analyze-profile analiza un perfil de seguimiento JSON recopilado anteriormente durante una invocación de Bazel.

canonicalize-flags

El comando canonicalize-flags, que toma una lista de opciones para un comando de Bazel y muestra una lista de opciones que tiene el mismo efecto. La nueva lista de opciones es canónica. Por ejemplo, dos listas de opciones con el mismo efecto se canonizan en la misma lista nueva.

La opción --for_command se puede usar para seleccionar entre diferentes comandos. En este momento, solo se admiten build y test. Las opciones que no admite el comando determinado generan un error.

A continuación, se muestra un ejemplo:

  % bazel canonicalize-flags -- --config=any_name --test_tag_filters="-lint"
  --config=any_name
  --test_tag_filters=-lint

Opciones de inicio

Las opciones que se describen en esta sección afectan el inicio de la máquina virtual de Java que usa el proceso del servidor de Bazel y se aplican a todos los comandos posteriores que controla ese servidor. Si ya hay un servidor Bazel en ejecución y las opciones de inicio no coinciden, se reiniciará.

Todas las opciones que se describen en esta sección se deben especificar con la sintaxis --key=value o --key value. Además, estas opciones deben aparecer antes del nombre del comando Bazel. Usa startup --key=value para enumerarlos en un archivo .bazelrc.

--output_base=dir

Esta opción requiere un argumento de ruta de acceso, que debe especificar un directorio que se pueda escribir. Bazel usará esta ubicación para escribir todo su resultado. La base de salida también es la clave con la que el cliente ubica el servidor de Bazel. Cuando cambias la base de salida, cambias el servidor que controlará el comando.

De forma predeterminada, la base de salida se deriva del nombre de acceso del usuario y del nombre del directorio del espacio de trabajo (en realidad, su resumen MD5), por lo que un valor típico se ve de la siguiente manera: /var/tmp/google/_bazel_johndoe/d41d8cd98f00b204e9800998ecf8427e.

Por ejemplo:

 OUTPUT_BASE=/var/tmp/google/_bazel_johndoe/custom_output_base
% bazel --output_base ${OUTPUT_BASE}1 build //foo  &  bazel --output_base ${OUTPUT_BASE}2 build //bar

En este comando, los dos comandos de Bazel se ejecutan de forma simultánea (debido al operador & de la shell), cada uno con una instancia de servidor de Bazel diferente (debido a las diferentes bases de salida). Por el contrario, si se usara la base de salida predeterminada en ambos comandos, ambas solicitudes se enviarían al mismo servidor, que las controlaría de forma secuencial: primero se compilaría //foo, seguida de una compilación incremental de //bar.

--output_user_root=dir

Apunta al directorio raíz en el que se crean las bases de salida e instalación. El directorio no debe existir o debe ser propiedad del usuario que realiza la llamada. En el pasado, esto podía apuntar a un directorio compartido entre varios usuarios, pero ya no se permite. Esto se podría permitir una vez que se resuelva el problema #11100.

Si se especifica la opción --output_base, se anula el uso de --output_user_root para calcular la base de salida.

La ubicación de la base de instalaciones se calcula en función de --output_user_root, más la identidad MD5 de los objetos binarios incorporados de Bazel.

Puedes usar la opción --output_user_root para elegir una ubicación de base alternativa para todo el resultado de Bazel (base de instalación y base de salida) si hay una ubicación mejor en el diseño de tu sistema de archivos.

--server_javabase=dir

Especifica la máquina virtual de Java en la que se ejecuta Bazel. El valor debe ser una ruta de acceso al directorio que contiene un JDK o JRE. No debe ser una etiqueta. Esta opción debe aparecer antes de cualquier comando de Bazel, por ejemplo:

  % bazel --server_javabase=/usr/local/buildtools/java/jdk build //foo

Esta marca no afecta a las JVM que usan los subprocesos de Bazel, como aplicaciones, pruebas, herramientas, etcétera. En su lugar, usa las opciones de compilación --javabase o --host_javabase.

Anteriormente, esta marca se llamaba --host_javabase (a veces, se la conoce como --host_javabase del "lado izquierdo"), pero se cambió el nombre para evitar confusiones con la marca de compilación --host_javabase (a veces, se la conoce como --host_javabase del "lado derecho").

--host_jvm_args=string

Especifica una opción de inicio que se pasará a la máquina virtual de Java en la que se ejecuta Bazel. Esto se puede usar para establecer el tamaño de la pila, por ejemplo:

  % bazel --host_jvm_args="-Xss256K" build //foo

Esta opción se puede usar varias veces con argumentos individuales. Ten en cuenta que rara vez se necesitará configurar esta marca. También puedes pasar una lista de cadenas separadas por espacios, cada una de las cuales se interpretará como un argumento de JVM independiente, pero esta función pronto dejará de estar disponible.

Que esto no afecta a ninguna JVM que usen los subprocesos de Bazel: aplicaciones, pruebas, herramientas, etcétera. Para pasar opciones de JVM a programas Java ejecutables, ya sea que se ejecuten con bazel run o en la línea de comandos, debes usar el argumento --jvm_flags que admiten todos los programas java_binary y java_test. Como alternativa, para las pruebas, usa bazel test --test_arg=--jvm_flags=foo ....

--host_jvm_debug

Esta opción hace que la máquina virtual de Java espere una conexión de un depurador compatible con JDWP antes de llamar al método principal de Bazel. Esto está destinado principalmente a los desarrolladores de Bazel.

--autodetect_server_javabase

Esta opción hace que Bazel busque automáticamente un JDK instalado durante el inicio y que recurra al JRE instalado si el JRE incorporado no está disponible. --explicit_server_javabase se puede usar para elegir un JRE explícito con el que ejecutar Bazel.

--batch

El modo por lotes hace que Bazel no use el modo cliente-servidor estándar, sino que ejecute un proceso de Java de Bazel para un solo comando, que se usó para una semántica más predecible con respecto al manejo de indicadores, el control de trabajos y la herencia de variables de entorno, y es necesario para ejecutar Bazel en una cárcel de chroot.

El modo por lotes conserva la semántica de cola adecuada dentro de la misma base de salida. Es decir, las invocaciones simultáneas se procesarán en orden, sin superposición. Si se ejecuta un Bazel en modo por lotes en un cliente con un servidor en ejecución, primero se mata el servidor antes de procesar el comando.

Bazel se ejecutará más lento en el modo por lotes o con las alternativas descritas anteriormente. Esto se debe a que, entre otras cosas, la caché del archivo de compilación reside en la memoria, por lo que no se conserva entre invocaciones por lotes secuenciales. Por lo tanto, usar el modo por lotes suele tener más sentido en los casos en que el rendimiento es menos importante, como en las compilaciones continuas.

--max_idle_secs=n

Esta opción especifica cuánto tiempo, en segundos, el proceso del servidor de Bazel debe esperar después de la última solicitud del cliente, antes de salir. El valor predeterminado es 10,800 (3 horas). --max_idle_secs=0 hará que el proceso del servidor de Bazel persista de forma indefinida.

Las secuencias de comandos que invocan Bazel pueden usar esta opción para garantizar que no dejen procesos del servidor de Bazel en la máquina de un usuario cuando de otra manera no se ejecutarían. Por ejemplo, una secuencia de comandos previa al envío podría invocar a bazel query para garantizar que el cambio pendiente de un usuario no introduzca dependencias no deseadas. Sin embargo, si el usuario no realizó una compilación reciente en ese espacio de trabajo, no sería conveniente que la secuencia de comandos de envío previo inicie un servidor de Bazel solo para que permanezca inactivo durante el resto del día. Si especificas un valor pequeño de --max_idle_secs en la solicitud de consulta, la secuencia de comandos puede garantizar que si provocó que se iniciara un servidor nuevo, ese servidor se cierre de inmediato, pero si, en cambio, ya había un servidor en ejecución, ese servidor seguirá ejecutándose hasta que esté inactivo durante el tiempo habitual. Por supuesto, se restablecerá el temporizador de inactividad del servidor existente.

--[no]shutdown_on_low_sys_mem

Si está habilitado y --max_idle_secs se establece en una duración positiva, después de que el servidor de compilación esté inactivo durante un tiempo, apaga el servidor cuando el sistema tenga poca memoria. Solo en Linux.

Además de ejecutar una verificación de inactividad correspondiente a max_idle_secs, el servidor de compilación comenzará a supervisar la memoria del sistema disponible después de que el servidor haya estado inactivo durante un tiempo. Si la memoria del sistema disponible se agota, el servidor se cerrará.

--[no]block_for_lock

Si está habilitado, Bazel esperará a que se completen otros comandos de Bazel que mantienen el bloqueo del servidor antes de continuar. Si está inhabilitada, Bazel se cerrará con un error si no puede adquirir el bloqueo de inmediato y continuar.

Los desarrolladores pueden usar esto en las verificaciones previas al envío para evitar largas esperas causadas por otro comando de Bazel en el mismo cliente.

--io_nice_level=n

Establece un nivel de 0 a 7 para la programación de E/S de mejor esfuerzo. 0 es la prioridad más alta y 7 es la más baja. El programador anticipado solo puede respetar hasta la prioridad 4. Se ignoran los valores negativos.

--batch_cpu_scheduling

Usa la programación de CPU batch para Bazel. Esta política es útil para cargas de trabajo que no son interactivas, pero que no quieren disminuir su valor de agrado. Consulta "man 2 sched_setscheduler". Esta política puede proporcionar una mejor interactividad del sistema a expensas de la capacidad de procesamiento de Bazel.

Otras opciones

--[no]announce_rc

Controla si Bazel anuncia las opciones de inicio y las opciones de comando que se leen de los archivos bazelrc cuando se inicia.

--color (yes|no|auto)

Esta opción determina si Bazel usará colores para destacar su salida en la pantalla.

Si esta opción se establece en yes, se habilita el resultado en color. Si esta opción se establece en auto, Bazel usará el resultado en color solo si el resultado se envía a una terminal y la variable de entorno TERM se establece en un valor que no sea dumb, emacs o xterm-mono. Si esta opción se establece en no, se inhabilita el resultado en color, independientemente de si el resultado se envía a una terminal y del parámetro de configuración de la variable de entorno TERM.

--config=name

Selecciona una sección de configuración adicional de los archivos rc. Para el command actual, también extrae las opciones de command:name si existe esa sección. Se puede especificar varias veces para agregar marcas de varias secciones de configuración. Las expansiones pueden hacer referencia a otras definiciones (por ejemplo, las expansiones se pueden encadenar).

--curses (yes|no|auto)

Esta opción determina si Bazel usará controles de cursor en su salida de pantalla. Esto genera menos datos de desplazamiento y un flujo de salida más compacto y fácil de leer de Bazel. Esto funciona bien con --color.

Si esta opción se establece en yes, se habilita el uso de los controles del cursor. Si esta opción se establece en no, se inhabilita el uso de los controles del cursor. Si esta opción se establece en auto, el uso de los controles del cursor se habilitará en las mismas condiciones que para --color=auto.

--[no]show_timestamps

Si se especifica, se agrega una marca de tiempo a cada mensaje que genera Bazel que especifica la hora en la que se mostró el mensaje.