Skip to content

Commit e204f85

Browse files
authored
Update rc-files documentation (#1113)
Bringing docs in line with what (and in what order) rc files are loaded: - $HOME/.config/irb/irbrc is only considered when XDG_CONFIG_HOME is not set. - loading of irb.rc was removed in 11d03a6
1 parent 847d1ca commit e204f85

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

doc/Configurations.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,10 @@ IRB searches for a configuration file in the following order:
1616
1. `$IRBRC`
1717
2. `$XDG_CONFIG_HOME/irb/irbrc`
1818
3. `$HOME/.irbrc`
19-
4. `$HOME/.config/irb/irbrc`
19+
4. `$HOME/.config/irb/irbrc` (only if `XDG_CONFIG_HOME` is _not_ set)
2020
5. `.irbrc` in the current directory
21-
6. `irb.rc` in the current directory
22-
7. `_irbrc` in the current directory
23-
8. `$irbrc` in the current directory
21+
6. `_irbrc` in the current directory
22+
7. `$irbrc` in the current directory
2423

2524
If the `-f` command-line option is used, no configuration file is loaded.
2625

@@ -34,7 +33,7 @@ Method `conf.rc?` returns `true` if a configuration file was read, `false` other
3433
- `IRB_COPY_COMMAND`: Overrides the default program used to interface with the system clipboard.
3534
- `VISUAL` / `EDITOR`: Specifies the editor for the `edit` command.
3635
- `IRBRC`: Specifies the rc-file for configuration.
37-
- `XDG_CONFIG_HOME`: Used to locate the rc-file if `IRBRC` is unset.
36+
- `XDG_CONFIG_HOME`: Used to locate the user-specific rc-file (i.e. `$XDG_CONFIG_HOME/irb/irbrc` instead of `$HOME/.config/irb/irbrc`).
3837
- `RI_PAGER` / `PAGER`: Specifies the pager for documentation.
3938
- `IRB_LANG`, `LC_MESSAGES`, `LC_ALL`, `LANG`: Determines the locale.
4039

0 commit comments

Comments
 (0)