Remove the now unused --backtraces-hide-core-files option

* Improve debugging documentation.

Author: eregon

doc/contributor/debugging.md

@@ -1,15 +1,23 @@
 # Debugging TruffleRuby
 
-## More information in backtraces
+## Printing Exceptions
 
-We try to match MRI's backtrace format as closely as possible. This often means
+There are two ways to print exceptions, which can be useful to find the source of an error:
+* the standard Ruby `-d` flag which print the `file:line` where each exception was raised.
+* `--backtraces-raise` which show the full backtrace on each exception raised.
+
+Both are printed even if the exception is later rescued.
+
+See other `--backtraces-*` and `--exceptions-*` options for more possibilities.
+
+## More Information in Backtraces
+
+We try to match MRI's backtrace format as closely as possible. This sometimes means
 that we don't display extra information that we actually do have available.
 When debugging you may want to see this information.
 
-Two options to show more information are `--backtraces-hide-core-files=false`
-which doesn't hide methods that are used to implement the core library, and
-`--backtraces-interleave-java=true` which shows you the Java methods involved in
-executing each Ruby method.
+An option to show more information is `--backtraces-interleave-java=true`
+which shows you the Java methods involved in executing each Ruby method.
 
 When you are interoperating with other languages, including C extensions,
 backtraces for Java exceptions may be missing information, as the Java frames

src/main/java/org/truffleruby/language/backtrace/BacktraceFormatter.java

@@ -38,7 +38,6 @@ public class BacktraceFormatter {
     public enum FormattingFlags {
         OMIT_EXCEPTION,
         OMIT_FROM_PREFIX,
-        INCLUDE_CORE_FILES,
         INTERLEAVE_JAVA
     }
 
@@ -54,10 +53,6 @@ public enum FormattingFlags {
     public static BacktraceFormatter createDefaultFormatter(RubyContext context) {
         final EnumSet<FormattingFlags> flags = EnumSet.noneOf(FormattingFlags.class);
 
-        if (!context.getOptions().BACKTRACES_HIDE_CORE_FILES) {
-            flags.add(FormattingFlags.INCLUDE_CORE_FILES);
-        }
-
         if (context.getOptions().BACKTRACES_INTERLEAVE_JAVA) {
             flags.add(FormattingFlags.INTERLEAVE_JAVA);
         }
@@ -72,7 +67,7 @@ public static BacktraceFormatter createDefaultFormatter(RubyContext context) {
     public static String printableRubyBacktrace(RubyContext context, Node node) {
         final BacktraceFormatter backtraceFormatter = new BacktraceFormatter(
                 context,
-                EnumSet.of(FormattingFlags.INCLUDE_CORE_FILES));
+                EnumSet.noneOf(FormattingFlags.class));
         final String backtrace = backtraceFormatter.formatBacktrace(null, context.getCallStack().getBacktrace(node));
         if (backtrace.isEmpty()) {
             return "<empty backtrace>";

src/main/java/org/truffleruby/options/Options.java

@@ -97,8 +97,6 @@ public class Options {
     public final boolean EXCEPTIONS_WARN_STACKOVERFLOW;
     /** --exceptions-warn-out-of-memory=true */
     public final boolean EXCEPTIONS_WARN_OUT_OF_MEMORY;
-    /** --backtraces-hide-core-files=true */
-    public final boolean BACKTRACES_HIDE_CORE_FILES;
     /** --backtraces-interleave-java=false */
     public final boolean BACKTRACES_INTERLEAVE_JAVA;
     /** --backtraces-limit=9999 */
@@ -322,7 +320,6 @@ public Options(Env env, OptionValues options) {
         EXCEPTIONS_TRANSLATE_ASSERT = options.get(OptionsCatalog.EXCEPTIONS_TRANSLATE_ASSERT_KEY);
         EXCEPTIONS_WARN_STACKOVERFLOW = options.get(OptionsCatalog.EXCEPTIONS_WARN_STACKOVERFLOW_KEY);
         EXCEPTIONS_WARN_OUT_OF_MEMORY = options.get(OptionsCatalog.EXCEPTIONS_WARN_OUT_OF_MEMORY_KEY);
-        BACKTRACES_HIDE_CORE_FILES = options.get(OptionsCatalog.BACKTRACES_HIDE_CORE_FILES_KEY);
         BACKTRACES_INTERLEAVE_JAVA = options.get(OptionsCatalog.BACKTRACES_INTERLEAVE_JAVA_KEY);
         BACKTRACES_LIMIT = options.get(OptionsCatalog.BACKTRACES_LIMIT_KEY);
         BACKTRACES_OMIT_UNUSED = options.get(OptionsCatalog.BACKTRACES_OMIT_UNUSED_KEY);
@@ -493,8 +490,6 @@ public Object fromDescriptor(OptionDescriptor descriptor) {
                 return EXCEPTIONS_WARN_STACKOVERFLOW;
             case "ruby.exceptions-warn-out-of-memory":
                 return EXCEPTIONS_WARN_OUT_OF_MEMORY;
-            case "ruby.backtraces-hide-core-files":
-                return BACKTRACES_HIDE_CORE_FILES;
             case "ruby.backtraces-interleave-java":
                 return BACKTRACES_INTERLEAVE_JAVA;
             case "ruby.backtraces-limit":

src/options.yml

@@ -52,7 +52,6 @@ EXPERT:
     EXCEPTIONS_TRANSLATE_ASSERT: [exceptions-translate-assert, boolean, true, Translate failed Java assertions to Ruby exceptions]
     EXCEPTIONS_WARN_STACKOVERFLOW: [exceptions-warn-stackoverflow, boolean, true, Warn when a stack overflow error is thrown]
     EXCEPTIONS_WARN_OUT_OF_MEMORY: [exceptions-warn-out-of-memory, boolean, true, Warn when an out-of-memory error is thrown]
-    BACKTRACES_HIDE_CORE_FILES: [backtraces-hide-core-files, boolean, true, 'Hide core source files in backtraces, like MRI does']
     BACKTRACES_INTERLEAVE_JAVA: [backtraces-interleave-java, boolean, false, Interleave Java stacktraces into the Ruby backtrace]
     BACKTRACES_LIMIT: [backtraces-limit, integer, 9999, Limit the size of Ruby backtraces]
     BACKTRACES_OMIT_UNUSED: [backtraces-omit-unused, boolean, true, Omit backtraces that should be unused as they have pure rescue expressions]

src/shared/java/org/truffleruby/shared/options/OptionsCatalog.java

@@ -57,7 +57,6 @@ public class OptionsCatalog {
     public static final OptionKey<Boolean> EXCEPTIONS_TRANSLATE_ASSERT_KEY = new OptionKey<>(true);
     public static final OptionKey<Boolean> EXCEPTIONS_WARN_STACKOVERFLOW_KEY = new OptionKey<>(true);
     public static final OptionKey<Boolean> EXCEPTIONS_WARN_OUT_OF_MEMORY_KEY = new OptionKey<>(true);
-    public static final OptionKey<Boolean> BACKTRACES_HIDE_CORE_FILES_KEY = new OptionKey<>(true);
     public static final OptionKey<Boolean> BACKTRACES_INTERLEAVE_JAVA_KEY = new OptionKey<>(false);
     public static final OptionKey<Integer> BACKTRACES_LIMIT_KEY = new OptionKey<>(9999);
     public static final OptionKey<Boolean> BACKTRACES_OMIT_UNUSED_KEY = new OptionKey<>(true);
@@ -410,13 +409,6 @@ public class OptionsCatalog {
             .stability(OptionStability.EXPERIMENTAL)
             .build();
 
-    public static final OptionDescriptor BACKTRACES_HIDE_CORE_FILES = OptionDescriptor
-            .newBuilder(BACKTRACES_HIDE_CORE_FILES_KEY, "ruby.backtraces-hide-core-files")
-            .help("Hide core source files in backtraces, like MRI does")
-            .category(OptionCategory.EXPERT)
-            .stability(OptionStability.EXPERIMENTAL)
-            .build();
-
     public static final OptionDescriptor BACKTRACES_INTERLEAVE_JAVA = OptionDescriptor
             .newBuilder(BACKTRACES_INTERLEAVE_JAVA_KEY, "ruby.backtraces-interleave-java")
             .help("Interleave Java stacktraces into the Ruby backtrace")
@@ -1137,8 +1129,6 @@ public static OptionDescriptor fromName(String name) {
                 return EXCEPTIONS_WARN_STACKOVERFLOW;
             case "ruby.exceptions-warn-out-of-memory":
                 return EXCEPTIONS_WARN_OUT_OF_MEMORY;
-            case "ruby.backtraces-hide-core-files":
-                return BACKTRACES_HIDE_CORE_FILES;
             case "ruby.backtraces-interleave-java":
                 return BACKTRACES_INTERLEAVE_JAVA;
             case "ruby.backtraces-limit":
@@ -1367,7 +1357,6 @@ public static OptionDescriptor[] allDescriptors() {
             EXCEPTIONS_TRANSLATE_ASSERT,
             EXCEPTIONS_WARN_STACKOVERFLOW,
             EXCEPTIONS_WARN_OUT_OF_MEMORY,
-            BACKTRACES_HIDE_CORE_FILES,
             BACKTRACES_INTERLEAVE_JAVA,
             BACKTRACES_LIMIT,
             BACKTRACES_OMIT_UNUSED,

tool/jt.rb

@@ -605,7 +605,7 @@ def help
       jt ruby [jt options] [--] [ruby options] args...
                                                      run TruffleRuby with args
           --stress        stress the compiler (compile immediately, foreground compilation, compilation exceptions are fatal)
-          --reveal        enable assertions, show core Ruby files in backtrace
+          --reveal        enable assertions
           --asm           show assembly
           --igv           dump select Graal graphs to graal_dumps/ (-Dgraal.Dump=Truffle:1)
           --igv-full      dump all Graal graphs to graal_dumps/ (-Dgraal.Dump=Truffle:2)
@@ -788,8 +788,6 @@ def rebuild(*options)
         core_load_path = false
       when '--reveal'
         vm_args += %w[--vm.ea --vm.esa] unless truffleruby_native?
-        add_experimental_options.call
-        vm_args += %w[--backtraces-hide-core-files=false]
       when '--stress'
         add_experimental_options.call
         vm_args << '--engine.CompileImmediately'