O Bazel aceita muitas opções. Algumas opções variam com frequência (por exemplo,
--subcommands
), enquanto outras permanecem as mesmas em vários builds (como
--package_path
). Para evitar especificar essas opções inalteradas para cada build
(e outros comandos), você pode especificar as opções em um arquivo de configuração, chamado
.bazelrc
.
Onde estão os arquivos .bazelrc
?
O Bazel procura arquivos de configuração opcionais nos seguintes locais,
na ordem mostrada abaixo. As opções são interpretadas nessa ordem. Portanto, as opções em arquivos posteriores podem substituir um valor de um arquivo anterior em caso de
conflito. Todas as opções que controlam quais desses arquivos são carregados são
opções de inicialização, o que significa que elas precisam ocorrer após bazel
e
antes do comando (build
, test
etc.).
O arquivo RC do sistema, a menos que
--nosystem_rc
esteja presente.Caminho:
- No Linux/macOS/Unixes:
/etc/bazel.bazelrc
- No Windows:
%ProgramData%\bazel.bazelrc
Não haverá erro se o arquivo não existir.
Se outro local especificado pelo sistema for necessário, crie um binário do Bazel personalizado, substituindo o valor
BAZEL_SYSTEM_BAZELRC_PATH
em//src/main/cpp:option_processor
. O local especificado pelo sistema pode conter referências de variáveis de ambiente, como${VAR_NAME}
no Unix ou%VAR_NAME%
no Windows.- No Linux/macOS/Unixes:
O arquivo RC do espaço de trabalho, a menos que
--noworkspace_rc
esteja presente.Caminho:
.bazelrc
no diretório do espaço de trabalho (ao lado do arquivoWORKSPACE
principal).Não é um erro se esse arquivo não existir.
O arquivo de controle remoto da casa, a menos que
--nohome_rc
esteja presente.Caminho:
- No Linux/macOS/Unix:
$HOME/.bazelrc
- No Windows:
%USERPROFILE%\.bazelrc
, se existir, ou%HOME%/.bazelrc
Não é um erro se esse arquivo não existir.
- No Linux/macOS/Unix:
O arquivo RC especificado pelo usuário, se especificado com
--bazelrc=file
Essa flag é opcional, mas também pode ser especificada várias vezes.
/dev/null
indica que todos os outros--bazelrc
s serão ignorados, o que é útil para desativar a pesquisa de um arquivo rc do usuário, como em builds de lançamento.Exemplo:
--bazelrc=x.rc --bazelrc=y.rc --bazelrc=/dev/null --bazelrc=z.rc
x.rc
ey.rc
são lidos.z.rc
é ignorado devido ao/dev/null
anterior.
Além desse arquivo de configuração opcional, o Bazel procura um arquivo rc global. Para mais detalhes, consulte a seção "global bazelrc".
Sintaxe e semântica de .bazelrc
Como todos os arquivos "rc" do UNIX, o arquivo .bazelrc
é um arquivo de texto com uma gramática baseada em linhas. Linhas vazias e linhas que começam com #
(comentários) são ignoradas. Cada
linha contém uma sequência de palavras, que são tokenizadas de acordo com as mesmas
regras do shell Bourne.
Importações
As linhas que começam com import
ou try-import
são especiais: use-as para carregar
outros arquivos "rc". Para especificar um caminho relativo à raiz do espaço de trabalho,
digite import %workspace%/path/to/bazelrc
.
A diferença entre import
e try-import
é que o Bazel falha se o
arquivo import
estiver ausente (ou não puder ser lido), mas não para um arquivo
try-import
.
Precedência de importação:
- As opções no arquivo importado têm precedência sobre as opções especificadas antes da instrução de importação.
- As opções especificadas após a instrução de importação têm precedência sobre as opções no arquivo importado.
- As opções em arquivos importados mais tarde têm precedência sobre os arquivos importados mais cedo.
Opções padrão
A maioria das linhas de um bazelrc define valores de opções padrão. A primeira palavra em cada linha especifica quando esses padrões são aplicados:
startup
: opções de inicialização, que vão antes do comando e são descritas embazel help startup_options
.common
: opções que precisam ser aplicadas a todos os comandos do Bazel que oferecem suporte a elas. Se um comando não oferecer suporte a uma opção especificada dessa maneira, ela será ignorada, desde que seja válida para algum outro comando do Bazel. Isso se aplica apenas aos nomes de opções: se o comando atual aceitar uma opção com o nome especificado, mas não oferecer suporte ao valor especificado, ele vai falhar.always
: opções que se aplicam a todos os comandos do Bazel. Se um comando não oferecer suporte a uma opção especificada dessa maneira, ele vai falhar.command
: comando do Bazel, comobuild
ouquery
, a que as opções se aplicam. Essas opções também se aplicam a todos os comandos que herdam do comando especificado. Por exemplo,test
herda debuild
.
Cada uma dessas linhas pode ser usada mais de uma vez, e os argumentos que seguem a
primeira palavra são combinados como se tivessem aparecido em uma única linha. Os usuários do CVS,
outra ferramenta com uma interface de linha de comando "canivete suíço", vão encontrar a
sintaxe semelhante à do .cvsrc
. Por exemplo, as linhas:
build --test_tmpdir=/tmp/foo --verbose_failures
build --test_tmpdir=/tmp/bar
são combinados como:
build --test_tmpdir=/tmp/foo --verbose_failures --test_tmpdir=/tmp/bar
As flags eficazes são --verbose_failures
e --test_tmpdir=/tmp/bar
.
Precedência da opção:
- As opções na linha de comando sempre têm precedência sobre as opções nos arquivos rc.
Por exemplo, se um arquivo rc mostrar
build -c opt
, mas a flag da linha de comando for-c dbg
, a flag da linha de comando terá precedência. No arquivo rc, a precedência é regida pela especificidade: as linhas para um comando mais específico têm precedência sobre as linhas para um comando menos específico.
A especificidade é definida pela herança. Alguns comandos herdam opções de outros comandos, tornando o comando herdado mais específico que o comando base. Por exemplo,
test
herda do comandobuild
. Portanto, todas as sinalizaçõesbazel build
são válidas parabazel test
e todas as linhasbuild
também se aplicam abazel test
, a menos que haja uma linhatest
para a mesma opção. Se o arquivo rc disser:test -c dbg --test_env=PATH
build -c opt --verbose_failures
então
bazel build //foo
vai usar-c opt --verbose_failures
ebazel test //foo
vai usar--verbose_failures -c dbg --test_env=PATH
.O gráfico de herança (especificidade) é:
- Todos os comandos herdam de
common
- Os comandos a seguir herdam de (e são mais específicos do que)
build
:test
,run
,clean
,mobile-install
,info
,print_action
,config
,cquery
eaquery
. coverage
herda detest
- Todos os comandos herdam de
Duas linhas que especificam opções para o mesmo comando com a mesma especificidade são analisadas na ordem em que aparecem no arquivo.
Como essa regra de precedência não corresponde à ordem dos arquivos, ela ajuda a melhorar a legibilidade se você seguir a ordem de precedência nos arquivos rc: comece com as opções
common
na parte de cima e termine com os comandos mais específicos na parte de baixo do arquivo. Dessa forma, a ordem em que as opções são lidas é a mesma em que são aplicadas, o que é mais intuitivo.
Os argumentos especificados em uma linha de um arquivo rc podem incluir argumentos que não são opções, como nomes de destinos de build e assim por diante. Assim como as opções especificadas nos mesmos arquivos, elas têm precedência menor que os irmãos na linha de comando e são sempre adicionadas à lista explícita de argumentos sem opção.
--config
Além de definir padrões de opções, o arquivo rc pode ser usado para agrupar opções
e fornecer uma abreviação para agrupamentos comuns. Para fazer isso, adicione um sufixo :name
ao comando. Essas opções são ignoradas por padrão, mas serão
incluídas quando a opção --config=name
estiver presente,
na linha de comando ou em um arquivo .bazelrc
, de forma recursiva, mesmo dentro de
outra definição de configuração. As opções especificadas por command:name
só serão
expandidas para comandos aplicáveis, na ordem de precedência descrita acima.
--config=foo
é expandido para as opções definidas nos
arquivos rc "in-place" para que as opções
especificadas para a configuração tenham a mesma precedência que a opção --config=foo
tinha.
Essa sintaxe não se estende ao uso de startup
para definir
opções de inicialização. A configuração
startup:config-name --some_startup_option
no .bazelrc será ignorada.
Exemplo
Confira este exemplo do arquivo ~/.bazelrc
:
# Bob's Bazel option defaults
startup --host_jvm_args=-XX:-UseParallelGC
import /home/bobs_project/bazelrc
build --show_timestamps --keep_going --jobs 600
build --color=yes
query --keep_going
# Definition of --config=memcheck
build:memcheck --strip=never --test_timeout=3600
Outros arquivos que regem o comportamento do Bazel
.bazelignore
É possível especificar diretórios no espaço de trabalho que você quer que o Bazel ignore, como projetos relacionados que usam outros sistemas de compilação. Coloque um arquivo chamado
.bazelignore
na raiz do espaço de trabalho
e adicione os diretórios que você quer que o Bazel ignore, um por
linha. As entradas são relativas à raiz do espaço de trabalho.
Arquivo global do Bazel
O Bazel lê arquivos bazelrc opcionais nesta ordem:
- Arquivo rc do sistema localizado em
etc/bazel.bazelrc
. - Arquivo rc do espaço de trabalho localizado em
$workspace/tools/bazel.rc
. - Arquivo rc-inicial localizado em
$HOME/.bazelrc
Cada arquivo bazelrc listado aqui tem uma flag correspondente que pode ser usada para
desativá-los (por exemplo, --nosystem_rc
, --noworkspace_rc
, --nohome_rc
). Você também pode
fazer com que o Bazel ignore todos os arquivos bazelrc transmitindo a opção de inicialização
--ignore_all_rc_files
.