Skip to content

Conversation

nordicjm
Copy link
Contributor

@nordicjm nordicjm commented Oct 6, 2025

Allows checking sdk-nrf for Kconfig prompts that start with "Enable" as these should not be allowed

@rugeGerritsen
Copy link
Contributor

Why is this a no-up? Not using "Enable" should be in the style guide allowing us to upstream this commit

@rugeGerritsen
Copy link
Contributor

@nordicjm , now that you are anyways helping out adding style checks to CI, I would appreciate if you could approve #3360

@nordicjm
Copy link
Contributor Author

nordicjm commented Oct 6, 2025

Why is this a no-up? Not using "Enable" should be in the style guide allowing us to upstream this commit

It's problematic because zephyr modules do not follow this because they are external projects not zephyr-specific projects, so upon enabling it in zephyr it fails because of 3 modules and it's unlikely that they will be fixed in their upstream repos, so this has to be enabled here like this so it actually runs in sdk-nrf due to how sdk-nrf works (it is added as a zephyr module)

@rugeGerritsen
Copy link
Contributor

Why is this a no-up? Not using "Enable" should be in the style guide allowing us to upstream this commit

It's problematic because zephyr modules do not follow this because they are external projects not zephyr-specific projects, so upon enabling it in zephyr it fails because of 3 modules and it's unlikely that they will be fixed in their upstream repos, so this has to be enabled here like this so it actually runs in sdk-nrf due to how sdk-nrf works (it is added as a zephyr module)

I know I'm not maintaining this part, but I anyways want to help out with some suggestions on how to address this:

  1. Extend the commit to allow using an include- or exclude-list for modules where this check is enabled.
  2. Create a separate check in the compliance script where Kconfig files are read as text. That will ensure that we only enforce this new style check on modified files.

@nordicjm nordicjm force-pushed the fixcompmissing branch 2 times, most recently from a83004e to 4870a86 Compare October 7, 2025 10:54
@nordicjm nordicjm force-pushed the fixcompmissing branch 2 times, most recently from bb8a352 to c2b1252 Compare October 7, 2025 11:22
Allows checking sdk-nrf for Kconfig prompts that start with
"Enable" as these should not be allowed

Signed-off-by: Jamie McCrae <[email protected]>
nrf-squash! [nrf noup] scripts: ci: check_compliance: Exclude some docs

Excludes bare metal release docs from the invalid Kconfig check as
these will have old Kconfigs that have been removed

Signed-off-by: Jamie McCrae <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants