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

Add more restrictions on compatible strings #42

Merged
merged 1 commit into from
Mar 23, 2021

Conversation

sjg20
Copy link
Contributor

@sjg20 sjg20 commented Mar 23, 2021

Mostly we use lower case and we try to avoid underscores. Add a note
about this.

I believe this is just writing down the existing conventions. I have not
gone as far as using a character table (as with aliases) or specifying a
maximum length.

(this was reference at zephyrproject-rtos/zephyr#29689 (comment) )

Signed-off-by: Simon Glass sjg@chromium.org

@@ -484,6 +484,9 @@ Description:
(such as a stock ticker symbol), and ``model`` specifies the model
number.

The compatible string should consist only of lowercase letters, digits,
dashes and at most a single comma. Underscores should not be used.
Copy link
Member

Choose a reason for hiding this comment

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

I would say something like "a single comma is typically only used following a vendor prefix."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK I updated it, but please feel free to edit it to be clearer.

Mostly we use lower case and we try to avoid underscores. Add a note
about this.

I believe this is just writing down the existing conventions. I have not
gone as far as using a character table (as with aliases) or specifying a
maximum length.

Signed-off-by: Simon Glass <sjg@chromium.org>
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.

2 participants