Skip to content
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

doc: coding_guidelines: replace a whitelist replacement #33228

Merged

Conversation

mbolivar-nordic
Copy link
Contributor

@mbolivar-nordic mbolivar-nordic commented Mar 11, 2021

Nothing in the tree is using the "passlist" term in the "blocklist /
passlist" pair. However, west is using "blocklist / allowlist" already in a
released version.

Recommend blocklist/allowlist instead of blocklist/passlist to avoid
having to add yet another possible replacement, since nothing is using
passlist right now.

Note that blocklist/allowlist is in widespread use throughout many
projects, including Chrome.

Signed-off-by: Martí Bolívar [email protected]

Nothing in the tree is using the "passlist" term in the "blocklist /
passlist" pair. However, west is using "blocklist / allowlist" already
in a released version.

Recommend blocklist/allowlist instead of blocklist/passlist to avoid
having to add yet another possible replacement, since nothing is using
passlist right now.

Note that blocklist/allowlist is in widespread use throughout many
projects, including Chrome.

Signed-off-by: Martí Bolívar <[email protected]>
@mbolivar-nordic
Copy link
Contributor Author

Another reason to prefer allowlist to passlist is that allowlist has the same number of characters as whitelist, so it doesn't affect alignment if you do a big search and replace.

Copy link
Member

@carlescufi carlescufi left a comment

Choose a reason for hiding this comment

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

Not only is allowlist more understandable, but as @mbolivar-nordic says, we are already exposing our users to this particular term in west.

@pabigot
Copy link
Collaborator

pabigot commented Mar 11, 2021

Since I started this firestorm in #29498 (review) I'm just going to respond to #29498 (comment) here then move on:

Zephyr doesn't use blocklist.

That was not intended as a statement of policy; it was an insufficiently clear statement of fact: the term blocklist appears in Zephyr mainline only in the west guide documentation and when paired with "passlist". It has not yet been used in Zephyr RTOS code.

You're saying "Zephyr" but I disagree with whoever in the community ruled this out, and the fact that west is already using these terms de facto means they're going to be used by Zephyr users. So I stand firm on keeping them.

That's fine. My position was we had three perfectly adequate names, where the positive and negative verbs are natural antonyms: "allow/deny", "pass/block", and "accept/reject".

I don't find "allow/block" to be a natural pairing. I also am tired of all the bikeshed discussions, and figured that since for this case we actually had a documented set of recommended names it was reasonable to propose sticking with them rather than introducing yet another arguably gratuitous variation.

I don't like changing the list to replace pass/block with allow/block, but if that's how people want to go it's fine. But I don't feel any professional or moral obligation to approve such a change.

@mbolivar-nordic
Copy link
Contributor Author

I don't find "allow/block" to be a natural pairing. I also am tired of all the bikeshed discussions, and figured that since for this case we actually had a documented set of recommended names it was reasonable to propose sticking with them rather than introducing yet another arguably gratuitous variation.

Given that nobody is using 'passlist', I think that is rather precisely what this PR is doing.

@nashif nashif merged commit 85b6a28 into zephyrproject-rtos:master Mar 12, 2021
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