diff options
Diffstat (limited to 'include/ruby/internal/error.h')
| -rw-r--r-- | include/ruby/internal/error.h | 36 |
1 files changed, 12 insertions, 24 deletions
diff --git a/include/ruby/internal/error.h b/include/ruby/internal/error.h index cd37f4461a..49e2276cb9 100644 --- a/include/ruby/internal/error.h +++ b/include/ruby/internal/error.h @@ -50,19 +50,7 @@ typedef enum { /** Warning is for experimental features. */ RB_WARN_CATEGORY_EXPERIMENTAL, - /** Warning is for performance issues (not enabled by -w). */ - RB_WARN_CATEGORY_PERFORMANCE, - - RB_WARN_CATEGORY_DEFAULT_BITS = ( - (1U << RB_WARN_CATEGORY_DEPRECATED) | - (1U << RB_WARN_CATEGORY_EXPERIMENTAL) | - 0), - - RB_WARN_CATEGORY_ALL_BITS = ( - (1U << RB_WARN_CATEGORY_DEPRECATED) | - (1U << RB_WARN_CATEGORY_EXPERIMENTAL) | - (1U << RB_WARN_CATEGORY_PERFORMANCE) | - 0) + RB_WARN_CATEGORY_ALL_BITS = 0x6 /* no RB_WARN_CATEGORY_NONE bit */ } rb_warning_category_t; /** for rb_readwrite_sys_fail first argument */ @@ -481,7 +469,7 @@ VALUE *rb_ruby_debug_ptr(void); */ #define ruby_debug (*rb_ruby_debug_ptr()) -/* reports if $VERBOSE is true */ +/* reports if `-W' specified */ RBIMPL_ATTR_NONNULL((1)) RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2) /** @@ -496,8 +484,7 @@ RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2) * default, the method just emits its passed contents to ::rb_stderr using * rb_io_write(). * - * @note This function is affected by the value of $VERBOSE, it does - * nothing unless $VERBOSE is true. + * @note This function is affected by the `-W` flag. * @param[in] fmt Format specifier string compatible with rb_sprintf(). * * @internal @@ -522,7 +509,7 @@ RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 3, 4) * Issues a compile-time warning that happens at `__file__:__line__`. Purpose * of this function being exposed to CAPI is unclear. * - * @note This function is affected by the value of $VERBOSE. + * @note This function is affected by the `-W` flag. * @param[in] file The path corresponding to Ruby level `__FILE__`. * @param[in] line The number corresponding to Ruby level `__LINE__`. * @param[in] fmt Format specifier string compatible with rb_sprintf(). @@ -535,20 +522,19 @@ RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2) * Identical to rb_sys_fail(), except it does not raise an exception to render * a warning instead. * - * @note This function is affected by the value of $VERBOSE. + * @note This function is affected by the `-W` flag. * @param[in] fmt Format specifier string compatible with rb_sprintf(). */ void rb_sys_warning(const char *fmt, ...); -/* reports if $VERBOSE is not nil (so if it is true or false) */ +/* reports always */ RBIMPL_ATTR_COLD() RBIMPL_ATTR_NONNULL((1)) RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2) /** - * Identical to rb_warning(), except it reports unless $VERBOSE is nil. + * Identical to rb_warning(), except it reports always regardless of runtime + * `-W` flag. * - * @note This function is affected by the value of $VERBOSE, it does - * nothing if $VERBOSE is nil. * @param[in] fmt Format specifier string compatible with rb_sprintf(). */ void rb_warn(const char *fmt, ...); @@ -557,7 +543,8 @@ RBIMPL_ATTR_COLD() RBIMPL_ATTR_NONNULL((2)) RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3) /** - * Identical to rb_category_warning(), except it reports unless $VERBOSE is nil. + * Identical to rb_category_warning(), except it reports always regardless of + * runtime `-W` flag. * * @param[in] cat Category e.g. deprecated. * @param[in] fmt Format specifier string compatible with rb_sprintf(). @@ -567,7 +554,8 @@ void rb_category_warn(rb_warning_category_t cat, const char *fmt, ...); RBIMPL_ATTR_NONNULL((1, 3)) RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 3, 4) /** - * Identical to rb_compile_warning(), except it reports unless $VERBOSE is nil. + * Identical to rb_compile_warning(), except it reports always regardless of + * runtime `-W` flag. * * @param[in] file The path corresponding to Ruby level `__FILE__`. * @param[in] line The number corresponding to Ruby level `__LINE__`. |