doc: Add vendor filter for hw feature generation #89344
Conversation
The hw feature generation takes a long time. The HW_FEATURES_TURBO_MODE option completely disables hw feature generation. Add a new option HW_FEATURES_VENDOR_FILTER to be able to selectively enable hw feature generation only for a given list of vendors. This option is useful when working on board documentation pages. Signed-off-by: Aksel Skauge Mellbye <[email protected]>
asmellby
force-pushed
the
feature/doc-hw-feature-vendor-filter
branch
from
047f6da to
b0b2311
Compare
There was a problem hiding this comment.
will need to do a full review so just a random comment for now. Looks neat and very complete - thanks much for this!
You basically beat me to opening this PR as I had this on my backlog pretty much since the feature shipped and have been playing with hardcoded --vendor filters ever since :)
| if vendor_filter: | ||
| for vendor in vendor_filter: | ||
| twister_cmd += ["--vendor", vendor] |
There was a problem hiding this comment.
I think I'd rather have it be used in lieu of --all, when a filter has been provided, as it supersedes it anyway
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new configuration option for selectively enabling hardware feature generation for a specified list of vendors, which improves performance when generating board documentation.
- Introduces the zephyr_hw_features_vendor_filter configuration in conf.py.
- Updates run_twister_cmake_only and get_catalog to utilize the vendor filter during board catalog generation.
- Registers the new configuration option in the Sphinx domain extension.
Reviewed Changes
Copilot reviewed 3 out of 7 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| doc/conf.py | Adds a new configuration variable to control vendor-based filtering |
| doc/_scripts/gen_boards_catalog.py | Modifies functions to accept and pass the vendor_filter parameter |
| doc/_extensions/zephyr/domain/init.py | Updates Sphinx configuration to include the new vendor filter option |
Files not reviewed (4)
- doc/CMakeLists.txt: Language not supported
- doc/Makefile: Language not supported
- doc/contribute/documentation/generation.rst: Language not supported
- doc/contribute/documentation/guidelines.rst: Language not supported
The hw feature generation takes a long time. The HW_FEATURES_TURBO_MODE option completely disables hw feature generation. Add a new option HW_FEATURES_VENDOR_FILTER to be able to selectively enable hw feature generation only for a given list of vendors. This option is useful when working on board documentation pages.