Skip to content

[pull] master from ruby:master #543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pull merged 7 commits into from
Dec 5, 2025
Merged

[pull] master from ruby:master #543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b35aff5
[DOC] Centerize Variable, English, and Constant columns
nobu Dec 5, 2025
1e7373e
[DOC] Describe the global variables set by command line options
nobu Dec 5, 2025
1cad20e
[DOC] Describe `$F`
nobu Dec 5, 2025
95ea3bd
[ruby/timeout] Only the timeout method should be public on the Timeou…
eregon Dec 5, 2025
bf2b9c0
[ruby/openssl] asn1: reorder declarations
rhenium Dec 4, 2025
f179885
[ruby/openssl] asn1: use ASN1_TIME_to_tm() to decode UTCTime and Gene…
rhenium Feb 27, 2025
ea415e9
[ruby/net-http] open: Never call Timeout.timeout in rescue clause
osyoyu Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 81 additions & 57 deletions doc/language/globals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,70 +14,72 @@ require 'English'

### Exceptions

| Variable | English | Contains |
|-------------|-------------------|----------------------------------------------------|
| `$!` | `$ERROR_INFO` | Exception object; set by Kernel#raise. |
| `$@` | `$ERROR_POSITION` | Array of backtrace positions; set by Kernel#raise. |
| Variable | English | Contains |
|:--------:|:-----------------:|----------------------------------------------------|
| `$!` | `$ERROR_INFO` | Exception object; set by Kernel#raise. |
| `$@` | `$ERROR_POSITION` | Array of backtrace positions; set by Kernel#raise. |

### Pattern Matching

| Variable | English | Contains |
|---------------|---------------------|--------------------------------------------------|
| `$~` | `$LAST_MATCH_INFO` | MatchData object; set by matcher method. |
| `$&` | `$MATCH` | Matched substring; set by matcher method. |
| `` $` `` | `$PRE_MATCH` | Substring left of match; set by matcher method. |
| `$'` | `$POST_MATCH` | Substring right of match; set by matcher method. |
| `$+` | `$LAST_PAREN_MATCH` | Last group matched; set by matcher method. |
| `$1` | | First group matched; set by matcher method. |
| `$2` | | Second group matched; set by matcher method. |
| Variable | English | Contains |
|:-------------:|:-------------------:|--------------------------------------------------|
| `$~` | `$LAST_MATCH_INFO` | MatchData object; set by matcher method. |
| `$&` | `$MATCH` | Matched substring; set by matcher method. |
| `` $` `` | `$PRE_MATCH` | Substring left of match; set by matcher method. |
| `$'` | `$POST_MATCH` | Substring right of match; set by matcher method. |
| `$+` | `$LAST_PAREN_MATCH` | Last group matched; set by matcher method. |
| `$1` | | First group matched; set by matcher method. |
| `$2` | | Second group matched; set by matcher method. |
| <tt>$_n_</tt> | | <i>n</i>th group matched; set by matcher method. |

### Separators

| Variable | English | Contains |
|----------|----------------------------|--------------------------------------------|
| `$/` | `$INPUT_RECORD_SEPARATOR` | Input record separator; initially newline. |
| `$\` | `$OUTPUT_RECORD_SEPARATOR` | Output record separator; initially `nil`. |
| Variable | English | Contains |
|:-----------:|:--------------------------:|--------------------------------------------|
| `$/`, `$-0` | `$INPUT_RECORD_SEPARATOR` | Input record separator; initially newline. |
| `$\` | `$OUTPUT_RECORD_SEPARATOR` | Output record separator; initially `nil`. |

### Streams

| Variable | English | Contains |
|-----------|-----------------------------|-----------------------------------------------|
| Variable | English | Contains |
|:---------:|:---------------------------:|-----------------------------------------------|
| `$stdin` | | Standard input stream; initially `STDIN`. |
| `$stdout` | | Standard input stream; initially `STDIOUT`. |
| `$stderr` | | Standard input stream; initially `STDERR`. |
| `$<` | `$DEFAULT_INPUT` | Default standard input; `ARGF` or `$stdin`. |
| `$>` | `$DEFAULT_OUTPUT` | Default standard output; initially `$stdout`. |
| `$.` | `$INPUT_LINE_NUMBER`, `$NR` | Input position of most recently read stream. |
| `$_` | `$LAST_READ_LINE` | String from most recently read stream. |
| `$<` | `$DEFAULT_INPUT` | Default standard input; `ARGF` or `$stdin`. |
| `$>` | `$DEFAULT_OUTPUT` | Default standard output; initially `$stdout`. |
| `$.` | `$INPUT_LINE_NUMBER`, `$NR` | Input position of most recently read stream. |
| `$_` | `$LAST_READ_LINE` | String from most recently read stream. |

### Processes

| Variable | English | Contains |
|---------------------------|-----------------------|--------------------------------------------------------|
| `$0` | | Initially, the name of the executing program. |
| `$*` | `$ARGV` | Points to the `ARGV` array. |
| `$$` | `$PROCESS_ID`, `$PID` | Process ID of the current process. |
| `$?` | `$CHILD_STATUS` | Process::Status of most recently exited child process. |
| Variable | English | Contains |
|:-------------------------:|:---------------------:|--------------------------------------------------------|
| `$0` | | Initially, the name of the executing program. |
| `$*` | `$ARGV` | Points to the `ARGV` array. |
| `$$` | `$PROCESS_ID`, `$PID` | Process ID of the current process. |
| `$?` | `$CHILD_STATUS` | Process::Status of most recently exited child process. |
| `$LOAD_PATH`, `$:`, `$-I` | | Array of paths to be searched. |
| `$LOADED_FEATURES`, `$"` | | Array of paths to loaded files. |

### Debugging

| Variable | English | Contains |
|-------------|---------|--------------------------------------------------------|
| Variable | English | Contains |
|:-----------:|:-------:|--------------------------------------------------------|
| `$FILENAME` | | The value returned by method ARGF.filename. |
| `$DEBUG` | | Initially, whether option `-d` or `--debug` was given. |
| `$DEBUG` | | Initially, whether option `-d` or `--debug` was given. |
| `$VERBOSE` | | Initially, whether option `-V` or `-W` was given. |

### Other Variables

| Variable | English | Contains |
|----------|---------|------------------------------------------------|
| `$-a` | | Whether option `-a` was given. |
| `$-i` | | Extension given with command-line option `-i`. |
| `$-l` | | Whether option `-l` was given. |
| `$-p` | | Whether option `-p` was given. |
| Variable | English | Contains |
|:-----------:|:-------:|------------------------------------------------|
| `$-F`, `$;` | | Separator given with command-line option `-F`. |
| `$-a` | | Whether option `-a` was given. |
| `$-i` | | Extension given with command-line option `-i`. |
| `$-l` | | Whether option `-l` was given. |
| `$-p` | | Whether option `-p` was given. |
| `$F` | | Array of `$_` split by `$-F`. |

## Exceptions

Expand Down Expand Up @@ -174,6 +176,10 @@ No \English.
### `$/` (Input Record Separator)

An input record separator, initially newline.
Set by the command-line option `-0`.

Setting to non-nil value by other than the command-line option is
deprecated.

English - `$INPUT_RECORD_SEPARATOR`, `$RS`.

Expand All @@ -182,6 +188,10 @@ Aliased as `$-0`.
### `$\` (Output Record Separator)

An output record separator, initially `nil`.
Copied from `$/` when the command-line option `-l` is given.

Setting to non-nil value by other than the command-line option is
deprecated.

English - `$OUTPUT_RECORD_SEPARATOR`, `$ORS`.

Expand Down Expand Up @@ -340,6 +350,16 @@ Aliased as `$-v` and `$-w`.

## Other Variables

### `$-F`

The default field separator in String#split; must be a String or a
Regexp, and can be set with command-line option `-F`.

Setting to non-nil value by other than the command-line option is
deprecated.

Aliased as `$;`.

### `$-a`

Whether command-line option `-a` was given; read-only.
Expand All @@ -359,49 +379,53 @@ Whether command-line option `-l` was set; read-only.

Whether command-line option `-p` was given; read-only.

### `$F`

If the command line option `-a` is given, the array obtained by
splitting `$_` by `$-F` is assigned at the start of each `-l`/`-p`
loop.

## Deprecated

### `$=`

### `$,`

### `$;`

# Pre-Defined Global Constants

## Summary

### Streams

| Constant | Contains |
|----------|-------------------------|
|:--------:|-------------------------|
| `STDIN` | Standard input stream. |
| `STDOUT` | Standard output stream. |
| `STDERR` | Standard error stream. |

### Environment

| Constant | Contains |
|-----------------------|-------------------------------------------------------------------------------|
| `ENV` | Hash of current environment variable names and values. |
| `ARGF` | String concatenation of files given on the command line, or `$stdin` if none. |
| `ARGV` | Array of the given command-line arguments. |
| `TOPLEVEL_BINDING` | Binding of the top level scope. |
| `RUBY_VERSION` | String Ruby version. |
| `RUBY_RELEASE_DATE` | String Ruby release date. |
| `RUBY_PLATFORM` | String Ruby platform. |
| `RUBY_PATCH_LEVEL` | String Ruby patch level. |
| `RUBY_REVISION` | String Ruby revision. |
| `RUBY_COPYRIGHT` | String Ruby copyright. |
| `RUBY_ENGINE` | String Ruby engine. |
| Constant | Contains |
|:---------------------:|-------------------------------------------------------------------------------|
| `ENV` | Hash of current environment variable names and values. |
| `ARGF` | String concatenation of files given on the command line, or `$stdin` if none. |
| `ARGV` | Array of the given command-line arguments. |
| `TOPLEVEL_BINDING` | Binding of the top level scope. |
| `RUBY_VERSION` | String Ruby version. |
| `RUBY_RELEASE_DATE` | String Ruby release date. |
| `RUBY_PLATFORM` | String Ruby platform. |
| `RUBY_PATCH_LEVEL` | String Ruby patch level. |
| `RUBY_REVISION` | String Ruby revision. |
| `RUBY_COPYRIGHT` | String Ruby copyright. |
| `RUBY_ENGINE` | String Ruby engine. |
| `RUBY_ENGINE_VERSION` | String Ruby engine version. |
| `RUBY_DESCRIPTION` | String Ruby description. |
| `RUBY_DESCRIPTION` | String Ruby description. |

### Embedded Data

| Constant | Contains |
|----------|--------------------------------------------------------------------|
| `DATA` | File containing embedded data (lines following `__END__`, if any). |
|:--------:|--------------------------------------------------------------------|
| `DATA` | File containing embedded data (lines following `__END__`, if any). |

## Streams

Expand Down
Loading