Improve support for warning categories #3508
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeremyevans
force-pushed
the
warning-categories
branch
from
c546258
to
9bee097
Compare
|
I've rebased this after eeb5325 and introduction of Ractor to fix conflicts, and squashed a couple of the commits. |
jeremyevans
force-pushed
the
warning-categories
branch
from
9bee097
to
b676a18
Compare
In general accepting arbitrary keywords is a bad idea unless you are delegating keywords or acting on arbitrary keywords. In this case, the category keyword is ignored, and it's less error prone to not ignore all keywords.
jeremyevans
force-pushed
the
warning-categories
branch
3 times, most recently
from
342d948
to
9ad2e4c
Compare
This adds the following C-API functions that can be used to emit
warnings with categories included:
```c
void rb_category_warn(const char *, const char*, ...)
void rb_category_warning(const char*, const char*, ...)
```
Internally in error.c, there is an rb_warn_category function
that will call Warning.warn with the string and the category
keyword if it doesn't have an arity of 1, and will call
Warning.warn with just the string if it has an arity of 1.
This refactors the rb_warn_deprecated{,_to_remove} functions
to use rb_warn_category.
This makes Kernel#warn accept a category keyword and pass it
to Warning.warn, so that Ruby methods can more easily emit
warnings with categories. rb_warn_category makes sure that
the passed category is a already defined category symbol
before calling Warning.warn.
The only currently defined warning category is :deprecated,
since that is what is already used. More categories can be
added in later commits.
jeremyevans
force-pushed
the
warning-categories
branch
from
9ad2e4c
to
fe64716
Compare
|
I modified the implementation to only allow specific category symbols, as requested by matz. By default, only |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds support for the
categorykeyword forKernel#warn(for Ruby level warnings), and addsrb_category_warnandrb_category_warningC-API functions (for C level warnings). It changesWarning.warnto only accept acategorykeyword, instead of accepting arbitrary keywords. It modifies all of the warnings emitted by core Ruby to use a category.This also removes some deprecated functions/methods that were scheduled to be removed in Ruby 3.0 that I found while looking for warnings to modify.