Skip to content

doc: _extensions: kconfig: add :kconfig:option-regex: role #90681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 3, 2025

Conversation

kartben
Copy link
Collaborator

@kartben kartben commented May 27, 2025

Allow users to create links to Kconfig regex searches. The new role generates links to the Kconfig search page with the regex pattern as the search query.

Fixes #90571

doc for the new role and demo of it in action: https://builds.zephyrproject.io/zephyr/pr/90681/docs/contribute/documentation/guidelines.html#role-kconfig-option-regex

image

@kartben kartben force-pushed the fix_90571 branch 3 times, most recently from e18a4ee to e96017c Compare May 27, 2025 16:28
@kartben kartben requested a review from tomi-font May 27, 2025 16:29
@kartben kartben marked this pull request as ready for review May 27, 2025 16:29
@github-actions github-actions bot requested review from carlescufi, gmarull and nashif May 27, 2025 16:30
@kartben kartben self-assigned this May 27, 2025
Copy link
Collaborator

@tomi-font tomi-font left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for implementing this! Didn't check the code, but the documentation looks (almost) good.
Would you mind at the same time updating the following to use the new role:

``CONFIG_SECURE_STORAGE_.*`` Kconfig options. They are defined in the various Kconfig files found

Have a look at the ``CONFIG_SECURE_STORAGE_ITS_(STORE|TRANSFORM)_.*_CUSTOM``

kartben added 2 commits May 28, 2025 09:59
Allow users to create links to Kconfig regex searches.
The new role generates links to the Kconfig search page with the regex
pattern as the search query.

Fixes zephyrproject-rtos#90571

Signed-off-by: Benjamin Cabé <[email protected]>
Revised the documentation for PSA Secure Storage API configuration to
use the new :kconfig:option-regex: role for Kconfig options.

Signed-off-by: Benjamin Cabé <[email protected]>
@kartben kartben requested a review from tomi-font May 28, 2025 08:51
@github-actions github-actions bot added area: Secure Storage Secure Storage area: Storage Storage subsystem labels May 28, 2025
Copy link
Collaborator

@tomi-font tomi-font left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

@zephyrproject-rtos zephyrproject-rtos deleted a comment from sonarqubecloud bot May 28, 2025
@kartben kartben requested review from Thalley and pdgendt June 2, 2025 18:08
@kartben kartben merged commit b751bc0 into zephyrproject-rtos:main Jun 3, 2025
21 checks passed
@kartben kartben deleted the fix_90571 branch June 3, 2025 15:26
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.

Sphinx role for Kconfig regexes
4 participants