Skip to content

[Nexthop] Document build type options#842

Closed
anna-nexthop wants to merge 2 commits intofacebook:mainfrom
nexthop-ai:anna-nexthop.build-type-documentation
Closed

[Nexthop] Document build type options#842
anna-nexthop wants to merge 2 commits intofacebook:mainfrom
nexthop-ai:anna-nexthop.build-type-documentation

Conversation

@anna-nexthop
Copy link
Contributor

@anna-nexthop anna-nexthop commented Jan 26, 2026

Pre-submission checklist

  • I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running pip install -r requirements-dev.txt && pre-commit install
  • pre-commit run

Summary

Document the --build-type option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

  • docs/docs/build/Building_FBOSS_on_containers.md: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option

  • docs/docs/platform/Building_Platform_Services.md: Updated build commands to use --build-type flag

  • docs/static/code_snips/*.sh: Updated all build script examples to use --build-type instead of passing CMAKE_BUILD_TYPE in --extra-cmake-defines

  • Updated the --build-type help text in run-getdeps.py to include:

    • Concise descriptions of each build type
    • Indication that RelWithDebInfo is the default
    • Removed the outdated "widely supported" comment
  • Created a shared BUILD_TYPE_ARG kwargs dictionary to define the --build-type argument once

  • Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes

  • Reduced code duplication and improved maintainability

  • Users now understand what each build type does

  • Cleaner syntax: --build-type MinSizeRel vs JSON in --extra-cmake-defines

  • Single source of truth for the argument definition

  • Easier to maintain and update in the future

Verified that help output works correctly for all three commands:

  • build --help
  • test --help
  • generate-github-actions --help

Test Plan

Visually inspected a local serve of the documentation
image

image

@kevin645
Copy link

Can I get a rebase on this one?

@KevinYakar
Copy link
Contributor

Hi @anna-nexthop can you please rebase and change all instances of getdeps.py to run-getdeps.py as found here. Thank you!

This PR documents the `--build-type` option for the getdeps.py build
script and refactors the argument definition to eliminate code
duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added
comprehensive documentation about build types (Debug, Release,
RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build
commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to
use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in
`--extra-cmake-defines`

- Updated the `--build-type` help text in getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the
`--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd,
and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in
`--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

Visually inspected a local serve of the documentation

for instructions)
<img width="989" height="594" alt="image"
src="https://github.com/user-attachments/assets/8ef42b88-a564-4ba1-8219-51e366a4d171"
/>

<img width="989" height="594" alt="image"
src="https://github.com/user-attachments/assets/1e9709ef-2cb8-4432-a236-96986bfc2588"
/>
@facebook-github-bot
Copy link
Contributor

@anna-nexthop has updated the pull request. You must reimport the pull request before landing.

@anna-nexthop anna-nexthop force-pushed the anna-nexthop.build-type-documentation branch from 8ff0dc6 to db5a3aa Compare February 23, 2026 18:25
@facebook-github-bot
Copy link
Contributor

@anna-nexthop has updated the pull request. You must reimport the pull request before landing.

@anna-nexthop
Copy link
Contributor Author

@kevin645 @KevinYakar Rebased, adjusted the references to the new run-getdeps.py script, visually inspected a local serve of the documents, and updated the screenshots in the PR description.

@meta-codesync
Copy link

meta-codesync bot commented Feb 23, 2026

@KevinYakar has imported this pull request. If you are a Meta employee, you can view this in D93010077.

@KevinYakar
Copy link
Contributor

@kevin645 @KevinYakar Rebased, adjusted the references to the new run-getdeps.py script, visually inspected a local serve of the documents, and updated the screenshots in the PR description.

Sorry, I realize --build-type is for getdeps.py, not the new build wrapper. Since I have already imported I will fix this and merge it. Thanks for rebasing and making the requested changes!

meta-codesync bot pushed a commit to facebookincubator/cinderx that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/watchman that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/openr that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebookexperimental/edencommon that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebookexperimental/moxygen that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebookincubator/katran that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/wangle that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/CacheLib that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebookincubator/hsthrift that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/fb303 that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/mvfst that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebookexperimental/rust-shed that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
@meta-codesync meta-codesync bot closed this in db72315 Feb 23, 2026
meta-codesync bot pushed a commit to facebook/folly that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/proxygen that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
@meta-codesync
Copy link

meta-codesync bot commented Feb 23, 2026

@KevinYakar merged this pull request in db72315.

meta-codesync bot pushed a commit to facebookincubator/fizz that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/hhvm that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/fbthrift that referenced this pull request Feb 23, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
meta-codesync bot pushed a commit to facebook/sapling that referenced this pull request Feb 24, 2026
Summary:
**Pre-submission checklist**
- [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install`
- [x] `pre-commit run`

Document the `--build-type` option for the run-getdeps.py build script and refactor the argument definition to eliminate code duplication.

- **docs/docs/build/Building_FBOSS_on_containers.md**: Added comprehensive documentation about build types (Debug, Release, RelWithDebInfo, MinSizeRel) with a table explaining each option
- **docs/docs/platform/Building_Platform_Services.md**: Updated build commands to use `--build-type` flag
- **docs/static/code_snips/*.sh**: Updated all build script examples to use `--build-type` instead of passing `CMAKE_BUILD_TYPE` in `--extra-cmake-defines`

- Updated the `--build-type` help text in run-getdeps.py to include:
  - Concise descriptions of each build type
  - Indication that RelWithDebInfo is the default
  - Removed the outdated "widely supported" comment

- Created a shared `BUILD_TYPE_ARG` kwargs dictionary to define the `--build-type` argument once
- Replaced three duplicate argument definitions in BuildCmd, TestCmd, and GenerateGithubActionsCmd classes
- Reduced code duplication and improved maintainability

- Users now understand what each build type does
- Cleaner syntax: `--build-type MinSizeRel` vs JSON in `--extra-cmake-defines`
- Single source of truth for the argument definition
- Easier to maintain and update in the future

Verified that help output works correctly for all three commands:
- `build --help`
- `test --help`
- `generate-github-actions --help`

X-link: facebook/fboss#842

Reviewed By: joseph5wu

Differential Revision: D93010077

Pulled By: KevinYakar

fbshipit-source-id: d1a0b780c28e8f8fa5ca716326fbcadb244ade87
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants