Skip to content

✨ Add typo detection/fixing for string generation #722

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

✨ Add typo detection/fixing for string generation #722

wants to merge 2 commits into from

Conversation

elbeno
Copy link
Contributor

@elbeno elbeno commented Apr 16, 2025

Problem:

  • Stable strings can be fixed not just to be consistent from one build to the next, but because hardware expects certain string IDs or ranges. Accidentally having a string in code with a typo could result in another string ID being generated, with unfortunate results.

Solution:

  • Allow typos to be detected and fixed.

@elbeno elbeno force-pushed the string-typo-detection branch from 3e6ff88 to b7a4757 Compare April 16, 2025 17:07
@elbeno
✨ Add typo detection/fixing for string generation
e21c5e2 
Problem:
- Stable strings can be fixed not just to be consistent from one build to the
  next, but because hardware expects certain string IDs or ranges. Accidentally
  having a string in code with a typo could result in another string ID being
  generated, with unfortunate results.

Solution:
- Allow typos to be detected and fixed.
@elbeno elbeno force-pushed the string-typo-detection branch from b7a4757 to e21c5e2 Compare April 16, 2025 17:14
lukevalenty
lukevalenty reviewed Apr 18, 2025
View reviewed changes
Copy link
Contributor

@lukevalenty lukevalenty left a comment

Choose a reason for hiding this comment

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

suggestion: i would like a stronger guarantee...like logging a message with some STABLE policy that forces the message to match a stable string or the build will fail.

@elbeno
Copy link
Contributor Author

elbeno commented Apr 18, 2025

You're saying you want an additional stable_only policy that forces every string to be in stable_strings.json?

@elbeno
✨ Add stable_only policy to gen_str_catalog.py
e17eb63 
Problem:
- If someone wants to be ultra-safe, every string should be in
  `stable_strings.json`.

Solution:
- Add a typo policy that requires every string from the code to be found in
  `stable_strings.json`.
@elbeno
Copy link
Contributor Author

elbeno commented May 9, 2025

This PR is abandoned. Typo detection doesn't really solve any problem we have in the right way.
The useful CI part is captured in #726

@elbeno elbeno closed this May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lukevalenty lukevalenty lukevalenty left review comments

@mjcaisse-intel mjcaisse-intel Awaiting requested review from mjcaisse-intel

@siauthun siauthun Awaiting requested review from siauthun

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@elbeno @lukevalenty