bazelrc 구성 파일 작성

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
문제 신고 소스 보기

Bazel은 다양한 옵션을 허용합니다. 일부 옵션은 자주 다양하며(예: --subcommands) 다른 옵션은 여러 빌드(예: --package_path)에서 동일하게 유지됩니다. 모든 빌드(및 기타 명령어)에 이러한 변경되지 않은 옵션을 지정하지 않으려면 구성 파일(.bazelrc)에 옵션을 지정하면 됩니다.

.bazelrc 파일은 어디에 있나요?

Bazel은 다음 위치에서 아래 표시된 순서대로 선택적 구성 파일을 찾습니다. 옵션은 이 순서대로 해석되므로, 충돌이 발생하는 경우 이후 파일의 옵션이 이전 파일의 값을 재정의할 수 있습니다. 이러한 파일 중 어느 것을 로드할지 제어하는 모든 옵션은 시작 옵션입니다. 즉, bazel 이후 및 명령어(build, test 등) 전에 진행해야 합니다.

  1. 시스템 RC 파일(--nosystem_rc이 없는 경우)

    경로:

    • Linux/macOS/Unixes: /etc/bazel.bazelrc
    • Windows의 경우: %ProgramData%\bazel.bazelrc

    파일이 존재하지 않으면 오류가 아닙니다.

    다른 시스템 지정 위치가 필요한 경우 //src/main/cpp:option_processor에서 BAZEL_SYSTEM_BAZELRC_PATH 값을 재정의하여 커스텀 Bazel 바이너리를 빌드해야 합니다. 시스템 지정 위치에는 Unix의 ${VAR_NAME} 또는 Windows의 %VAR_NAME%과 같은 환경 변수 참조가 포함될 수 있습니다.

  2. Workspace RC 파일(--noworkspace_rc이 없는 경우)

    경로: 작업공간 디렉터리의 .bazelrc (기본 WORKSPACE 파일 옆)

    파일이 존재하지 않으면 오류가 아닙니다.

  3. 홈 RC 파일(--nohome_rc이 없는 경우)

    경로:

    • Linux/macOS/Unixes: $HOME/.bazelrc
    • Windows의 경우: %USERPROFILE%\.bazelrc(있는 경우) 또는 %HOME%/.bazelrc

    파일이 존재하지 않으면 오류가 아닙니다.

  4. 사용자 지정 RC 파일(--bazelrc=file로 지정된 경우)

    이 플래그는 선택사항이지만 여러 번 지정될 수도 있습니다.

    /dev/null는 모든 추가 --bazelrc가 무시됨을 나타내며, 이는 출시 빌드에서와 같이 사용자 rc 파일의 검색을 사용 중지하는 데 유용합니다.

    예를 들면 다음과 같습니다.

    --bazelrc=x.rc --bazelrc=y.rc --bazelrc=/dev/null --bazelrc=z.rc
    
    • x.rcy.rc를 읽습니다.
    • 이전 /dev/null로 인해 z.rc은 무시됩니다.

이 선택적 구성 파일 외에도 Bazel은 전역 rc 파일을 찾습니다. 자세한 내용은 전역 bazelrc 섹션을 참조하세요.

.bazelrc 구문 및 시맨틱스

모든 UNIX 'rc' 파일과 마찬가지로 .bazelrc 파일은 행 기반 문법이 포함된 텍스트 파일입니다. # (주석)로 시작하는 빈 줄과 줄은 무시됩니다. 각 줄에는 단어 셸이 포함되며, 이러한 단어는 본 셸과 동일한 규칙에 따라 토큰화됩니다.

가져오기

import 또는 try-import로 시작하는 줄은 특수합니다. 이러한 줄을 사용하여 다른 'rc' 파일을 로드합니다. 작업공간 루트를 기준으로 경로를 지정하려면 import %workspace%/path/to/bazelrc를 작성합니다.

importtry-import의 차이점은 import된 파일이 누락되거나 읽을 수 없는 경우 Bazel이 실패한다는 점입니다. 하지만 try-import된 파일에서는 누락되지 않습니다.

가져오기 우선순위:

  • 가져온 파일의 옵션이 import 문 앞에 지정된 옵션보다 우선 적용됩니다.
  • import 문 다음에 지정된 옵션이 가져온 파일의 옵션보다 우선 적용됩니다.
  • 나중에 가져오는 파일의 옵션이 이전에 가져온 파일에 우선합니다.

옵션 기본값

bazelrc의 줄 대부분은 기본 옵션 값을 정의합니다. 각 행의 첫 번째 단어는 이러한 기본값이 적용되는 시기를 지정합니다.

  • startup: 명령어 앞에 오는 시작 옵션이며 bazel help startup_options에 설명되어 있습니다.
  • common: 모든 Bazel 명령어에 적용되는 옵션입니다.
  • command: 옵션이 적용되는 Bazel 명령어(예: build 또는 query). 이러한 옵션은 지정된 명령어에서 상속받은 모든 명령어에도 적용됩니다. 예를 들어 testbuild에서 상속됩니다.

각 줄은 두 번 이상 사용할 수 있으며 첫 번째 단어 다음에 오는 인수는 한 줄에 표시된 것처럼 결합됩니다. ('스위스 군대 칼' 명령줄 인터페이스를 사용하는 또 다른 도구인 CVS 사용자는 구문과 유사한 구문을 .cvsrc에서 찾을 수 있습니다.) 예를 들면 다음과 같습니다.

build --test_tmpdir=/tmp/foo --verbose_failures
build --test_tmpdir=/tmp/bar

다음과 같이 결합됩니다.

build --test_tmpdir=/tmp/foo --verbose_failures --test_tmpdir=/tmp/bar

따라서 유효한 플래그는 --verbose_failures--test_tmpdir=/tmp/bar입니다.

옵션 우선순위:

  • 명령줄의 옵션은 항상 RC 파일의 옵션보다 우선합니다. 예를 들어 rc 파일이 build -c opt인데 명령줄 플래그가 -c dbg이면 명령줄 플래그가 우선 적용됩니다.
  • rc 파일 내에서 우선순위는 구체성에 따라 달라집니다. 더 구체적인 명령어의 행이 덜 구체적인 명령어의 행보다 우선합니다.

    특이성은 상속으로 정의됩니다. 일부 명령어는 다른 명령어의 옵션을 상속하므로, 상속 명령어가 기본 명령어보다 더 구체적입니다. 예를 들어 testbuild 명령어에서 상속되므로 모든 bazel build 플래그는 bazel test에 유효하고 동일한 build에 관한 test 줄이 없으면 모든 build 줄이 bazel test에도 적용됩니다. rc 파일의 내용은 다음과 같습니다.

    test -c dbg --test_env=PATH
    build -c opt --verbose_failures
    

    그러면 bazel build //foo-c opt --verbose_failures를 사용하고 bazel test //foo--verbose_failures -c dbg --test_env=PATH를 사용합니다.

    상속 (특이도) 그래프는 다음과 같습니다.

    • 모든 명령어는 common에서 상속됩니다.
    • 다음 명령어는 build에서 상속되고 더 구체적입니다. build: test, run, clean, mobile-install, info, print_action, config, cquery, aquery
    • coveragetest에서 상속됨
  • 같은 구체적인 옵션에 대해 동일한 명령어에 대한 옵션을 지정하는 두 줄은 파일 내에 표시된 순서대로 파싱됩니다.

  • 이 우선순위 규칙은 파일 순서와 일치하지 않으므로 rc 파일 내의 우선순위 순서를 따르는 경우 가독성을 높이는 데 도움이 됩니다. 즉, 맨 위에 있는 common 옵션으로 시작하고 파일 하단에 가장 구체적인 명령어로 끝납니다. 이렇게 하면 옵션을 읽는 순서가 옵션이 적용되는 순서와 동일하므로 더 직관적입니다.

rc 파일의 한 줄에 지정된 인수에 빌드 타겟의 이름과 같은 옵션이 아닌 인수가 포함될 수 있습니다. 이러한 파일은 동일한 파일에 지정된 옵션과 같이 명령줄의 동위 요소보다 우선순위가 낮으며 항상 옵션이 아닌 명시적 인수 목록 앞에 추가됩니다.

--config

옵션 기본값을 설정하는 것 외에도 rc 파일을 사용하여 옵션을 그룹화하고 일반적인 그룹화를 간단히 처리할 수 있습니다. 명령어에 :name 접미사를 추가하면 됩니다. 이러한 옵션은 기본적으로 무시됩니다. 하지만 --config=name 옵션이 명령줄이나 .bazelrc 파일에 있으면 다른 구성 정의 내에서 재귀적으로도 포함됩니다. command:name으로 지정된 옵션은 적용 가능한 명령어에 대해서만 위에서 설명한 우선순위에 따라 확장됩니다.

--config=foo는 구성에 지정된 옵션의 우선순위가 --config=foo 옵션과 같도록 '제자리에' rc 파일에 정의된 옵션으로 확장됩니다.

이 구문은 startup를 사용하여 시작 옵션을 설정하지는 않습니다. .bazelrc에서 startup:config-name --some_startup_option 설정은 무시됩니다.

다음은 ~/.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

Bazel의 동작을 제어하는 기타 파일

.bazelignore

Bazel이 무시하길 원하는 디렉터리(예: 다른 빌드 시스템을 사용하는 관련 프로젝트)를 지정할 수 있습니다. 작업공간의 루트에 .bazelignore 파일을 배치하고 Bazel이 무시하려는 디렉터리를 한 줄에 하나씩 추가합니다. 항목은 작업공간 루트를 기준으로 합니다.

전역 bazelrc 파일

Bazel은 이 순서로 선택적 bazelrc 파일을 읽습니다.

  1. 시스템 rc-file이 etc/bazel.bazelrc에 있습니다.
  2. $workspace/tools/bazel.rc에 있는 Workspace rc-file입니다.
  3. $HOME/.bazelrc에 있는 가정용 RC 파일

여기에 나열된 각 bazelrc 파일에는 파일을 사용 중지하는 데 사용할 수 있는 해당 플래그 (예: --nosystem_rc, --noworkspace_rc, --nohome_rc)가 있습니다. 또한 --ignore_all_rc_files 시작 옵션을 전달하여 Bazel이 모든 bazelrcs를 무시하도록 할 수도 있습니다.