Skip to content

Commit

Permalink
Eliminates unintended markdown (#282)
Browse files Browse the repository at this point in the history
And substitutes it with Pod.
  • Loading branch information
JJ authored and ugexe committed Jan 15, 2019
1 parent 9cb53c8 commit d543d26
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.pod
Original file line number Diff line number Diff line change
Expand Up @@ -390,11 +390,11 @@ The configuration file will be chosen at runtime from one of two (technically fo

First, and the most precise way, is to specify the config file by passing C<--config-path="..."> to any zef command.

Second, third, and fourth we look at the path pointed to by `%?RESOURCES<config.json>`. This will point to C<$zef-dir/resources/config.json>, where C<$zef-dir> will be either:
Second, third, and fourth we look at the path pointed to by C<%?RESOURCESE<lt>config.jsonE<gt>>. This will point to C<$zef-dir/resources/config.json>, where C<$zef-dir> will be either:

=over 4

=item * The prefix of a common configuration directory, such as `$XDG_CONFIG_HOME` or `$HOME/.config`.
=item * The prefix of a common configuration directory, such as C<$XDG_CONFIG_HOME> or C<$HOME/.config>.

=item * The prefix of a rakudo installation location - This is the case if the modules loaded for bin/zef come from an installation CompUnit::Repository.

Expand Down Expand Up @@ -430,7 +430,8 @@ When you C<perl6 -I. bin/zef install .> that configuration file be be used to in

=item * You can create a C<%configE<lt>RootDirE<gt>/config.json> file.

Where C<%configE<lt>RootDirE<gt>>` comes from the previously mentioned C<%?RESOURCESE<lt>config.jsonE<gt>>'s C<RootDir> field (C<$*HOME/.zef> in most cases), to allow overriding zef config behavior on a per user basis (allows setting different C<--install-to> targets for, say, a root user and a regular user). Since this new config file could have a different C<RootDir> than the default config (used to find the new one in the first place) this behavior may be changed in the future to be less confusing.
Where C<%configE<lt>RootDirE<gt>>
comes from the previously mentioned C<%?RESOURCESE<lt>config.jsonE<gt>>'s C<RootDir> field (C<$*HOME/.zef> in most cases), to allow overriding zef config behavior on a per user basis (allows setting different C<--install-to> targets for, say, a root user and a regular user). Since this new config file could have a different C<RootDir> than the default config (used to find the new one in the first place) this behavior may be changed in the future to be less confusing.

=item * You can override both of the previous entries by passing C<zef --config-path="$path" E<lt>any commandE<gt>>

Expand Down

0 comments on commit d543d26

Please sign in to comment.