Nesta página, abordamos as opções disponíveis com vários comandos do Bazel, como bazel build
, bazel run
e bazel test
. Esta página é um complemento
à lista de comandos do Bazel em Build with Bazel.
Sintaxe de destino
Alguns comandos, como build
ou test
, podem operar em uma lista de destinos. Eles usam uma sintaxe mais flexível que os rótulos, documentada em Como especificar os destinos a serem criados.
Opções
As seções abaixo descrevem as opções disponíveis durante um
build. Quando --long
é usado em um comando de ajuda, as mensagens de ajuda on-line fornecem informações resumidas sobre o significado, tipo e valor padrão de cada opção.
A maioria das opções só pode ser especificada uma vez. Quando especificada várias vezes, a última instância vence. As opções que podem ser especificadas várias vezes são identificadas na ajuda on-line com o texto "pode ser usado várias vezes".
Localização do pacote
--package_path
Essa opção especifica o conjunto de diretórios que são pesquisados para encontrar o arquivo BUILD de um determinado pacote.
O Bazel encontra os pacotes pesquisando o caminho deles. Trata-se de uma lista ordenada separada por dois-pontos de diretórios do Bazel, cada um sendo a raiz de uma árvore de origem parcial.
Para especificar um caminho de pacote personalizado usando a opção --package_path
:
% bazel build --package_path %workspace%:/some/other/root
Os elementos do caminho do pacote podem ser especificados em três formatos:
- Se o primeiro caractere for
/
, o caminho será absoluto. - Se o caminho começar com
%workspace%
, ele será usado em relação ao diretório do Bazel mais próximo. Por exemplo, se o diretório de trabalho for/home/bob/clients/bob_client/bazel/foo
, a string%workspace%
no caminho do pacote será expandida para/home/bob/clients/bob_client/bazel
. - Qualquer outra coisa é levada em relação ao diretório de trabalho.
Geralmente, não é isso que você quer,
e pode se comportar de forma inesperada se você usar o Bazel a partir de diretórios abaixo do espaço de trabalho do Bazel.
Por exemplo, se você usar o elemento de caminho do pacote
.
e depois executar cd no diretório/home/bob/clients/bob_client/bazel/foo
, os pacotes serão resolvidos no diretório/home/bob/clients/bob_client/bazel/foo
.
Se você usar um caminho de pacote não padrão, especifique-o no arquivo de configuração do Bazel.
O Bazel não exige que nenhum pacote esteja no diretório atual. Portanto, você pode fazer um build em um espaço de trabalho do bazel vazio se todos os pacotes necessários puderem ser encontrados em outro lugar no caminho do pacote.
Exemplo: como criar a partir de um cliente vazio
% mkdir -p foo/bazel % cd foo/bazel % touch WORKSPACE % bazel build --package_path /some/other/path //foo
--deleted_packages
Essa opção especifica uma lista de pacotes separada por vírgulas que o Bazel precisa considerar excluídos e não tenta carregar de nenhum diretório no caminho do pacote. Isso pode ser usado para simular a exclusão de pacotes sem excluí-los de fato. Essa opção pode ser transmitida várias vezes. Nesse caso, as listas individuais são concatenadas.
Verificação de erros
Essas opções controlam a verificação de erros e/ou os avisos do Bazel.
--[no]check_visibility
Se essa opção for definida como falsa, as verificações de visibilidade serão rebaixadas a avisos. O valor padrão dessa opção é verdadeiro, portanto, a verificação de visibilidade é feita por padrão.
--output_filter=regex
A opção --output_filter
vai mostrar apenas avisos de build e
compilação para destinos que correspondem à expressão regular. Se um destino não
corresponder à expressão regular em questão e a execução dele for bem-sucedida, a saída
e o erro padrão dele serão descartados.
Confira alguns valores típicos para essa opção:
`--output_filter='^//(first/project|second/project):'` | Mostra a saída dos pacotes especificados. |
`--output_filter='^//((?!(first/bad_project|second/bad_project):).)*$'` | Não mostra a saída dos pacotes especificados. |
`--output_filter=` | Mostrar tudo. |
`--output_filter=DONT_MATCH_ANYTHING` | Não mostrar nada. |
Sinalizações de ferramentas
Elas controlam quais opções o Bazel transmite para outras ferramentas.
--copt=cc-option
Essa opção usa um argumento que será passado ao compilador. O argumento será passado para o compilador sempre que for invocado para pré-processamento, compilação e/ou montagem de código em C, C++ ou assembler. Ele não será transmitido durante a vinculação.
Essa opção pode ser usada várias vezes. Exemplo:
% bazel build --copt="-g0" --copt="-fpic" //foo
vai compilar a biblioteca foo
sem depurar tabelas, gerando
um código independente de posição.
--host_copt=cc-option
Essa opção usa um argumento que deve ser passado ao compilador para arquivos de origem
compilados na configuração "exec". Isso é análogo à
opção --copt
, mas se aplica apenas à
configuração "exec".
--host_conlyopt=cc-option
Essa opção usa um argumento que deve ser passado ao compilador para arquivos de origem C
compilados na configuração "exec". Isso é análogo à
opção --conlyopt
, mas se aplica apenas
à configuração "exec".
--host_cxxopt=cc-option
Essa opção usa um argumento que precisa ser passado ao compilador para arquivos de origem C++
compilados na configuração "exec". Isso é análogo à
opção --cxxopt
, mas se aplica apenas à
configuração "exec".
--host_linkopt=linker-option
Essa opção usa um argumento que precisa ser passado ao vinculador para arquivos de origem compilados na configuração "exec". Isso é análogo à opção --linkopt
, mas se aplica apenas à configuração "exec".
--conlyopt=cc-option
Essa opção aceita um argumento que deve ser passado ao compilador na compilação de arquivos de origem em C.
Isso é semelhante ao --copt
, mas se aplica somente à compilação C,
não à compilação ou vinculação C++. Portanto, você pode transmitir opções específicas de C
(como -Wno-pointer-sign
) usando --conlyopt
.
--cxxopt=cc-option
Essa opção usa um argumento que precisa ser passado ao compilador ao compilar arquivos de origem em C++.
Isso é semelhante ao --copt
, mas se aplica somente à compilação em C++,
não à compilação ou vinculação em C. Portanto, você pode transmitir opções específicas de C++
(como -fpermissive
ou -fno-implicit-templates
) usando --cxxopt
.
Exemplo:
% bazel build --cxxopt="-fpermissive" --cxxopt="-Wno-error" //foo/cruddy_code
--linkopt=linker-option
Essa opção usa um argumento que precisa ser passado ao compilador durante a vinculação.
Isso é semelhante ao --copt
, mas se aplica apenas a vinculações,
não à compilação. Portanto, você pode transmitir opções do compilador que só fazem sentido
no momento da vinculação (como -lssp
ou -Wl,--wrap,abort
)
usando --linkopt
. Exemplo:
% bazel build --copt="-fmudflap" --linkopt="-lmudflap" //foo/buggy_code
As regras de criação também podem especificar opções de vinculação nos atributos. As configurações dessa opção sempre têm precedência. Consulte também cc_library.linkopts.
--strip (always|never|sometimes)
Essa opção determina se o Bazel vai remover as informações de depuração de todos os binários e bibliotecas compartilhadas invocando o vinculador com a opção -Wl,--strip-debug
.
--strip=always
significa sempre remover as informações de depuração.
--strip=never
significa que nunca remova as informações de depuração.
O valor padrão de --strip=sometimes
significa remover se a --compilation_mode
for fastbuild
.
% bazel build --strip=always //foo:bar
vai compilar o destino e remover as informações de depuração de todos os binários gerados.
A opção --strip
do Bazel corresponde à opção --strip-debug
do ld:
ela só remove informações de depuração. Se por algum motivo você quiser remover todos os símbolos,
não apenas os símbolos debug, será necessário usar a opção --strip-all
de ld,
que pode ser feita transmitindo --linkopt=-Wl,--strip-all
para o Bazel. Além disso,
esteja ciente de que a definição da flag --strip
do Bazel vai substituir
--linkopt=-Wl,--strip-all
. Portanto, defina apenas uma das opções.
Se você estiver criando apenas um binário e quiser remover todos os símbolos, também poderá
transmitir --stripopt=--strip-all
e criar explicitamente a
versão //foo:bar.stripped
do destino. Conforme descrito na seção sobre
--stripopt
, isso aplica uma ação de remoção após o binário final ser
vinculado, em vez de incluir a remoção em todas as ações de vinculação do build.
--stripopt=strip-option
Essa é uma opção extra para transmitir ao comando strip
ao gerar
um binário *.stripped
. O padrão
é -S -p
. Essa opção pode ser usada várias vezes.
--fdo_instrument=profile-output-dir
A opção --fdo_instrument
ativa a geração de
saída do perfil de otimização direcionada por feedback (FDO, na sigla em inglês) quando o
binário C/C++ criado é executado. No GCC, o argumento fornecido é usado como um prefixo de diretório para uma árvore de diretórios de arquivos por objeto de arquivos .gcda contendo informações de perfil para cada arquivo .o.
Depois que a árvore de dados do perfil for gerada, ela
precisa ser compactada e fornecida à opção
--fdo_optimize=profile-zip
do Bazel para ativar a compilação otimizada para FDO.
Para o compilador do LLVM, o argumento também é o diretório em que os arquivos de dados de perfil brutos
do LLVM são despejados. Por exemplo: --fdo_instrument=/path/to/rawprof/dir/
.
As opções --fdo_instrument
e --fdo_optimize
não podem ser usadas ao mesmo tempo.
--fdo_optimize=profile-zip
A opção --fdo_optimize
permite o uso das
informações de perfil de arquivo por objeto para realizar otimizações FDO (otimização
direcionada por feedback) durante a compilação. Para o GCC, o argumento fornecido é o arquivo ZIP que contém a árvore de arquivos .gcda gerada anteriormente com informações de perfil para cada arquivo .o.
Como alternativa, o argumento fornecido pode apontar para um perfil automático identificado pela extensão .afdo.
Para o compilador do LLVM, o argumento fornecido precisa apontar para o arquivo de saída do perfil LLVM indexado preparado pela ferramenta llvm-profdata e ter uma extensão .profdata.
As opções --fdo_instrument
e --fdo_optimize
não podem ser usadas ao mesmo tempo.
--java_language_version=version
Esta opção especifica a versão das origens Java. Exemplo:
% bazel build --java_language_version=8 java/com/example/common/foo:all
compila e permite apenas construções compatíveis com a especificação Java 8.
O valor padrão é 11. -->
Os valores possíveis são: 8, 9, 10, 11, 14 e 15 e podem ser estendidos pelo
registro de conjuntos de ferramentas Java personalizados usando default_java_toolchain
.
--tool_java_language_version=version
A versão da linguagem Java usada para criar ferramentas que são executadas durante um build. O valor padrão é 11.
--java_runtime_version=version
Essa opção especifica a versão da JVM a ser usada para executar o código e os testes. Exemplo:
% bazel run --java_runtime_version=remotejdk_11 java/com/example/common/foo:java_application
faz o download do JDK 11 de um repositório remoto e executa o aplicativo Java usando esse repositório.
O valor padrão é local_jdk
.
Os valores possíveis são: local_jdk
, local_jdk_version
, remotejdk_11
e remotejdk_17
.
Estenda os valores registrando uma JVM personalizada usando as
regras de repositório local_java_repository
ou remote_java_repository
.
--tool_java_runtime_version=version
A versão da JVM usada para executar ferramentas necessárias durante um build.
O valor padrão é remotejdk_11
.
--jvmopt=jvm-option
Essa opção permite que os argumentos sejam passados para a VM do Java. Ela pode ser usada com um argumento grande ou várias vezes com argumentos individuais. Exemplo:
% bazel build --jvmopt="-server -Xms256m" java/com/example/common/foo:all
usará a VM do servidor para iniciar todos os binários Java e definirá o tamanho do heap de inicialização da VM como 256 MB.
--javacopt=javac-option
Essa opção permite que os argumentos sejam passados para javac. Ela pode ser usada com um argumento grande ou várias vezes com argumentos individuais. Exemplo:
% bazel build --javacopt="-g:source,lines" //myprojects:prog
vai recriar um java_binary com as informações de depuração padrão javac (em vez do padrão do Bazel).
A opção é passada para javac após as opções padrão integradas do Bazel para javac e antes das opções por regra. A última especificação de qualquer opção para javac vence. As opções padrão para javac são:
-source 8 -target 8 -encoding UTF-8
--strict_java_deps (default|strict|off|warn|error)
Essa opção controla se javac verifica se há dependências diretas ausentes. Os destinos Java precisam declarar explicitamente todos os destinos usados diretamente como dependências. Essa sinalização instrui o javac a determinar os jars realmente usados para a verificação de tipos de cada arquivo Java e a alert/error se eles não forem a saída de uma dependência direta do destino atual.
off
significa que a verificação está desativada.warn
significa que javac gerará avisos Java padrão do tipo[strict]
para cada dependência direta ausente.default
,strict
eerror
médias de javac vão gerar erros em vez de avisos, fazendo com que o destino atual não seja criado se alguma dependência direta ausente for encontrada. Esse também é o comportamento padrão quando a sinalização não é especificada.
Semântica de build
Essas opções afetam os comandos de compilação e/ou o conteúdo do arquivo de saída.
--compilation_mode (fastbuild|opt|dbg)
(-c)
A opção --compilation_mode
(geralmente abreviada para -c
,
especialmente -c opt
) usa um argumento de fastbuild
, dbg
ou opt
e afeta várias opções de geração de código
C/C++, como o nível de otimização e a integridade das
tabelas de depuração. O Bazel usa um diretório de saída diferente para cada
modo de compilação diferente, para que você possa alternar entre os modos sem
precisar fazer uma recriação completa todas as vezes.
fastbuild
significa criar o mais rápido possível: gere o mínimo de informações de depuração (-gmlt -Wl,-S
) e não otimize. Esse é o padrão. Observação:-DNDEBUG
não será definido.dbg
significa criar com depuração ativada (-g
), para que você possa usar o gdb (ou outro depurador).opt
significa build com otimização ativada e chamadasassert()
desativadas (-O2 -DNDEBUG
). As informações de depuração não serão geradas no modoopt
, a menos que você também transmita--copt -g
.
--cpu=cpu
Essa opção especifica a arquitetura de CPU de destino a ser usada para a compilação de binários durante o build.
--action_env=VAR=VALUE
Especifica o conjunto de variáveis de ambiente disponíveis durante a execução de todas as ações.
As variáveis podem ser especificadas pelo nome (nesse caso, o valor será retirado do ambiente de invocação) ou pelo par name=value
, que define o valor independentemente do ambiente de invocação.
Essa sinalização --action_env
pode ser especificada várias vezes. Se um valor for atribuído à mesma
variável em várias sinalizações --action_env
, a atribuição mais recente vencerá.
--experimental_action_listener=label
A opção experimental_action_listener
instrui o Bazel a usar
detalhes da regra action_listener
especificada por label para
inserir extra_actions
no gráfico de build.
--[no]experimental_extra_action_top_level_only
Se essa opção for definida como verdadeira, as ações extras especificadas pela opção de linha de comando --experimental_action_listener
serão programadas apenas para destinos de nível superior.
--experimental_extra_action_filter=regex
A opção experimental_extra_action_filter
instrui o Bazel a
filtrar o conjunto de destinos para programar extra_actions
.
Essa sinalização só é aplicável em combinação com a
sinalização --experimental_action_listener
.
Por padrão, todos os extra_actions
no fechamento transitivo dos
destinos para criação solicitados são programados para execução.
--experimental_extra_action_filter
restringe a programação a extra_actions
, em que o rótulo do proprietário corresponde à expressão regular especificada.
O exemplo a seguir limita a programação de extra_actions
para ser aplicada apenas a ações em que o rótulo do proprietário contém '/bar/':
% bazel build --experimental_action_listener=//test:al //foo/... \ --experimental_extra_action_filter=.*/bar/.*
--host_cpu=cpu
Essa opção especifica o nome da arquitetura de CPU que precisa ser usada para criar ferramentas de host.
--android_platforms=platform[,platform]*
As plataformas para criar o deps
transitivo das
regras android_binary
(especificamente para dependências nativas, como C++). Por
exemplo, se um cc_library
aparece no deps
transitivo de uma
regra android_binary
, ele é criado uma vez para cada plataforma especificada com
--android_platforms
para a regra android_binary
e incluído na saída
final.
Não há valor padrão para essa sinalização: é necessário definir e usar uma plataforma Android personalizada.
Um arquivo .so
é criado e empacotado no APK para cada plataforma especificada
com --android_platforms
. O nome do arquivo .so
prefixa o nome da regra android_binary
com "lib". Por exemplo, se o nome de android_binary
for "foo", o arquivo será libfoo.so
.
--per_file_copt=[+-]regex[,[+-]regex]...@option[,option]...
Quando presente, qualquer arquivo C++ com um rótulo ou caminho de execução que corresponda a uma das expressões regex de inclusão e que não corresponda a nenhuma das expressões de exclusão será criado com as opções fornecidas. A correspondência de rótulo usa o formato canônico do rótulo (ou seja, //package
:label_name
).
O caminho de execução é o caminho relativo para o diretório do espaço de trabalho, incluindo o nome base (incluindo a extensão) do arquivo C++. Também inclui todos os prefixos dependentes da plataforma.
Para corresponder aos arquivos gerados (como saídas genrule),
o Bazel só pode usar o caminho de execução. Nesse caso, o regexp não deve começar com '//',
porque isso não corresponde a nenhum caminho de execução. Os nomes de pacotes podem ser usados da seguinte forma:
--per_file_copt=base/.*\.pb\.cc@-g0
. Isso corresponderá a todos os
arquivos .pb.cc
em um diretório chamado base
.
Essa opção pode ser usada várias vezes.
A opção é aplicada independentemente do modo de compilação usado. Por exemplo, é possível
compilar com --compilation_mode=opt
e compilar seletivamente alguns
arquivos com a otimização mais forte ativada ou com a otimização desativada.
Ressalva: se alguns arquivos forem compilados seletivamente com símbolos de depuração,
os símbolos poderão ser removidos durante a vinculação. Isso pode ser evitado definindo
--strip=never
.
Sintaxe: [+-]regex[,[+-]regex]...@option[,option]...
, em que regex
representa uma expressão regular que pode ser prefixada com um +
para identificar padrões de inclusão e com -
para identificar padrões de exclusão. option
significa uma opção arbitrária transmitida
para o compilador C++. Se uma opção contiver um ,
, ela precisará ser entre aspas da seguinte forma:
\,
. As opções também podem conter @
, já que apenas o primeiro
@
é usado para separar expressões regulares das opções.
Exemplo:
--per_file_copt=//foo:.*\.cc,-//foo:file\.cc@-O0,-fprofile-arcs
adiciona as opções -O0
e -fprofile-arcs
à linha de
comando do compilador C++ para todos os arquivos .cc
em //foo/
, exceto file.cc
.
--dynamic_mode=mode
Determina se os binários C++ serão vinculados dinamicamente, interagindo com o atributo linkstatic nas regras de build.
Modos:
auto
: traduz para um modo dependente de plataforma.default
para Linux eoff
para cygwin.default
: permite que o Bazel escolha se quer vincular dinamicamente. Consulte linkstatic para mais informações.fully
: vincula todos os destinos dinamicamente. Isso acelera o tempo de vinculação e reduz o tamanho dos binários resultantes.off
: vincula todos os destinos no modo principalmente estático. Se-static
estiver definido em linkopts, os destinos serão alterados para totalmente estáticos.
--fission (yes|no|[dbg][,opt][,fastbuild])
Ativa a Fission, que grava informações de depuração C++ em arquivos .dwo dedicados em vez de arquivos .o, para onde seria. Isso reduz significativamente o tamanho da entrada para links e pode reduzir os tempos de vinculação.
Quando definida como [dbg][,opt][,fastbuild]
(exemplo:
--fission=dbg,fastbuild
), a fissão é ativada
apenas para o conjunto especificado de modos de compilação. Isso é útil para configurações do
bazelrc. Quando definida como yes
, a fissão é ativada
universalmente. Quando definida como no
, a fissão é desativada
universalmente. O padrão é no
.
--force_ignore_dash_static
Se essa sinalização for definida, todas as opções -static
nos linkopts dos
arquivos BUILD de regras cc_*
serão ignoradas. Isso é apenas uma
solução alternativa para builds de aumento da proteção do C++.
--[no]force_pic
Se ativadas, todas as compilações em C++ produzem código independente de posição ("-fPIC"), os links preferem bibliotecas pré-criadas para PIC em vez das bibliotecas não PIC e os links produzem executáveis independentes de posição ("-pie"). O padrão é desativado.
--android_resource_shrinking
Seleciona se quer realizar a redução de recursos para as regras android_binary. Define o padrão para o atributo reduzir_resources nas regras android_binary. Consulte a documentação dessa regra para mais detalhes. O padrão é desativado.
--custom_malloc=malloc-library-target
Quando especificada, sempre usa a implementação Malloc especificada, substituindo todos os
atributos malloc="target"
, inclusive nos destinos que usam o
padrão, sem especificar nenhum malloc
.
--crosstool_top=label
Essa opção especifica o local do pacote do compilador crosstool
a ser usado para toda compilação em C++ durante um build. O Bazel procura um
arquivo CROSSTOOL nesse local e o usa para determinar automaticamente
as configurações de --compiler
.
--host_crosstool_top=label
Se não for especificado, o Bazel usa o valor de --crosstool_top
para compilar
código na configuração "exec", como ferramentas executadas durante a build. O principal objetivo dessa flag
é permitir a compilação cruzada.
--apple_crosstool_top=label
O crosstool a ser usado para compilar regras C/C++ no deps
transitivo das
regras objc*, ios* e apple*. Para esses destinos, essa sinalização substitui --crosstool_top
.
--android_crosstool_top=label
O crosstool a ser usado para compilar regras C/C++ no deps
transitivo das
regras android_binary
. Isso é útil se outros destinos no
build exigirem uma ferramenta cruzada diferente. O padrão é usar a ferramenta
gerada pela regra android_ndk_repository
no arquivo ESPAÇO DE TRABALHO.
Consulte também --android_platforms
.
--compiler=version
Essa opção especifica a versão do compilador C/C++ (como gcc-4.1.0
)
que será usada para a compilação de binários durante o build. Se você quiser
criar com uma ferramenta cruzada personalizada, use um arquivo CROSSTOOL em vez de
especificar essa flag.
--android_sdk=label
Obsoleto. Isso não deve ser especificado diretamente.
Essa opção especifica o conjunto de ferramentas do SDK/plataforma do Android e a biblioteca do Android Runtime que será usada para criar qualquer regra relacionada ao Android.
O SDK do Android será selecionado automaticamente se uma regra android_sdk_repository
for definida no arquivo WORKSPACE.
--java_toolchain=label
Essa opção especifica o rótulo do java_datasets usado para compilar arquivos de origem Java.
--host_java_toolchain=label
Se não for especificado, o Bazel usará o valor de --java_toolchain
para compilar
código na configuração de execução, como para ferramentas executadas durante a compilação. O principal objetivo dessa flag
é permitir a compilação cruzada.
--javabase=(label)
Essa opção define o rótulo da instalação Java de base a ser usado para bazel run, teste bazel e para binários Java criados pelas regras java_binary
e java_test
. As variáveis"Make" JAVABASE
e JAVA
são derivadas dessa opção.
--host_javabase=label
Essa opção define o rótulo da instalação Java de base a ser usada na configuração de execução, por exemplo, para ferramentas de compilação de host, incluindo JavaBuilder e Singlejar.
Isso não seleciona o compilador Java usado para compilar arquivos de origem Java. O compilador pode ser selecionado nas configurações da
opção --java_toolchain
.
Estratégia de execução
Essas opções afetam como o Bazel vai executar a compilação. Eles não devem ter nenhum efeito significativo nos arquivos de saída gerados pelo build. Normalmente, o efeito principal é a velocidade do build.
--spawn_strategy=strategy
Essa opção controla onde e como os comandos são executados.
standalone
faz com que os comandos sejam executados como subprocessos locais. Esse valor foi descontinuado. Em vez disso, uselocal
sandboxed
faz com que os comandos sejam executados dentro de um sandbox na máquina local. Isso exige que todos os arquivos de entrada, dependências de dados e ferramentas sejam listados como dependências diretas nos atributossrcs
,data
etools
. O Bazel ativa o sandbox local por padrão em sistemas compatíveis com a execução em sandbox.local
faz com que os comandos sejam executados como subprocessos locais.worker
faz com que os comandos sejam executados usando um worker permanente, se disponível.docker
faz com que os comandos sejam executados dentro de um sandbox do Docker na máquina local. Isso requer que o Docker esteja instalado.remote
faz com que os comandos sejam executados remotamente. Isso só estará disponível se um executor remoto tiver sido configurado separadamente.
--strategy mnemonic=strategy
Essa opção controla onde e como os comandos são executados, substituindo --spawn_strategy (e --genrule_strategy pela genrule mnemônica) por mnemônico. Consulte --spawn_strategy para conhecer as estratégias compatíveis e os efeitos delas.
--strategy_regexp=<filter,filter,...>=<strategy>
Essa opção especifica qual estratégia precisa ser usada para executar comandos que tenham descrições
correspondentes a um determinado regex_filter
. Consulte --per_file_copt para detalhes sobre a correspondência de regex_filter. Consulte --spawn_strategy para conhecer as estratégias compatíveis e os efeitos delas.
O último regex_filter
que corresponde à descrição é usado. Essa opção substitui outras sinalizações para especificar a estratégia.
- Exemplo:
--strategy_regexp=//foo.*\\.cc,-//foo/bar=local
significa executar ações usando a estratégialocal
se as descrições corresponderem a //foo.*.cc, mas não a //foo/bar. - Exemplo:
--strategy_regexp='Compiling.*/bar=local' --strategy_regexp=Compiling=sandboxed
executa "Compiling //foo/bar/baz" com a estratégiasandboxed
, mas ao reverter a ordem, ela executalocal
. - Exemplo:
--strategy_regexp='Compiling.*/bar=local,sandboxed'
executa "Compiling //foo/bar/baz" com a estratégialocal
e volta parasandboxed
se falhar.
--genrule_strategy=strategy
Essa é uma abreviação descontinuada de --strategy=Genrule=strategy
.
--jobs=n
(-j)
Essa opção, que usa um argumento de número inteiro, especifica um limite para o número de jobs que precisam ser executados simultaneamente durante a fase de execução da compilação.
--progress_report_interval=n
O Bazel imprime periodicamente um relatório de progresso de jobs que ainda não estão
concluídos (como testes de longa duração). Essa opção define a
frequência de relatórios. O progresso será mostrado a cada n
segundos.
O padrão é 0, o que significa um algoritmo incremental: o primeiro relatório será impresso após 10 segundos, depois 30 segundos. Após esse período, o progresso será relatado uma vez por minuto.
Quando o Bazel está usando o controle de cursor, conforme especificado por
--curses
, o progresso é informado a cada segundo.
--local_{ram,cpu}_resources resources or resource expression
Essas opções especificam a quantidade de recursos locais (RAM em MB e número de núcleos lógicos da CPU) que o Bazel pode considerar ao programar atividades de compilação e teste para execução local. Elas pegam um número inteiro ou uma palavra-chave (HOST_RAM ou HOST_CPUS) opcionalmente seguida por [-|*
float]
(por exemplo, --local_cpu_resources=2
, --local_ram_resources=HOST_RAM*.5
,
--local_cpu_resources=HOST_CPUS-1
).
As sinalizações são independentes. Uma ou ambas podem ser definidas. Por padrão, o Bazel estima
a quantidade de RAM e o número de núcleos de CPU diretamente da configuração do sistema local.
--[no]build_runfile_links
Essa opção, que é ativada por padrão, especifica se os links simbólicos
dos arquivos de execução para testes e binários precisam ser criados no diretório de saída.
O uso de --nobuild_runfile_links
pode ser útil
para validar se todos os destinos são compilados sem incorrer na sobrecarga
de criação das árvores dos arquivos de execução.
Quando testes (ou aplicativos) são executados, as dependências de dados do ambiente de execução
são reunidas em um só lugar. Dentro da árvore de saída
do Bazel, essa árvore "runfiles" normalmente tem como base um irmão
do binário ou teste correspondente.
Durante a execução do teste, os arquivos de execução podem ser acessados usando caminhos no formato
$TEST_SRCDIR/workspace/packagename/filename
.
A árvore de arquivos de execução garante que os testes tenham acesso a todos os arquivos
em que eles têm uma dependência declarada e nada mais. Por
padrão, a árvore de arquivos de execução é implementada construindo um conjunto de
links simbólicos para os arquivos necessários. À medida que o conjunto de links aumenta,
também aumenta o custo dessa operação e, para alguns builds grandes, ela pode
contribuir significativamente para o tempo total de build, principalmente porque
cada teste individual (ou aplicativo) exige a própria árvore de arquivos de execução.
--[no]build_runfile_manifests
Essa opção, que é ativada por padrão, especifica se os manifestos dos arquivos de execução
precisam ser gravados na árvore de saída.
Desativá-la implica --nobuild_runfile_links
.
Ele pode ser desativado ao executar testes remotamente, porque as árvores dos arquivos de execução serão criadas remotamente a partir de manifestos na memória.
--[no]discard_analysis_cache
Quando essa opção está ativada, o Bazel descarta o cache de análise antes do início da execução, liberando memória extra (em torno de 10%) para a fase de execução. A desvantagem é que mais builds incrementais serão mais lentos. Consulte também Modo de economia de memória.
--[no]keep_going
(- mil)
Como no GNU Make, a fase de execução de uma compilação é interrompida quando o primeiro erro é encontrado. Às vezes, é útil tentar criar o máximo possível, mesmo diante de erros. Essa opção ativa esse comportamento e, quando especificada, o build tenta criar todos os destinos com pré-requisitos que foram criados, mas ignora os erros.
Embora essa opção geralmente esteja associada à fase de execução de
um build, ela também afeta a fase de análise: se vários destinos forem
especificados em um comando de build, mas apenas alguns deles puderem ser
analisados com sucesso, o build será interrompido com um erro,
a menos que --keep_going
seja especificado. Nesse caso, o
build vai prosseguir para a fase de execução, mas apenas para os destinos
analisados com sucesso.
--[no]use_ijars
Essa opção muda a maneira como os destinos java_library
são
compilados pelo Bazel. Em vez de usar a saída de um java_library
para compilar destinos java_library
dependentes, o Bazel criará jars de interface que contêm apenas as assinaturas de membros não particulares (métodos e campos de acesso públicos, protegidos e padrão (pacote) e usará os jars da interface para compilar os destinos dependentes. Isso possibilita
evitar a recompilação quando mudanças são feitas apenas nos
corpos de métodos ou em membros particulares de uma classe.
--[no]interface_shared_objects
Essa opção ativa objetos compartilhados por interface, o que faz com que os binários e outras bibliotecas compartilhadas dependam da interface do objeto compartilhado, em vez da implementação dele. Quando apenas a implementação muda, o Bazel pode evitar recriar destinos que dependem da biblioteca compartilhada alterada desnecessariamente.
Seleção de saída
Essas opções determinam o que compilar ou testar.
--[no]build
Essa opção faz com que a fase de execução do build ocorra. Ela é ativada por padrão. Quando ele é desligado, a fase de execução é ignorada, e apenas as duas primeiras fases, carregamento e análise, ocorrem.
Essa opção pode ser útil para validar arquivos BUILD e detectar erros nas entradas, sem realmente criar nada.
--[no]build_tests_only
Se especificado, o Bazel cria apenas o que é necessário para executar as regras *_test
e test_suite
que não foram filtradas devido ao
tamanho,
tempo limite,
tag ou
idioma.
Se especificado, o Bazel ignora outros destinos especificados na linha de comando.
Por padrão, essa opção está desativada, e o Bazel cria tudo
o solicitado, incluindo as regras *_test
e test_suite
que são filtradas dos
testes. Isso é útil porque a execução de
bazel test --build_tests_only foo/...
pode não detectar todas as falhas de
build na árvore foo
.
--[no]check_up_to_date
Essa opção faz com que o Bazel não execute uma compilação, mas apenas verifica se todos os destinos especificados estão atualizados. Em caso afirmativo, o build será concluído com êxito, como de costume. No entanto, se algum arquivo estiver desatualizado, em vez de ser criado, um erro será informado e o build falhará. Essa opção pode ser útil para determinar se um build foi executado mais recentemente do que uma edição de origem (por exemplo, para verificações de pré-envio) sem incorrer no custo de um build.
Consulte também --check_tests_up_to_date
.
--[no]compile_one_dependency
Compila uma única dependência dos arquivos de argumento. Isso é útil para verificar a sintaxe de arquivos de origem em ambientes de desenvolvimento integrado, por exemplo, ao recriar um único destino que depende do arquivo de origem para detectar erros o mais cedo possível no ciclo de edição/criação/teste. Esse argumento afeta a maneira como todos os argumentos que não são de sinalização são interpretados: cada argumento precisa ser um rótulo de destino de arquivo ou um nome de arquivo simples relativo ao diretório de trabalho atual, e uma regra que depende de cada nome de arquivo de origem é criada. Para fontes C++ e Java, as regras no mesmo espaço de linguagem são escolhidas preferencialmente. Para várias regras com a mesma preferência, é escolhida a primeira que aparece no arquivo BUILD. Um padrão de destino nomeado explicitamente que não faz referência a um arquivo de origem resulta em erro.
--save_temps
A opção --save_temps
faz com que as saídas temporárias do compilador sejam salvas. Isso inclui arquivos .s (código assembler), .i (C pré-processado) e .ii (C++ pré-processado). Essas saídas geralmente são úteis para depuração. As temperaturas serão geradas apenas para o conjunto de metas especificadas na linha de comando.
No momento, a sinalização --save_temps
funciona somente para regras cc_*.
Para garantir que o Bazel imprima o local dos outros arquivos de saída, verifique se
a configuração --show_result n
é alta o suficiente.
--build_tag_filters=tag[,tag]*
Se especificado, o Bazel cria apenas destinos que têm pelo menos uma tag obrigatória (se alguma delas estiver especificada) e não tem tags excluídas. O filtro de tag de criação é especificado como uma lista de palavras-chave de tag delimitada por vírgulas, opcionalmente precedida do sinal '-' usado para indicar tags excluídas. As tags obrigatórias também podem ter um sinal "+" no início.
Ao executar testes, o Bazel ignora --build_tag_filters
para destinos de teste,
que são compilados e executados mesmo que não correspondam a esse filtro. Para evitar a criação, filtre
os destinos de teste usando --test_tag_filters
ou os excluindo explicitamente.
--test_size_filters=size[,size]*
Se especificado, o Bazel vai testar (ou compilar, se --build_tests_only
também for especificado) apenas destinos com o tamanho especificado. O filtro de tamanho de teste
é especificado como uma lista delimitada por vírgulas de valores de tamanho de teste permitidos (pequeno,
médio, grande ou enorme), opcionalmente precedido pelo sinal "-" usado para indicar
tamanhos de teste excluídos. Por exemplo:
% bazel test --test_size_filters=small,medium //foo:all
e
% bazel test --test_size_filters=-large,-enormous //foo:all
testará somente testes pequenos e médios em //foo.
Por padrão, a filtragem de tamanho do teste não é aplicada.
--test_timeout_filters=timeout[,timeout]*
Se especificado, o Bazel vai testar (ou compilar, se --build_tests_only
também for especificado) apenas destinos com o tempo limite especificado. O filtro de tempo limite de teste
é especificado como uma lista delimitada por vírgulas de valores de tempo limite de teste permitidos (curtos,
moderados, longos ou eternos), opcionalmente precedidos pelo sinal "-" usado para indicar
os tempos limite de teste excluídos. Consulte --test_size_filters para ver um exemplo de sintaxe.
Por padrão, a filtragem de tempo limite do teste não é aplicada.
--test_tag_filters=tag[,tag]*
Se especificado, o Bazel vai testar (ou compilar, se --build_tests_only
também estiver especificado) apenas destinos de teste que tenham pelo menos uma tag obrigatória
(se nenhuma delas for especificada) e não têm tags excluídas. O filtro de tag de teste é especificado como uma lista de palavras-chave de tag delimitada por vírgulas, opcionalmente precedida do sinal '-' usado para indicar tags excluídas. As tags obrigatórias também podem ter um sinal "+" no início.
Por exemplo:
% bazel test --test_tag_filters=performance,stress,-flaky //myproject:all
testará destinos marcados com a tag performance
ou stress
, mas não com a tag flaky
.
Por padrão, a filtragem de tags de teste não é aplicada. Também é possível filtrar
as tags size
e local
do teste
dessa maneira.
--test_lang_filters=string[,string]*
Especifica uma lista separada por vírgulas de strings que se referem a nomes de classes de regras de
teste. Para se referir à classe de regra foo_test
, use a string "foo". O Bazel só testa (ou cria, se --build_tests_only
também estiver especificado) apenas
os destinos das classes de regras referenciadas. Para excluir essas segmentações, use a string "-foo". Por exemplo:
% bazel test --test_lang_filters=foo,bar //baz/...
testará somente destinos que são instâncias de foo_test
ou bar_test
em //baz/...
, enquanto
% bazel test --test_lang_filters=-foo,-bar //baz/...
testará todos os destinos em //baz/...
, exceto as instâncias foo_test
e
bar_test
.
--test_filter=filter-expression
Especifica um filtro que o executor de testes pode usar para escolher um subconjunto de testes para execução. Todos os destinos especificados na invocação são criados, mas, dependendo da expressão, apenas alguns deles podem ser executados. Em alguns casos, apenas alguns métodos de teste são executados.
A interpretação específica de filter-expression depende do framework responsável pela execução do teste. Pode ser um glob,
substring ou regexp. --test_filter
é uma conveniência
em vez de transmitir diferentes argumentos de filtro --test_arg
,
mas nem todos os frameworks oferecem suporte a ele.
Verbosidade
Essas opções controlam o nível de detalhes da saída do Bazel para o terminal ou para outros arquivos de registros.
--explain=logfile
Essa opção, que requer um argumento de nome de arquivo, faz com que o
verificador de dependência na fase de execução de bazel build
explique, para cada etapa do build, o motivo da execução ou
a atualização. A explicação é gravada em logfile.
Se você encontrar recriações inesperadas, essa opção poderá ajudar a
entender o motivo. Adicione-o ao .bazelrc
para que
a geração de registros ocorra para todos os builds subsequentes. Em seguida, inspecione o registro
quando uma etapa de execução for executada inesperadamente. Essa opção
pode acarretar uma pequena penalidade de desempenho, portanto, convém removê-la
quando não for mais necessária.
--verbose_explanations
Essa opção aumenta o nível de detalhes das explicações geradas quando a opção --explain está ativada.
Especificamente, se as explicações detalhadas estiverem ativadas e um arquivo de saída for recriado porque o comando usado para criá-lo mudou, a saída no arquivo de explicação incluirá os detalhes completos do novo comando (pelo menos para a maioria dos comandos).
O uso dessa opção pode aumentar significativamente o tamanho do
arquivo de explicação gerado e a penalidade de desempenho ao usar
--explain
.
Se --explain
não estiver ativado, --verbose_explanations
não terá efeito.
--profile=file
Essa opção, que usa um argumento de nome de arquivo, faz com que o Bazel grave
dados de criação de perfil em um arquivo. Em seguida, os dados podem ser analisados usando o
comando bazel analyze-profile
. O perfil de build pode ser útil para
entender onde o comando build
do Bazel está passando tempo.
--[no]show_loading_progress
Essa opção faz com que o Bazel envie mensagens de progresso do carregamento de pacote. Se estiver desativada, as mensagens não serão mostradas.
--[no]show_progress
Essa opção exibe mensagens de progresso. Ela é ativada por padrão. Quando desativada, as mensagens de progresso são suprimidas.
--show_progress_rate_limit=n
Essa opção faz com que o Bazel exiba no máximo uma mensagem de progresso por n
segundos,
em que n é um número real.
O valor padrão dessa opção é 0,02, o que significa que o Bazel vai limitar as mensagens de progresso a uma a cada 0,02 segundo.
--show_result=n
Essa opção controla a exibição de informações do resultado no final
de um comando bazel build
. Por padrão, se um único
destino de build for especificado, o Bazel vai mostrar uma mensagem informando se
o destino foi atualizado e, em caso afirmativo,
a lista de arquivos de saída criados por ele. Se vários
destinos forem especificados, as informações do resultado não serão exibidas.
Embora as informações do resultado possam ser úteis para builds de um ou poucos
destinos, para builds grandes (como uma árvore de projeto de
nível superior inteira), essas informações podem ser sobrecarregadas e causar distrações.
Essa opção permite que elas sejam controladas. --show_result
usa um argumento inteiro, que é o número máximo de destinos
em que as informações completas do resultado precisam ser mostradas. Por padrão,
o valor é 1. Acima desse limite, nenhuma informação de resultado é exibida para destinos individuais. Assim, "zero" faz com que as informações do resultado
sejam sempre suprimidas, e um valor muito alto faz com que
o resultado seja sempre exibido.
Os usuários podem escolher um valor entre os dois se alternarem
regularmente entre criar um pequeno grupo de destinos (por exemplo,
durante o ciclo de compilação-edição-teste) e um grande grupo de destinos
(por exemplo, ao estabelecer um novo espaço de trabalho ou executar
testes de regressão). No primeiro caso, as informações do resultado são
muito úteis, enquanto no último não são. Como em todas as
opções, isso pode ser especificado implicitamente com
o arquivo .bazelrc
.
Os arquivos são impressos para facilitar a cópia e a colagem do nome do arquivo no shell, a fim de executar executáveis criados. As mensagens "atualizadas" ou "com falha" de cada destino podem ser facilmente analisadas por scripts que impulsionam um build.
--sandbox_debug
Essa opção faz com que o Bazel imprima informações extras de depuração ao usar o sandbox para a execução de ações. Essa opção também preserva os diretórios do sandbox para que os arquivos visíveis por ações durante a execução possam ser examinados.
--subcommands
(-s
)
Essa opção faz com que a fase de execução do Bazel imprima a linha de comando completa para cada comando antes de executá-lo.
>>>>> # //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)
Sempre que possível, os comandos são impressos em uma sintaxe compatível com shell Bourne,
para que possam ser facilmente copiados e colados em um prompt de comando do shell.
Os parênteses ao redor são fornecidos para proteger o shell das
chamadas cd
e exec
. Não se esqueça de copiá-los.
No entanto, alguns comandos são implementados internamente no Bazel, como
a criação de árvores de links simbólicos. Para esses casos, não há linha de comando para exibir.
--subcommands=pretty_print
pode ser transmitido para mostrar
os argumentos do comando como uma lista, e não como uma única linha. Isso pode
ajudar a tornar as linhas de comando longas mais legíveis.
Veja também --verbose_failures, abaixo.
Para subcomandos do Logging em um arquivo em um formato compatível com ferramentas, consulte --execution_log_json_file e --execution_log_binary_file.
--verbose_failures
Essa opção faz com que a fase de execução do Bazel imprima a linha de comando completa para os comandos que falharam. Isso pode ser inestimável para depurar um build com falha.
Os comandos com falha são impressos em uma sintaxe compatível com o shell Bourne, adequada para copiar e colar em um prompt de shell.
Status do espaço de trabalho
Use estas opções para "carimbar" os binários criados pelo Bazel para incorporar mais informações aos binários, como a revisão de controle de origem ou outras informações relacionadas ao espaço de trabalho. Você pode usar
esse mecanismo com regras compatíveis com o atributo stamp
, como
genrule
, cc_binary
e muito mais.
--workspace_status_command=program
Essa flag permite especificar um binário que o Bazel executa antes de cada build. O programa pode relatar informações sobre o status do espaço de trabalho, como a revisão de controle de origem atual.
O valor da sinalização precisa ser um caminho para um programa nativo. No Linux/macOS, isso pode ser qualquer executável. No Windows, precisa ser um binário nativo, normalmente um arquivo ".exe", ".bat" ou ".cmd".
O programa precisa mostrar zero ou mais pares de chave-valor na saída padrão, uma entrada em cada linha e sair com zero (caso contrário, o build falhará). Os nomes das chaves podem ser qualquer coisa, mas só podem usar letras maiúsculas e sublinhados. O primeiro espaço após o nome da chave a separa do valor. O valor é o resto da linha (incluindo espaços em branco adicionais). Nem a chave nem o valor podem abranger várias linhas. As chaves não podem ser duplicadas.
O Bazel particiona as chaves em dois buckets: "estável" e "volátil". Os nomes "estável" e "volátil" não são intuitivos, então não pense muito neles.
Em seguida, o Bazel grava os pares de chave-valor em dois arquivos:
bazel-out/stable-status.txt
contém todas as chaves e valores em que o nome da chave começa comSTABLE_
.bazel-out/volatile-status.txt
contém o restante das chaves e os valores delas.
O contrato é:
os valores das chaves "estáveis" raramente mudam, se possível. Se o conteúdo de
bazel-out/stable-status.txt
mudar, o Bazel invalidará as ações que dependem dele. Em outras palavras, se o valor de uma chave estável mudar, o Bazel vai executar novamente as ações carimbadas. Portanto, o status estável não pode conter itens como carimbos de data/hora, porque eles mudam o tempo todo e fazem com que o Bazel execute novamente ações carimbadas em cada build.O Bazel sempre gera as seguintes chaves estáveis:
BUILD_EMBED_LABEL
: valor de--embed_label
BUILD_HOST
: o nome da máquina host em que o Bazel está sendo executado.BUILD_USER
: o nome do usuário em que o Bazel está sendo executado.
os valores das chaves "voláteis" podem mudar com frequência. O Bazel espera que eles mudem o tempo todo, como os carimbos de data/hora, e atualiza o arquivo
bazel-out/volatile-status.txt
. Para evitar uma nova execução de ações estampadas o tempo todo, o Bazel finge que o arquivo volátil nunca muda. Em outras palavras, se o arquivo de status volátil for o único com conteúdo alterado, o Bazel não vai invalidar as ações que dependem dele. Se outras entradas das ações tiverem sido alteradas, o Bazel executará novamente essa ação e ela verá o status volátil atualizado, mas apenas a alteração do status volátil por si só não invalidará a ação.O Bazel sempre gera as seguintes chaves voláteis:
BUILD_TIMESTAMP
: tempo do build em segundos desde a Era Unix (o valor deSystem.currentTimeMillis()
dividido por mil)FORMATTED_DATE
: horário do build, formatado comoyyyy MMM d HH mm ss EEE
(por exemplo, 201 de junho de 2023, 201:44, 29 sexta-feira) em UTC.
No Linux/macOS, você pode transmitir --workspace_status_command=/bin/true
para desativar a recuperação do status do espaço de trabalho, porque true
não faz nada, sai com zero e não gera saída. No Windows, você pode transmitir o caminho do true.exe
do MSYS
para ter o mesmo efeito.
Se o comando de status do espaço de trabalho falhar (sair em um número diferente de zero) por qualquer motivo, o build falhará.
Exemplo de programa no Linux usando 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"
Transmita o caminho desse programa com --workspace_status_command
, e o arquivo de status estável
incluirá as linhas STABLE, e o arquivo de status volátil incluirá o restante das linhas.
--[no]stamp
Esta opção, junto com o atributo de regra stamp
, controla a incorporação de informações da versão em binários.
A estampa pode ser ativada ou desativada explicitamente de acordo com a regra usando o
atributo stamp
. Consulte a Enciclopédia de Criação para mais detalhes. Quando uma regra define stamp = -1
(padrão para regras *_binary
), essa opção determina se o carimbo de data/hora está ativado.
O Bazel nunca grava binários criados para a configuração "exec",
independentemente dessa opção ou do atributo stamp
. Para regras que definem stamp =
0
(o padrão para regras *_test
), a estampagem é desativada independentemente de
--[no]stamp
. Especificar --stamp
não força os destinos a serem recriados se
as dependências não tiverem sido modificadas.
Definir --nostamp
geralmente é adequado para melhorar o desempenho do build, já que
reduz a volatilidade de entrada e maximiza o armazenamento em cache do build.
Plataforma
Use essas opções para controlar as plataformas de host e de destino que configuram o funcionamento das versões e para controlar quais plataformas e conjuntos de ferramentas de execução estão disponíveis para as regras do Bazel.
Consulte informações básicas sobre plataformas e conjuntos de ferramentas.
--platforms=labels
Os rótulos das regras de plataforma que descrevem as plataformas de destino para o comando atual.
--host_platform=label
O rótulo de uma regra de plataforma que descreve o sistema host.
--extra_execution_platforms=labels
As plataformas que estão disponíveis como plataformas de execução para executar ações. As plataformas podem ser especificadas por destino exato ou como um padrão de destino. Essas plataformas serão consideradas antes daquelas declaradas no arquivo WORKSPACE por register_execution_platforms(). Essa opção aceita uma lista de plataformas separadas por vírgulas em ordem de prioridade. Se a sinalização for transmitida várias vezes, as substituições mais recentes serão feitas.
--extra_toolchains=labels
As regras do conjunto de ferramentas a serem consideradas durante a resolução. Os conjuntos de ferramentas podem ser especificados por destino exato ou como um padrão de destino. Esses conjuntos de ferramentas serão considerados antes daqueles declarados no arquivo WORKSPACE por register_toolchains().
--toolchain_resolution_debug=regex
Imprime informações de depuração ao encontrar conjuntos de ferramentas se o tipo corresponder ao regex. Várias regex podem ser separadas por vírgulas. A regex pode ser
negada usando um -
no início. Isso pode ajudar os desenvolvedores
de regras do Bazel ou Starlark com falhas de depuração devido à ausência de conjuntos de ferramentas.
Diversos
--flag_alias=alias_name=target_path
Uma sinalização de conveniência usada para vincular configurações de build mais longas do Starlark a um nome mais curto. Para mais detalhes, consulte as Configurações do Starlark.
--symlink_prefix=string
Altera o prefixo dos links simbólicos de conveniência gerados. O valor padrão do prefixo do link simbólico é bazel-
, que criará os links simbólicos bazel-bin
, bazel-testlogs
e bazel-genfiles
.
Se não for possível criar os links simbólicos, um aviso será emitido, mas o build ainda será considerado bem-sucedido. Mais especificamente, isso permite criar um diretório somente leitura ou em que você não tenha permissão para gravar. Todos os caminhos impressos em mensagens informativas na conclusão de um build só usarão a forma abreviada do link simbólico se os links simbólicos apontarem para o local esperado. Em outras palavras, você pode confiar na exatidão desses caminhos, mesmo que não possa confiar nos links simbólicos criados.
Alguns valores comuns dessa opção:
Suprimir a criação de links simbólicos:
--symlink_prefix=/
fará com que o Bazel não crie nem atualize links simbólicos, incluindo os links simbólicosbazel-out
ebazel-<workspace>
. Use essa opção para suprimir completamente a criação de links simbólicos.Reduza a desordem:
--symlink_prefix=.bazel/
fará com que o Bazel crie links simbólicos chamadosbin
(etc.) dentro de um diretório oculto.bazel
.
--platform_suffix=string
Adiciona um sufixo ao nome curto da configuração, que é usado para determinar o diretório de saída. Definir essa opção para valores diferentes coloca os arquivos em diretórios diferentes, por exemplo, para melhorar as taxas de ocorrência em cache para builds que, de outra forma, prejudicam os arquivos de saída uns dos outros ou para manter os arquivos de saída disponíveis para comparações.
--default_visibility=(private|public)
Sinalização temporária para testar as mudanças de visibilidade padrão do Bazel. Não se destina ao uso geral, mas é documentado para garantir a integridade.
--starlark_cpu_profile=_file_
Essa sinalização, que tem o valor do nome de um arquivo, faz com que o Bazel reúna estatísticas sobre o uso da CPU por todas as linhas de execução do Starlark e grave o perfil no formato pprof no arquivo nomeado.
Use essa opção para ajudar a identificar funções do Starlark que tornam o carregamento e a análise lentos devido ao excesso de computação. Exemplo:
$ 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 visualizações diferentes dos mesmos dados, tente os comandos pprof
svg
,
web
e list
.
Como usar o Bazel para versões
Ele é usado por engenheiros de software durante o ciclo de desenvolvimento e por engenheiros de lançamento ao preparar binários para implantação na produção. Esta seção fornece uma lista de dicas para engenheiros de lançamento que usam o Bazel.
Opções importantes
Ao usar o Bazel para builds de lançamento, surgem os mesmos problemas que outros scripts que executam uma compilação. Para mais detalhes, consulte Chamar o Bazel por scripts. Especificamente, as seguintes opções são altamente recomendadas:
Estas opções também são importantes:
--package_path
--symlink_prefix
: para gerenciar builds de várias configurações, pode ser conveniente distinguir cada build com um identificador distinto, como "64 bits" e "32 bits". Essa opção diferencia os links simbólicos debazel-bin
(etc.).
Executar testes
Para criar e executar testes com o Bazel, digite bazel test
seguido do
nome dos destinos de teste.
Por padrão, esse comando executa atividades simultâneas de compilação e teste, compilando todos os destinos especificados (incluindo aqueles que não sejam de
teste especificados na linha de comando) e testando
os destinos *_test
e test_suite
assim que
os pré-requisitos são criados, o que significa que a execução do teste é
intercalada com a criação. Isso costuma resultar em ganhos de velocidade significativos.
Opções de bazel test
--cache_test_results=(yes|no|auto)
(-t
)
Se essa opção for definida como "auto" (o padrão), o Bazel só vai executar um teste novamente se alguma das seguintes condições se aplicar:
- O Bazel detecta mudanças no teste ou nas dependências dele.
- o teste está marcado como
external
- várias execuções de teste foram solicitadas com
--runs_per_test
- o teste falhou.
Se "não", todos os testes serão executados incondicionalmente.
Se "sim", o comportamento de armazenamento em cache será o mesmo que o automático,
exceto que pode armazenar falhas de teste em cache e execuções de teste com
--runs_per_test
.
Os usuários que ativaram essa opção por padrão no
arquivo .bazelrc
podem achar as
abreviações -t
(ativada) ou -t-
(desativada)
convenientes para substituir o padrão em uma determinada execução.
--check_tests_up_to_date
Essa opção diz ao Bazel para não executar os testes, mas apenas verificar e relatar os resultados armazenados em cache. Se houver algum teste que não tenha sido criado e executado anteriormente ou com resultados desatualizados (por exemplo, porque o código-fonte ou as opções de build foram alterados), o Bazel vai relatar uma mensagem de erro ("o resultado do teste não está atualizado") vai registrar o status do teste como "SEM STATUS" (em vermelho, se a saída de cor estiver ativada) e vai retornar um código de saída diferente de zero.
Essa opção também implica
o comportamento [--check_up_to_date](#check-up-to-date)
.
Essa opção pode ser útil para verificações de pré-envio.
--test_verbose_timeout_warnings
Essa opção diz ao Bazel para avisar explicitamente o usuário se o tempo limite de um teste for significativamente maior que o tempo de execução real do teste. Embora o tempo limite de um teste precise ser definido de modo que não seja instável, um teste que tem um tempo limite muito generoso pode ocultar problemas reais que surgem inesperadamente.
Por exemplo, um teste que normalmente é executado em um ou dois minutos não deve ter um tempo limite de ETERNAL ou LONGO, já que esses valores são muito generosos.
Essa opção é útil para ajudar os usuários a decidir sobre um bom valor de tempo limite ou os valores de tempo limite atuais da verificação de integridade.
--[no]test_keep_going
Por padrão, todos os testes são executados até a conclusão. No entanto, se essa sinalização estiver desativada, a versão será cancelada em qualquer teste sem aprovação. As etapas de build subsequentes
e as invocações de teste não são executadas, e as invocações em trânsito são canceladas.
Não especifique --notest_keep_going
e --keep_going
ao mesmo tempo.
--flaky_test_attempts=attempts
Essa opção especifica o número máximo de vezes que um teste deve ser tentado
em caso de falha por qualquer motivo. Um teste que inicialmente falha, mas é
bem-sucedido, é informado como FLAKY
no resumo do teste. No entanto,
é considerado transmitido quando se trata de identificar o código de saída do Bazel
ou o número total de testes aprovados. Os testes que falharem em todas as tentativas permitidas serão considerados reprovados.
Por padrão (quando essa opção não é especificada ou é definida como
padrão), apenas uma tentativa é permitida para testes regulares e
3 para regras de teste com o atributo flaky
definido. Você pode especificar
um valor inteiro para substituir o limite máximo de tentativas de teste. O Bazel permite
no máximo 10 tentativas de teste para evitar abuso do sistema.
--runs_per_test=[regex@]number
Essa opção especifica o número de vezes que cada teste precisa ser executado. Todas as execuções de teste são tratadas como testes separados (a funcionalidade de substituto será aplicada a cada uma delas de maneira independente).
O status de um destino com execuções com falha depende do valor da
flag --runs_per_test_detects_flakes
:
- Se ausente, qualquer execução com falha fará com que todo o teste falhe.
- Se presente e duas execuções do mesmo fragmento retornarem PASS e FAIL, o teste receberá o status instável (a menos que outras execuções com falha causem falha).
Se um único número for especificado, todos os testes serão executados na mesma quantidade de vezes.
Como alternativa, é possível especificar uma expressão regular usando a sintaxe regex@number. Isso restringe o efeito de --runs_per_test
aos destinos
que correspondem ao regex (--runs_per_test=^//pizza:.*@4
executa todos os testes
em //pizza/
quatro vezes).
Esta forma de --runs_per_test
pode ser especificada mais de uma vez.
--[no]runs_per_test_detects_flakes
Se essa opção for especificada (por padrão, não é), o Bazel vai detectar fragmentos de teste
instáveis usando --runs_per_test
. Se uma ou mais execuções de um único fragmento
falharem e uma ou mais execuções para o mesmo cartão de fragmento, o destino será
considerado instável com a sinalização. Se não for especificado, o destino vai informar um
status de falha.
--test_summary=output_style
Especifica como o resumo do resultado do teste deve ser exibido.
short
imprime os resultados de cada teste com o nome do arquivo que contém a saída do teste, caso ele falhe. Esse é o valor padrão.terse
comoshort
, mas ainda mais curta: exibe apenas informações sobre testes que não foram aprovados.detailed
imprime cada caso de teste que falhou, não apenas cada teste. Os nomes dos arquivos de saída de teste são omitidos.none
não mostra o resumo do teste.
--test_output=output_style
Especifica como a saída do teste deve ser exibida:
summary
mostra um resumo se cada teste foi aprovado ou reprovado. Também mostra o nome do arquivo de registro de saída dos testes com falha. O resumo será impresso no final do build. Durante a criação, são exibidas apenas mensagens de progresso simples quando os testes são iniciados, aprovados ou reprovados. Esse é o comportamento padrão.errors
envia a saída combinada de stdout/stderr de testes com falha apenas para o stdout imediatamente após a conclusão do teste, garantindo que a saída de testes simultâneos não seja intercalada. Imprime um resumo no build de acordo com a saída de resumo acima.all
é semelhante aerrors
, mas exibe a saída para todos os testes, incluindo aqueles que foram aprovados.streamed
transmite a saída stdout/stderr de cada teste em tempo real.
--java_debug
Essa opção faz com que a máquina virtual Java de um teste Java aguarde uma conexão de um
depurador compatível com JDWP antes de iniciar o teste. Essa opção implica --test_output=streamed
.
--[no]verbose_test_summary
Por padrão, essa opção é ativada, fazendo com que os tempos de teste e outras informações (como tentativas de teste) sejam mostrados no resumo do teste. Se --noverbose_test_summary
for especificado, o resumo do teste vai incluir apenas o nome, o status e o indicador do teste em cache, além de ser formatado para ter até 80 caracteres quando possível.
--test_tmpdir=path
Especifica o diretório temporário para testes executados localmente. Cada teste será
executado em um subdiretório separado dentro desse diretório. O diretório será limpo no início de cada comando bazel test
.
Por padrão, o Bazel colocará esse diretório no diretório base de saída do Bazel.
--test_timeout=seconds
OU --test_timeout=seconds,seconds,seconds,seconds
Substitui o valor de tempo limite de todos os testes usando o número especificado de segundos como um novo valor de tempo limite. Se apenas um valor for fornecido, ele será usado para todas as categorias de tempo limite de teste.
Como alternativa, é possível fornecer quatro valores separados por vírgula, especificando tempos limite individuais para testes curtos, moderados, longos e eternos (nessa ordem). Seja qual for a forma, zero ou um valor negativo em qualquer um dos tamanhos de teste será substituído pelo tempo limite padrão das categorias de tempo limite fornecidas, conforme definido na página Como gravar testes. Por padrão, o Bazel usa esses tempos limite em todos os testes inferindo o limite do tempo do teste, independentemente de ele ser definido de maneira implícita ou explícita.
Os testes que declararem explicitamente a categoria de tempo limite como diferente do tamanho receberão o mesmo valor como se esse tempo limite tivesse sido definido implicitamente pela tag de tamanho. Portanto, um teste de tamanho "pequeno" que declara um tempo limite "longo" terá o mesmo tempo limite efetivo que um teste "grande" tem sem tempo limite explícito.
--test_arg=arg
Transmite opções/flags/argumentos da linha de comando para cada processo de teste. Essa
opção pode ser usada várias vezes para transmitir vários argumentos. Por exemplo,
--test_arg=--logtostderr --test_arg=--v=3
.
--test_env=variable=_value_
OU --test_env=variable
Especifica outras variáveis que precisam ser injetadas no ambiente
de teste para cada teste. Se value não for especificado, ele será herdado do ambiente shell usado para iniciar o comando bazel test
.
O ambiente pode ser acessado de dentro de um teste usando
System.getenv("var")
(Java), getenv("var")
(C ou C++),
--run_under=command-prefix
Isso especifica um prefixo que o executor de testes inserirá na frente do comando de teste antes de executá-lo. O command-prefix é dividido em palavras usando regras de tokenização de shell Bourne. Em seguida, a lista de palavras é anexada ao comando que será executado.
Se a primeira palavra for um rótulo totalmente qualificado (começa com //
), ela será criada. Em seguida, o rótulo é substituído pelo local executável correspondente que precede o comando que será executado junto com as outras palavras.
Algumas ressalvas se aplicam:
- O PATH usado para executar testes pode ser diferente do PATH no seu ambiente. Portanto, talvez seja necessário usar um caminho absoluto para o comando
--run_under
(a primeira palavra em command-prefix). stdin
não está conectado, portanto, o--run_under
não pode ser usado para comandos interativos.
Por exemplo:
--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'
Testar seleção
Conforme documentado em Opções de seleção de saída, é possível filtrar testes por tamanho, tempo limite, tag ou idioma. Um filtro de nome geral de conveniência pode encaminhar argumentos de filtro específicos para o executor de testes.
Outras opções para bazel test
A sintaxe e as opções restantes são exatamente como
bazel build
.
Como executar executáveis
O comando bazel run
é semelhante a bazel build
, mas
é usado para criar e executar um único destino. Aqui está uma sessão típica:
% bazel run java/myapp:myapp -- --arg1 --arg2 Welcome to Bazel INFO: Loading package: java/myapp INFO: Loading package: foo/bar INFO: Loading complete. Analyzing... INFO: Found 1 target... ... Target //java/myapp:myapp up-to-date: bazel-bin/java/myapp:myapp INFO: Elapsed time: 0.638s, Critical Path: 0.34s INFO: Running command line: bazel-bin/java/myapp:myapp --arg1 --arg2 Hello there $EXEC_ROOT/java/myapp/myapp --arg1 --arg2
O bazel run
é semelhante, mas não idêntico, à invocação direta
do binário criado pelo Bazel, e o comportamento dele é diferente, dependendo se o
binário a ser invocado é um teste ou não.
Quando o binário não for um teste, o diretório de trabalho atual será a árvore do runfiles do binário.
Quando o binário é um teste, o diretório de trabalho atual é a raiz de execução, e uma tentativa de boa-fé é feita para replicar os testes de ambiente que geralmente são executados. No entanto, a emulação não é perfeita, e testes com vários
fragmentos não podem ser executados dessa maneira. A
opção de linha de comando --test_sharding_strategy=disabled
pode ser usada
para contornar isso.
As variáveis de ambiente extras a seguir também estão disponíveis para o binário:
BUILD_WORKSPACE_DIRECTORY
: a raiz do espaço de trabalho em que o build foi executado.BUILD_WORKING_DIRECTORY
: o diretório de trabalho atual em que o Bazel foi executado.
Eles podem ser usados, por exemplo, para interpretar nomes de arquivos na linha de comando de uma maneira fácil de usar.
Opções de bazel run
--run_under=command-prefix
Isso tem o mesmo efeito que a opção --run_under
para
bazel test
(veja acima),
mas se aplica ao comando que está sendo executado por bazel
run
, em vez dos testes que estão sendo executados por bazel test
,
e não pode ser executado sob o rótulo.
Como filtrar saídas de geração de registros do Bazel
Ao invocar um binário com bazel run
, o Bazel imprime a saída de geração de registros do próprio Bazel e do binário na invocação. Para reduzir o ruído dos registros, você pode
suprimir as saídas do próprio Bazel com as sinalizações --ui_event_filters
e
--noshow_progress
.
Exemplo:
bazel run --ui_event_filters=-info,-stdout,-stderr --noshow_progress //java/myapp:myapp
Como executar testes
O bazel run
também pode executar binários de teste, que têm o efeito de executar o teste em uma aproximação do ambiente descrito em Como programar testes. Nenhum dos argumentos
--test_*
tem efeito ao executar um teste dessa maneira, exceto
--test_arg
.
Como limpar saídas de build
O comando clean
O Bazel tem um comando clean
, análogo ao do Make.
Ele exclui os diretórios de saída de todas as configurações de build executadas
por essa instância do Bazel ou toda a árvore de trabalho criada por essa
instância do Bazel e redefine os caches internos. Se executada sem nenhuma
opção de linha de comando, o diretório de saída de todas as configurações
será limpo.
Lembre-se de que cada instância do Bazel está associada a um único espaço de trabalho. Portanto, o comando clean
excluirá todas as saídas de todas as compilações que você fez com essa instância do Bazel nesse espaço de trabalho.
Para remover completamente toda a árvore de trabalho criada por uma instância
do Bazel, especifique a opção --expunge
. Quando
executado com --expunge
, o comando de limpeza simplesmente
remove toda a árvore de base de saída que, além da saída de
build, contém todos os arquivos temporários criados pelo Bazel. Ele também
interrompe o servidor do Bazel após a limpeza, equivalente ao comando shutdown
. Por exemplo, para
limpar todos os rastreamentos de disco e memória de uma instância do Bazel, especifique:
% bazel clean --expunge
Como alternativa, você pode eliminar em segundo plano usando
--expunge_async
. É seguro invocar um comando do Bazel
no mesmo cliente enquanto a eliminação assíncrona continua em execução.
O comando clean
é fornecido principalmente como um meio de recuperar espaço em disco para espaços de trabalho que não são mais necessários.
As recompilações incrementais do Bazel podem não ser
perfeitas, então o clean
pode ser usado para recuperar um estado
consistente quando surgirem problemas.
O design do Bazel permite que esses problemas sejam corrigidos,
e esses bugs têm alta prioridade de serem corrigidos. Se você
encontrar um build incremental incorreto, envie um relatório do bug e informe bugs nas ferramentas
em vez de usar clean
.
Como consultar o gráfico de dependências
O Bazel inclui uma linguagem de consulta para fazer perguntas sobre o gráfico de dependência usado durante o build. A linguagem de consulta é usada por dois comandos: query e cquery. A principal diferença entre os dois comandos é que a consulta é executada após a fase de carregamento e o cquery é executado após a fase de análise. Essas ferramentas são um auxílio inestimável para muitas tarefas de engenharia de software.
A linguagem de consulta é baseada na ideia de operações algébricas em gráficos e é documentada
Referência de consulta do Bazel. Consulte esse documento para referência, exemplos e opções de linha de comando específicas para consultas.
A ferramenta de consulta aceita
várias opções de linha de comando. --output
seleciona o formato de saída.
--[no]keep_going
(desativado por padrão) faz com que a ferramenta de consulta continue a avançar quando houver erros. Esse comportamento poderá ser desativado se um resultado incompleto não for aceitável em caso de erros.
A opção --[no]tool_deps
,
ativada por padrão, faz com que as dependências em configurações que não sejam de destino sejam incluídas no
gráfico de dependência sobre o qual a consulta opera.
A opção --[no]implicit_deps
, ativada por padrão, faz com que
as dependências implícitas sejam incluídas no gráfico de dependências em que a consulta opera. Uma dependência implícita é aquela que não é especificada explicitamente no arquivo BUILD, mas é adicionada pelo Bazel.
Exemplo: "Mostre os locais das definições (em arquivos BUILD) de todas as regras gerais necessárias para criar todos os testes na árvore PEBL".
bazel query --output location 'kind(genrule, deps(kind(".*_test rule", foo/bar/pebl/...)))'
Como consultar o gráfico de ações
O comando aquery
permite consultar ações no gráfico de build.
Ele opera no gráfico de destino configurado pós-análise e expõe
informações sobre ações, artefatos e relações.
A ferramenta aceita várias opções de linha de comando.
--output
seleciona o formato de saída. O formato de saída padrão
(text
) é legível por humanos. Use proto
ou textproto
para
o formato legível por máquina.
O comando aquery é executado sobre uma compilação normal do Bazel e herda o conjunto de opções disponíveis durante uma compilação.
Ela é compatível com o mesmo conjunto de funções que também está disponível para o query
tradicional,
mas siblings
, buildfiles
e
tests
.
Para mais detalhes, consulte Consulta do gráfico de ações.
Comandos e opções diversos
help
O comando help
fornece ajuda on-line. Por padrão, ele
mostra um resumo dos comandos disponíveis e dos tópicos de ajuda, conforme mostrado em
Como criar com o Bazel.
A especificação de um argumento mostra a ajuda detalhada para um tópico
específico. A maioria dos tópicos são comandos do Bazel, como build
ou query
, mas há outros tópicos de ajuda
que não correspondem a comandos.
--[no]long
(-l
)
Por padrão, bazel help [topic]
exibe apenas um
resumo das opções relevantes para um tópico. Se a opção --long
for especificada, o tipo, o valor padrão e a descrição completa de cada opção também serão mostrados.
shutdown
Os processos do servidor do Bazel podem ser interrompidos usando o comando
shutdown
. Esse comando faz com que o servidor do Bazel seja fechado assim que
ficar inativo, por exemplo, após a conclusão de builds ou outros
comandos em andamento. Para mais detalhes, consulte
Implementação de cliente/servidor.
Como os servidores do Bazel são interrompidos após um tempo limite inativo, esse comando raramente é necessário. No entanto, ele pode ser útil em scripts quando sabemos que não haverá mais builds em um determinado espaço de trabalho.
shutdown
aceita uma opção, --iff_heap_size_greater_than _n_
, que requer um argumento inteiro (em MB). Se especificado, isso torna o encerramento condicional à quantidade de memória já consumida. Isso é
útil para scripts que iniciam muitas builds, já que qualquer vazamento
de memória no servidor do Bazel pode causar uma falha indevida
de vez em quando. A execução de uma reinicialização condicional interrompe essa condição.
info
O comando info
imprime vários valores associados à
instância do servidor do Bazel ou a uma configuração de build específica.
Elas podem ser usadas por scripts que direcionam um build.
O comando info
também permite um único argumento (opcional), que é o nome de uma das chaves na lista abaixo.
Nesse caso, bazel info key
exibirá apenas o valor dessa chave. Isso é útil principalmente ao
criar scripts no Bazel, porque evita a necessidade de canalizar o resultado
pelo sed -ne /key:/s/key://p
:
Dados independentes de configuração
release
: o rótulo de lançamento dessa instância do Bazel ou "versão de desenvolvimento" se esse não for um binário lançado.workspace
é o caminho absoluto para o diretório base do espaço de trabalho.install_base
: o caminho absoluto para o diretório de instalação usado por essa instância do Bazel para o usuário atual. Ele instala os executáveis internamente necessários abaixo desse diretório.output_base
: o caminho absoluto para o diretório de saída base usado por essa instância do Bazel para a combinação atual de usuário e espaço de trabalho. Ele coloca todo o rascunho e a saída de build abaixo desse diretório.execution_root
: o caminho absoluto para o diretório raiz de execução em output_base. Esse diretório é a raiz de todos os arquivos acessíveis aos comandos executados durante a criação e é o diretório de trabalho para esses comandos. Se o diretório do espaço de trabalho for gravável, um link simbólico chamadobazel-<workspace>
será colocado nesse diretório apontando para esse diretório.output_path
: o caminho absoluto para o diretório de saída abaixo da raiz de execução usada para todos os arquivos realmente gerados como resultado de comandos de build. Se o diretório do espaço de trabalho for gravável, um link simbólico chamadobazel-out
será colocado nele apontando para esse diretório.server_pid
: o ID do processo do servidor do Bazel.server_log
: o caminho absoluto para o arquivo de registro de depuração do servidor do Bazel. Esse arquivo contém informações de depuração para todos os comandos durante o ciclo de vida do servidor Bazel e é destinado ao consumo humano por desenvolvedores do Bazel e usuários avançados.command_log
: o caminho absoluto para o arquivo de registro do comando. Ele contém os streams intercalados stdout e stderr do comando mais recente do Bazel. Observe que executarbazel info
substituirá o conteúdo desse arquivo, já que ele se tornará o comando mais recente do Bazel. No entanto, o local do arquivo de registro do comando não será alterado, a menos que você altere a configuração das opções--output_base
ou--output_user_root
.used-heap-size
,committed-heap-size
,max-heap-size
: informa vários parâmetros de tamanho de heap do JVM. Respectivamente: a memória usada atualmente, a memória garantida estar disponível para a JVM no sistema, alocação máxima possível.gc-count
,gc-time
: a contagem cumulativa de coleções de lixo desde o início deste servidor Bazel e o tempo gasto para executá-las. Esses valores não são redefinidos no início de cada build.package_path
: uma lista separada por dois-pontos de caminhos que serão pesquisados por pacotes pelo Bazel. Tem o mesmo formato que o argumento de linha de comando de build--package_path
.
Exemplo: o ID do processo do servidor do Bazel.
% bazel info server_pid 1285
Dados específicos da configuração
Esses dados podem ser afetados pelas opções de configuração transmitidas
para bazel info
, por
exemplo, --cpu
, --compilation_mode
etc. O comando info
aceita todas
as opções que controlam a análise
de dependências, já que algumas delas determinam o local do
diretório de saída de um build, a escolha do compilador etc.
bazel-bin
,bazel-testlogs
,bazel-genfiles
: informa o caminho absoluto para os diretóriosbazel-*
em que os programas gerados pelo build estão localizados. Geralmente, ele é o mesmo que os links simbólicosbazel-*
criados no diretório do espaço de trabalho base após uma criação bem-sucedida. No entanto, se o diretório do espaço de trabalho for somente leitura, não será possível criar links simbólicosbazel-*
. Os scripts que usam o valor informado porbazel info
, em vez de presumir a existência do link simbólico, serão mais robustos.- O
ambiente"Make" completo. Se a sinalização
--show_make_env
for especificada, todas as variáveis no ambiente "Make" da configuração atual também serão exibidas (comoCC
,GLIBC_VERSION
etc.). Essas são as variáveis acessadas usando a sintaxe$(CC)
ouvarref("CC")
nos arquivos BUILD.
Exemplo: o compilador C++ da configuração atual.
Como essa é a variável $(CC)
no ambiente "Make", a sinalização --show_make_env
é necessária.
% bazel info --show_make_env -c opt COMPILATION_MODE opt
Exemplo: o diretório de saída bazel-bin
para a configuração
atual. Essa função está correta mesmo nos casos em que
o link simbólico bazel-bin
não pode ser criado por algum motivo
(por exemplo, quando você está criando a partir de um diretório somente leitura).
% 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
e --version
O comando "version" imprime detalhes da versão sobre o binário criado do Bazel, incluindo a lista de mudanças em que ele foi criado e a data. Elas são particularmente úteis para determinar se você tem o Bazel mais recente ou se está relatando bugs. Alguns dos valores interessantes são:
changelist
: a lista de mudanças em que essa versão do Bazel foi lançada.label
: o rótulo de lançamento dessa instância do Bazel ou "versão de desenvolvimento" se esse não for um binário lançado. Muito útil ao informar bugs.
bazel --version
, sem outros argumentos, emitirá a mesma saída que
bazel version --gnu_format
, exceto sem o efeito colateral de possivelmente iniciar
um servidor Bazel ou descompactar o arquivo do servidor. bazel --version
pode ser executado de
qualquer lugar. Ele não requer um diretório do espaço de trabalho.
mobile-install
O comando mobile-install
instala apps em dispositivos móveis.
No momento, só há suporte para dispositivos Android que executam o ART.
Consulte bazel mobile-install para ver mais informações.
As seguintes opções são compatíveis:
--incremental
Se definido, o Bazel tenta instalar o app de forma incremental, ou seja, apenas as
partes que foram alteradas desde o último build. Isso não pode atualizar recursos referenciados por AndroidManifest.xml
, código nativo ou recursos Java (como aqueles referenciados por Class.getResource()
). Se esses itens mudarem, essa opção precisará ser omitida. Ao contrário do Bazel
e devido às limitações da plataforma Android, é
responsabilidade do usuário saber quando esse comando é suficiente e
quando uma instalação completa é necessária.
Se você estiver usando um dispositivo com Marshmallow ou versão mais recente, considere a
flag --split_apks
.
--split_apks
Define se os APKs divididos devem ser usados para instalar e atualizar o app no dispositivo.
Funciona apenas em dispositivos com a versão Marshmallow ou posterior. A sinalização --incremental
não é necessária ao usar --split_apks
.
--start_app
Inicia o app em um estado limpo após a instalação. É equivalente a --start=COLD
.
--debug_app
Espera o depurador ser anexado antes de iniciar o app em um estado limpo após a instalação.
É equivalente a --start=DEBUG
.
--start=_start_type_
Como o app deve ser iniciado após a instalação. Os _start_type_s compatíveis são:
NO
Não inicia o app. Esse é o padrão.COLD
Inicia o app em um estado limpo após a instalação.WARM
Preserva e restaura o estado do aplicativo em instalações incrementais.DEBUG
aguarda o depurador antes de iniciar o app em um estado limpo após a instalação.
--adb=path
Indica o binário adb
a ser usado.
O padrão é usar o adb no SDK do Android especificado por
--android_sdk
.
--adb_arg=serial
Argumentos extras para adb
. Eles vêm antes do subcomando na
linha de comando e normalmente são usados para especificar em qual dispositivo instalar.
Por exemplo, para selecionar o dispositivo ou emulador Android que será usado:
% bazel mobile-install --adb_arg=-s --adb_arg=deadbeef
invoca adb
como
adb -s deadbeef install ...
--incremental_install_verbosity=number
O nível de detalhes da instalação incremental. Defina como 1 para que os registros de depuração sejam impressos no console.
dump
O comando dump
imprime um despejo do
estado interno do servidor Bazel em stdout. Esse comando é destinado
principalmente a desenvolvedores do Bazel. Portanto, a saída dele
não é especificada e está sujeita a alterações.
Por padrão, o comando apenas imprime a mensagem de ajuda que descreve as possíveis opções para despejar áreas específicas do estado do Bazel. Para despejar o estado interno, pelo menos uma das opções precisa ser especificada.
As seguintes opções são aceitas:
--action_cache
despeja o conteúdo do cache da ação.--packages
despeja o conteúdo do cache do pacote.--skyframe
faz o despejo de estado do gráfico de dependências interno do Bazel.--rules
descarta o resumo de cada regra e classe de aspecto, incluindo contagens e contagens de ações. Isso inclui regras nativas e do Starlark. Se o rastreamento de memória estiver ativado, o consumo de memória das regras também será mostrado.--skylark_memory
despeja um arquivo .gz compatível com pprof para o caminho especificado. É necessário ativar o rastreamento de memória para que isso funcione.
Monitoramento de memória
Alguns comandos dump
exigem rastreamento de memória. Para ativar esse recurso, você precisa transmitir
flags de inicialização para o Bazel:
--host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar
--host_jvm_args=-DRULE_MEMORY_TRACKER=1
O java-agent foi verificado no Bazel em
third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar
. Portanto, ajuste $BAZEL
para onde você mantém o repositório do Bazel.
Continue passando essas opções para o Bazel para cada comando, ou o servidor será reiniciado.
Exemplo:
% 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
O comando analyze-profile
analisa um
perfil de rastreamento JSON coletado
durante uma invocação do Bazel.
canonicalize-flags
O comando canonicalize-flags
, que usa uma lista de opções para um comando do Bazel e retorna uma lista de opções com o mesmo efeito. A nova lista de opções é canônica. Por exemplo,
duas listas de opções com o mesmo efeito são canonizadas na mesma lista nova.
A opção --for_command
pode ser usada para selecionar comandos diferentes. No momento, só há suporte para build
e test
. As opções não aceitas pelo comando fornecido causam um erro.
Como exemplo:
% bazel canonicalize-flags -- --config=any_name --test_tag_filters="-lint" --config=any_name --test_tag_filters=-lint
Opções de inicialização
As opções descritas nesta seção afetam a inicialização da máquina virtual Java usada pelo processo do servidor Bazel e se aplicam a todos os comandos subsequentes processados por esse servidor. Se houver um servidor Bazel já em execução e as opções de inicialização não corresponderem, ele será reiniciado.
Todas as opções descritas nesta seção precisam ser especificadas usando a
sintaxe
--key=value
ou --key value
. Além disso, essas opções precisam aparecer antes do nome do comando
do Bazel. Use startup --key=value
para listá-los em um arquivo .bazelrc
.
--output_base=dir
Essa opção requer um argumento de caminho, que precisa especificar um diretório gravável. O Bazel vai usar esse local para gravar toda a saída. A base de saída também é a chave pela qual o cliente localiza o servidor do Bazel. Ao alterar a base de saída, você altera o servidor que processará o comando.
Por padrão, a base de saída é derivada do nome de login do usuário e do nome do diretório do espaço de trabalho (na verdade, o resumo MD5). Portanto, um valor típico é semelhante a este: /var/tmp/google/_bazel_johndoe/d41d8cd98f00b204e9800998ecf8427e
.
Exemplo:
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
Nesse comando, os dois comandos do Bazel são executados simultaneamente (por causa do
operador &
do shell), cada um usando uma instância do servidor
do Bazel diferente (por causa das diferentes bases de saída).
Por outro lado, se a base de saída padrão fosse usada nos dois comandos,
as duas solicitações seriam enviadas ao mesmo servidor, que as processaria
sequencialmente: criando primeiro //foo
e depois
um build incremental de //bar
.
--output_user_root=dir
Aponta para o diretório raiz onde as bases de saída e instalação são criadas. O diretório não pode existir ou ser de propriedade do usuário que fez a chamada. Antes, isso podia apontar para um diretório compartilhado entre vários usuários, mas não é mais permitido. Isso poderá ser permitido depois que o problema 11100 for resolvido.
Se a opção --output_base
for especificada, ela vai substituir
o uso de --output_user_root
para calcular a base de saída.
O local da base instalada é calculado com base em
--output_user_root
, além da identidade MD5 dos binários incorporados
do Bazel.
Você pode usar a opção --output_user_root
para escolher um
local de base alternativo para todas as saídas do Bazel (base de instalação e
de saída) se houver um local melhor no layout do sistema de arquivos.
--server_javabase=dir
Especifica a máquina virtual Java em que o Bazel é executado. O valor precisa ser um caminho para o diretório que contém um JDK ou JRE. Ele não deve ser um rótulo. Essa opção precisa aparecer antes de qualquer comando do Bazel, por exemplo:
% bazel --server_javabase=/usr/local/buildtools/java/jdk11 build //foo
Essa sinalização não afeta as JVMs usadas pelos subprocessos do Bazel, como aplicativos, testes, ferramentas e assim por diante. Use as opções de build --javabase ou --host_javabase.
Essa sinalização era chamada anteriormente de --host_javabase
(às vezes chamada de --host_javabase
do lado esquerdo), mas foi renomeada para evitar confusão com a sinalização de build --host_javabase (às vezes chamada de --host_javabase
do lado direito).
--host_jvm_args=string
Especifica uma opção de inicialização a ser passada para a máquina virtual Java em que o próprio Bazel é executado. Isso pode ser usado para definir o tamanho da pilha, por exemplo:
% bazel --host_jvm_args="-Xss256K" build //foo
Essa opção pode ser usada várias vezes com argumentos individuais. Observe que a definição dessa sinalização raramente será necessária. Também é possível transmitir uma lista de strings separada por espaços, cada uma interpretada como um argumento da JVM separado, mas esse recurso será descontinuado em breve.
Isso não afeta nenhuma JVMs usadas por
subprocessos do Bazel: aplicativos, testes, ferramentas e assim por diante. Para transmitir
opções de JVM para programas Java executáveis, executados por bazel
run
ou na linha de comando, use
o argumento --jvm_flags
, que
todos os programas java_binary
e java_test
oferecem suporte. Como alternativa para testes, use bazel test --test_arg=--jvm_flags=foo ...
.
--host_jvm_debug
Essa opção faz com que a máquina virtual Java aguarde uma conexão de um depurador compatível com JDWP antes de chamar o método principal do próprio Bazel. Esse recurso é destinado principalmente aos desenvolvedores do Bazel.
--autodetect_server_javabase
Essa opção faz com que o Bazel pesquise automaticamente um JDK instalado na inicialização
e retorne ao JRE instalado se o incorporado não estiver disponível.
--explicit_server_javabase
pode ser usado para escolher um JRE explícito para
executar o Bazel.
--batch
O modo em lote faz com que o Bazel não use o modo padrão de cliente/servidor, mas executa um processo Bazel Java para um único comando, que foi usado para semânticas mais previsíveis no que diz respeito ao tratamento de sinais, controle de jobs e herança de variável de ambiente e é necessário para executar o Bazel em uma jail chroot.
O modo de lote mantém a semântica de filas adequada dentro da mesma output_base. Ou seja, as invocações simultâneas serão processadas em ordem, sem sobreposição. Se um Bazel no modo de lote for executado em um cliente com um servidor em execução, ele primeiro elimina o servidor antes de processar o comando.
O Bazel é executado mais lentamente no modo de lote ou com as alternativas descritas acima. Isso ocorre porque, entre outras coisas, o cache do arquivo de build reside na memória. Portanto, ele não é preservado entre invocações em lote sequenciais. Portanto, o uso do modo em lote geralmente faz mais sentido nos casos em que o desempenho é menos crítico, como em builds contínuos.
--max_idle_secs=n
Essa opção especifica quanto tempo, em segundos, o processo do servidor do Bazel deve aguardar após a última solicitação do cliente antes de ser encerrado. O
valor padrão é 10.800 (3 horas). --max_idle_secs=0
fará com que o processo do servidor Bazel persista indefinidamente.
Essa opção pode ser usada por scripts que invocam o Bazel para garantir que
eles não deixem processos do servidor do Bazel na máquina de um usuário quando
não estariam em execução de outra forma.
Por exemplo, um script de pré-envio pode querer
invocar bazel query
para garantir que a mudança pendente de um usuário
não introduza dependências indesejadas. No entanto, se o usuário não tiver feito uma compilação recente nesse espaço de trabalho, não será desejável que o script de pré-envio inicie um servidor Bazel apenas para que ele permaneça inativo pelo resto do dia.
Ao especificar um pequeno valor de --max_idle_secs
na solicitação de consulta, o script pode garantir que, if ele tenha causado a inicialização de um novo servidor, esse servidor será encerrado imediatamente. No entanto, se já houver um servidor em execução, esse servidor continuará em execução até ficar inativo pelo tempo normal. Obviamente, o timer de inatividade do servidor atual será redefinido.
--[no]shutdown_on_low_sys_mem
Se ativado e --max_idle_secs
estiver definido com uma duração positiva,
depois que o servidor de build ficar inativo por um tempo, encerre o servidor quando o sistema estiver
com pouca memória. Somente no Linux.
Além de executar uma verificação de inatividade correspondente a max_idle_secs, o servidor de compilação começará a monitorar a memória disponível do sistema depois que o servidor ficar inativo por algum tempo. Se a memória disponível do sistema ficar criticamente baixa, o servidor será fechado.
--[no]block_for_lock
Se ativado, o Bazel espera que outros comandos que contenham o bloqueio do servidor sejam concluídos antes de progredir. Se desativada, o Bazel vai sair com erro caso não consiga adquirir o bloqueio imediatamente e continuar.
Os desenvolvedores podem usar isso nas verificações de pré-envio para evitar longas esperas causadas por outro comando do Bazel no mesmo cliente.
--io_nice_level=n
Define um nível de 0 a 7 para a programação de E/S de melhor esforço. 0 é a prioridade mais alta, 7 é a menor. O programador previsto só pode honrar até a prioridade 4. Valores negativos são ignorados.
--batch_cpu_scheduling
Usar a programação de CPU batch
para o Bazel. Essa política é útil para
cargas de trabalho que não são interativas, mas não querem diminuir o valor adequado delas.
Consulte "man 2 sched_setscheduler". Essa política pode melhorar a interatividade
do sistema em detrimento da capacidade de processamento do Bazel.
Opções diversas
--[no]announce_rc
Controla se o Bazel anuncia as opções de comando lidas do arquivo do Bazel na inicialização. (As opções de inicialização são anunciadas incondicionalmente.)
--color (yes|no|auto)
Essa opção determina se o Bazel vai usar cores para destacar a saída na tela.
Se esta opção for definida como yes
, a saída de cor será ativada.
Se essa opção for definida como auto
, o Bazel usará a saída de cor somente se a saída estiver sendo enviada para um terminal e a variável de ambiente TERM estiver definida como um valor diferente de dumb
, emacs
ou xterm-mono
.
Se essa opção for definida como no
, a saída de cor será desativada, independentemente da saída ser para um terminal e da configuração da variável de ambiente TERM.
--config=name
Seleciona uma seção de configuração extra dos
arquivos rc. Para o command
atual,
ele também extrai as opções de command:name
, se essa seção existir. Pode ser
especificado várias vezes para adicionar sinalizações de várias seções de configuração. As expansões podem se referir a outras
definições (por exemplo, as expansões podem ser encadeadas).
--curses (yes|no|auto)
Essa opção determina se o Bazel vai usar controles de cursor
na saída da tela. Isso resulta em menos dados de rolagem e um fluxo de saída
do Bazel mais compacto e fácil de ler. Isso funciona bem com
--color
.
Se esta opção for definida como yes
, o uso dos controles do cursor será ativado.
Se esta opção for definida como no
, o uso dos controles do cursor será desativado.
Se essa opção for definida como auto
, o uso dos controles de cursor será
ativado nas mesmas condições que para --color=auto
.
--[no]show_timestamps
Se especificado, um carimbo de data/hora é adicionado a cada mensagem gerada pelo Bazel especificando o horário em que a mensagem foi exibida.