Skip to content

Commit

Permalink
Document $LOAD_PATH.resolve_feature_path in globals.rdoc
Browse files Browse the repository at this point in the history
* RDoc does not seem to support documenting singleton object methods,
  and making $LOAD_PATH a class as a workaround is too weird.
  • Loading branch information
eregon committed Jul 13, 2019
1 parent b0f6f33 commit 4a935bc
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 15 deletions.
5 changes: 4 additions & 1 deletion doc/globals.rdoc
Expand Up @@ -25,7 +25,10 @@ $$:: The process number of the Ruby running this script.
$?:: The status of the last executed child process. This value is
thread-local.
$LOAD_PATH:: Load path for scripts and binary modules by load or require.
Aliased to $: and $-I.
Aliased to $: and $-I. Has a singleton method
$LOAD_PATH.resolve_feature_path(feature) that returns
[:rb or :so, path], which resolves the feature to the path the
original Kernel#require method would load.
$LOADED_FEATURES:: The array contains the module names loaded by require.
Aliased to $".
$DEBUG:: The debug flag, which is set by the -d switch. Enabling debug
Expand Down
3 changes: 1 addition & 2 deletions load.c
Expand Up @@ -945,14 +945,13 @@ load_ext(VALUE path)
return (VALUE)dln_load(RSTRING_PTR(path));
}

/* Method is documented in vm.c */

static int
no_feature_p(const char *feature, const char *ext, int rb, int expanded, const char **fn)
{
return 0;
}

// Documented in doc/globals.rdoc
VALUE
rb_resolve_feature_path(VALUE klass, VALUE fname)
{
Expand Down
12 changes: 0 additions & 12 deletions vm.c
Expand Up @@ -2937,18 +2937,6 @@ static VALUE usage_analysis_operand_stop(VALUE self);
static VALUE usage_analysis_register_stop(VALUE self);
#endif

/*
* Document-method: RubyVM::resolve_feature_path
* call-seq:
* RubyVM.resolve_feature_path(feature) -> [:rb or :so, path]
*
* Identifies the file that will be loaded by "require(feature)".
* This API is experimental and just for internal use.
*
* RubyVM.resolve_feature_path("set")
* #=> [:rb, "/path/to/set.rb"]
*/

void
Init_VM(void)
{
Expand Down

0 comments on commit 4a935bc

Please sign in to comment.