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

Classify FIXMEs #4117

Open
tgross35 opened this issue Nov 19, 2024 · 6 comments
Open

Classify FIXMEs #4117

tgross35 opened this issue Nov 19, 2024 · 6 comments
Assignees
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue.
Milestone

Comments

@tgross35
Copy link
Contributor

This is pretty easy: we have a lot of FIXMEs scattered throughout the codebase, and we want to be relatively certain that we don't miss anything important before the 1.0 release. We should try to classify any bare FIXMEs to make this easier. Suggested categories:

  • // FIXME(union): ...: something should be a union but is represented as a struct (will be fixed in 1.0), or a test that needs to be skipped because of it
  • // FIXME(musl): ...: something that should go away once we update our musl version
  • // FIXME(ctest): ...: something that doesn't work because of limitations of ctest its dependency garando_syntax
  • // FIXME(time): ...: something that needs to be adjusted relating to 64-bit time
  • // FIXME(linux), FIXME(macos), FIXME(netbsd), etc: something that will change when we update supported versions of a platform
  • // FIXME(1.0): ... anything else that needs to be addressed with a breaking change
@tgross35 tgross35 added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. labels Nov 19, 2024
@tgross35 tgross35 added this to the 1.0 milestone Nov 19, 2024
@lvllvl
Copy link
Contributor

lvllvl commented Jan 3, 2025

is this still needed?
What would be the delivery, e.g., do you want this in csv format? Or should this info be included in an existing file?

@tgross35
Copy link
Contributor Author

tgross35 commented Jan 3, 2025

Still needed! This would just be PRs to update the existing comments that are a plain // FIXME: ..., there isn't any output format needed.

The goal is just to be able to grep for something like FIXME\(.*union.*\): and find everything that we have left to clean up there.

@lvllvl
Copy link
Contributor

lvllvl commented Jan 5, 2025

Can I run these labels by you before I submit a merge request like you suggested?

I create a csv file (here's a link).

Some // FIXMEs are already labeled. All my suggested labels are in the FALSE rows.

Are my suggestions ok? Or should I make any changes?

@tgross35
Copy link
Contributor Author

tgross35 commented Jan 5, 2025

Well that is quite detailed! The list seems pretty reasonable, just comparing the category to the comment. There will probably be a handful of updates that stand out better in the actual code, but nothing I see at this time.

Just to keep things reviewable, could you split this into a couple of MRs with ~30-60 updates each?

@lvllvl lvllvl mentioned this issue Jan 6, 2025
3 tasks
@lvllvl
Copy link
Contributor

lvllvl commented Jan 6, 2025

Do I need to make a request for this issue to be assigned to me? I don't see an assign to me type button.

Yes, I can create PRs with about 30-50 added labels as requested. PRs should all be added soon.

@tgross35
Copy link
Contributor Author

tgross35 commented Jan 6, 2025

I think you should be able to comment @rustbot claim (same as in rust-lang/rust), but I'll just assign you. Thanks for helping out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue.
Projects
None yet
Development

No branches or pull requests

2 participants