[GR-37283] Set usage syntax for all options

PullRequest: truffleruby/3219

Author: eregon

mx.truffleruby/suite.py

@@ -7,7 +7,7 @@
             {
                 "name": "regex",
                 "subdir": True,
-                "version": "7c20b5f30204e2cc13fb75a68eb3e6c73f46f436",
+                "version": "85c258963b605f95061b37a912a633b1bf1a1c0f",
                 "urls": [
                     {"url": "https://github.com/oracle/graal.git", "kind": "git"},
                     {"url": "https://curio.ssw.jku.at/nexus/content/repositories/snapshots", "kind": "binary"},
@@ -16,7 +16,7 @@
             {
                 "name": "sulong",
                 "subdir": True,
-                "version": "7c20b5f30204e2cc13fb75a68eb3e6c73f46f436",
+                "version": "85c258963b605f95061b37a912a633b1bf1a1c0f",
                 "urls": [
                     {"url": "https://github.com/oracle/graal.git", "kind": "git"},
                     {"url": "https://curio.ssw.jku.at/nexus/content/repositories/snapshots", "kind": "binary"},

spec/truffle/options/parsing_spec.rb

@@ -22,9 +22,9 @@
     end
 
     it "enum values" do
-      ruby_exe("p Truffle::Boot.get_option('verbose')").should_not == ":NIL\n"
-      ruby_exe("p Truffle::Boot.get_option('verbose')", options: "--verbose=NIL").should == ":NIL\n"
-      ruby_exe("p Truffle::Boot.get_option('verbose')", options: "--verbose").should == ":TRUE\n"
+      ruby_exe("p Truffle::Boot.get_option('verbose')").should_not == ":nil\n"
+      ruby_exe("p Truffle::Boot.get_option('verbose')", options: "--verbose=nil").should == ":nil\n" # TODO
+      ruby_exe("p Truffle::Boot.get_option('verbose')", options: "--verbose").should == ":true\n"
     end
 
     it "strings" do
@@ -49,7 +49,7 @@
     end
 
     it "enum values" do
-      ruby_exe("14", options: "--verbose=foo", args: "2>&1", exit_status: 1).should.include?("Invalid argument --verbose=foo specified. No enum constant org.truffleruby.shared.options.Verbosity.FOO")
+      ruby_exe("14", options: "--verbose=foo", args: "2>&1", exit_status: 1).should.include?("ERROR: Invalid argument --verbose=foo specified. Invalid option value 'foo'. Valid options values are: 'nil', 'false', 'true'")
     end
   end
 end

src/main/java/org/truffleruby/language/TruffleBootNodes.java

@@ -343,7 +343,7 @@ protected Object getOption(Object optionName,
             if (value instanceof Boolean || value instanceof Integer) {
                 return value;
             } else if (value instanceof Enum) {
-                return getSymbol(((Enum<?>) value).name());
+                return getSymbol(value.toString());
             } else if (value instanceof String) {
                 return makeStringNode.executeMake(value, Encodings.UTF_8, CodeRange.CR_UNKNOWN);
             } else if (value instanceof String[]) {

src/main/java/org/truffleruby/language/arguments/ReadCallerDataNode.java

@@ -50,11 +50,8 @@ protected Object getCallerData() {
             getNotOptimizedNode().warn("Unoptimized reading of caller data.");
         }
 
-        final MaterializedFrame callerFrame = Truffle
-                .getRuntime()
-                .getCallerFrame()
-                .getFrame(FrameAccess.MATERIALIZE)
-                .materialize();
+        final MaterializedFrame callerFrame = Truffle.getRuntime()
+                .iterateFrames(f -> f.getFrame(FrameAccess.MATERIALIZE).materialize(), 1);
         if (!CallStackManager.isRubyFrame(callerFrame)) {
             throw new RaiseException(
                     getContext(),

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

@@ -17,6 +17,7 @@
 import org.truffleruby.shared.options.OptionsCatalog;
 import org.truffleruby.shared.options.Verbosity;
 import org.truffleruby.shared.options.Profile;
+import org.truffleruby.shared.options.OutputFormat;
 
 import com.oracle.truffle.api.TruffleLanguage.Env;
 
@@ -27,13 +28,13 @@ public class Options {
     public final String[] LOAD_PATHS;
     /** --required-libraries=StringArrayOptionType.EMPTY_STRING_ARRAY */
     public final String[] REQUIRED_LIBRARIES;
-    /** --working-directory="" */
+    /** --working-directory="." */
     public final String WORKING_DIRECTORY;
     /** --debug=false */
     public final boolean DEBUG;
     /** --verbose=Verbosity.FALSE */
     public final Verbosity VERBOSITY;
-    /** --source-encoding="" */
+    /** --source-encoding="UTF-8" */
     public final String SOURCE_ENCODING;
     /** --internal-encoding="" */
     public final String INTERNAL_ENCODING;
@@ -195,8 +196,8 @@ public class Options {
     public final boolean REGEXP_INSTRUMENT_MATCH;
     /** --regexp-instrument-match-detailed=false */
     public final boolean REGEXP_INSTRUMENT_MATCH_DETAILED;
-    /** --regexp-instrumentation-output-format="text" */
-    public final String REGEXP_INSTRUMENT_OUTPUT_FORMAT;
+    /** --regexp-instrumentation-output-format=OutputFormat.TEXT */
+    public final OutputFormat REGEXP_INSTRUMENT_OUTPUT_FORMAT;
     /** --metrics-time-parsing-file=false */
     public final boolean METRICS_TIME_PARSING_FILE;
     /** --metrics-time-require=false */

src/main/ruby/truffleruby/core/truffle/kernel_operations.rb

@@ -134,11 +134,11 @@ def $LOAD_PATH.resolve_feature_path(file_name)
     Truffle::Boot.redo do
       $DEBUG = Truffle::Boot.get_option_or_default('debug', false)
       $VERBOSE = case Truffle::Boot.get_option_or_default('verbose', false)
-                 when :TRUE
+                 when :true
                    true
-                 when :FALSE
+                 when :false
                    false
-                 when :NIL
+                 when :nil
                    nil
                  end
     end

src/main/ruby/truffleruby/core/truffle/regexp_operations.rb

@@ -175,7 +175,7 @@ def self.match_stats(joni_matches:)
     def self.print_stats
       output_format = Truffle::Boot.get_option('regexp-instrumentation-output-format')
 
-      if output_format == 'text'
+      if output_format == :text
         puts '--------------------'
         puts 'Regular expression statistics'
         puts '--------------------'
@@ -204,7 +204,7 @@ def self.print_stats
 
           puts '--------------------'
         end
-      elsif output_format == 'json'
+      elsif output_format == :json
         ret = {}
 
         if Truffle::Boot.get_option('regexp-instrument-creation')

src/main/ruby/truffleruby/post-boot/post-boot.rb

@@ -68,7 +68,7 @@
 
 Truffle::Boot.delay do
   wd = Truffle::Boot.get_option('working-directory')
-  Dir.chdir(wd) unless wd.empty?
+  Dir.chdir(wd) unless wd.empty? || wd == '.'
 end
 
 if Truffle::Boot.ruby_home

src/options.yml

@@ -55,22 +55,22 @@ LANGUAGE_OPTIONS:
 USER:
   STABLE:
     # Options corresponding to MRI options, which are also useful outside the TruffleRuby launcher
-    LOAD_PATHS: [[load-paths, -I], string-array, [], Load paths]
-    REQUIRED_LIBRARIES: [[required-libraries, -r], string-array, [], Required libraries]
-    WORKING_DIRECTORY: [[working-directory, -C], string, '', Interpreter will switch to this directory]
+    LOAD_PATHS: [[load-paths, -I], string-array, '<path>,<path>,...', Load paths]
+    REQUIRED_LIBRARIES: [[required-libraries, -r], string-array, '<path>,<path>,...', Required libraries]
+    WORKING_DIRECTORY: [[working-directory, -C], string, '.', Interpreter will switch to this directory]
     DEBUG: [[debug, -d], boolean, false, 'Sets $DEBUG to this value']
     VERBOSITY: [[verbose, -v, -w, -W], enum/verbosity, false, 'Sets $VERBOSE to this value']
-    SOURCE_ENCODING: [[source-encoding, -K], string, '', Source encoding]
-    INTERNAL_ENCODING: [[internal-encoding, -E, -U], string, '', Internal encoding]
-    EXTERNAL_ENCODING: [[external-encoding, -E], string, '', External encoding]
+    SOURCE_ENCODING: [[source-encoding, -K], string, 'UTF-8', Source encoding]
+    INTERNAL_ENCODING: [[internal-encoding, -E, -U], string, ['', '<nil>'], Internal encoding]
+    EXTERNAL_ENCODING: [[external-encoding, -E], string, ['', '<locale>'], External encoding]
     BACKTRACE_LIMIT: [[backtrace-limit], integer, -1, limit the maximum length of backtrace displayed]
 
 EXPERT:
   EXPERIMENTAL:
     # Setting home and launcher, useful for embedding
     NO_HOME_PROVIDED: [no-home-provided, boolean, false, set to true to explicitly state that no home is provided (silences the warnings)]
-    LAUNCHER: [launcher, string, '', The location of the TruffleRuby launcher program]
-    CORE_LOAD_PATH: [core-load-path, string, 'resource:/truffleruby', Location to load the Truffle core library from]
+    LAUNCHER: [launcher, string, ['', '<set by launcher>'], The location of the TruffleRuby launcher program]
+    CORE_LOAD_PATH: [core-load-path, string, ['resource:/truffleruby', '<path, default is from cache>'], Location to load the Truffle core library from]
 
     # CRuby features (--enable/disable-FEATURE), also exposed as options so they can be used outside the Ruby launcher
     FROZEN_STRING_LITERALS: [frozen-string-literals, boolean, false, Use frozen string literals]
@@ -137,7 +137,7 @@ EXPERT:
     LOG_LOAD: [log-load, boolean, false, Log loading files]
     LOG_AUTOLOAD: [log-autoload, boolean, false, Log autoloading]
     LOG_FEATURE_LOCATION: [log-feature-location, boolean, false, Log the process of finding features]
-    METRICS_PROFILE_REQUIRE: [metrics-profile-require, enum/profile, none, 'Measure time for searching, parsing, translating and loading files. Valid values are: summary, detail, or none.']
+    METRICS_PROFILE_REQUIRE: [metrics-profile-require, enum/profile, none, 'Measure time for searching, parsing, translating and loading files.']
     CEXTS_LOG_LOAD: [cexts-log-load, boolean, false, Log loading of cexts]
     CEXTS_LOG_WARNINGS: [cexts-log-warnings, boolean, false, Log cexts warnings]
 
@@ -161,8 +161,8 @@ INTERNAL: # Options for debugging the TruffleRuby implementation
     SYNTAX_CHECK: [[syntax-check, -c], boolean, false, Do not execute just check syntax]
 
     # Used internally for the launcher to communicate with the RubyContext
-    ARGV_GLOBAL_VALUES: [argv-global-values, string-array, [], Parsed options from script argv with a value]
-    ARGV_GLOBAL_FLAGS: [argv-global-flags, string-array, [], Parsed options from script argv acting as flags (no value)]
+    ARGV_GLOBAL_VALUES: [argv-global-values, string-array, '<key>,<value>,...', Parsed options from script argv with a value]
+    ARGV_GLOBAL_FLAGS: [argv-global-flags, string-array, '<flag>,<flag>,...', Parsed options from script argv acting as flags (no value)]
     BUILDING_CORE_CEXTS: [building-core-cexts, boolean, false, 'Used while building TruffleRuby to build core C extensions']
 
     # Low-level logging of implementation details
@@ -237,7 +237,7 @@ INTERNAL: # Options for debugging the TruffleRuby implementation
     REGEXP_INSTRUMENT_CREATION: [regexp-instrument-creation, boolean, false, Enable instrumentation to gather stats on regexp creation]
     REGEXP_INSTRUMENT_MATCH: [regexp-instrument-match, boolean, false, Enable instrumentation to gather stats on regexp matching]
     REGEXP_INSTRUMENT_MATCH_DETAILED: [regexp-instrument-match-detailed, boolean, false, Enable instrumentation to gather detailed stats on strings matched against a regexp]
-    REGEXP_INSTRUMENT_OUTPUT_FORMAT: [regexp-instrumentation-output-format, string, 'text', 'Output format for regexp instrumentation (\\\"text\\\" or \\\"json\\\")']
+    REGEXP_INSTRUMENT_OUTPUT_FORMAT: [regexp-instrumentation-output-format, enum/output_format, text, 'Output format for regexp instrumentation']
 
     # Options for metrics, the output cannot be used directly without processing
     METRICS_TIME_PARSING_FILE: [metrics-time-parsing-file, boolean, false, 'Measure time for parsing, translating and executing files, per file']