[Nexthop] Document build type options#842
[Nexthop] Document build type options#842anna-nexthop wants to merge 2 commits intofacebook:mainfrom
Conversation
|
Can I get a rebase on this one? |
|
Hi @anna-nexthop can you please rebase and change all instances of |
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" />
72b9543 to
8ff0dc6
Compare
|
@anna-nexthop has updated the pull request. You must reimport the pull request before landing. |
8ff0dc6 to
db5a3aa
Compare
|
@anna-nexthop has updated the pull request. You must reimport the pull request before landing. |
|
@kevin645 @KevinYakar Rebased, adjusted the references to the new |
|
@KevinYakar has imported this pull request. If you are a Meta employee, you can view this in D93010077. |
Sorry, I realize |
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
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
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
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
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
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
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
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
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
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
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
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
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
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
|
@KevinYakar merged this pull request in db72315. |
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
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
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
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
Pre-submission checklist
pip install -r requirements-dev.txt && pre-commit installpre-commit runSummary
Document the
--build-typeoption 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-typeflagdocs/static/code_snips/*.sh: Updated all build script examples to use
--build-typeinstead of passingCMAKE_BUILD_TYPEin--extra-cmake-definesUpdated the
--build-typehelp text in run-getdeps.py to include:Created a shared
BUILD_TYPE_ARGkwargs dictionary to define the--build-typeargument onceReplaced 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 MinSizeRelvs JSON in--extra-cmake-definesSingle 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 --helptest --helpgenerate-github-actions --helpTest Plan
Visually inspected a local serve of the documentation
