Skip to content

Commit

Permalink
Documents HOME(DRIVE|PATH). Closes #2566
Browse files Browse the repository at this point in the history
  • Loading branch information
JJ committed Jan 14, 2019
1 parent ec67ab3 commit aafb125
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 23 deletions.
51 changes: 32 additions & 19 deletions doc/Language/variables.pod6
Expand Up @@ -1359,11 +1359,11 @@ additional information on the inner workings of aforementioned VM.
say $*VM.precomp-ext, " ", $*VM.precomp-target; # OUTPUT: «moarvm mbc␤»
These two variables, for instance, will show the extension used in the
precompiled bytecode scripts and the target used. This is what is found in the
Moar Virtual Machine, but it could also vary with version and implementation.
Other VM, such as Java, will show different values for them. C<$*VM.config>
includes all configuration values used to create the virtual machine, e.g.
These two methods, for instance, will show the extension used in the precompiled
bytecode scripts and the target used. This is what is found in the Moar Virtual
Machine, but it could also vary with version and implementation. Other VM, such
as Java, will show different values for them. C<$*VM.config> includes all
configuration values used to create the virtual machine, e.g.
say $*VM.config<versionmajor>, ".", $*VM.config<versionminor>;
# OUTPUT: «2018.11␤»
Expand Down Expand Up @@ -1409,9 +1409,10 @@ program being executed.
X<|&*EXIT>
=head4 C<&*EXIT>
This is a L<Callable|/type/Callable> that contains the code that will be executed when doing an
C<exit()> call. Intended to be used in situations where Perl 6 is embedded in
another language runtime (such as Inline::Perl6 in Perl 5).
This is a L<Callable|/type/Callable> that contains the code that will be
executed when doing an C<exit()> call. Intended to be used in situations where
Perl 6 is embedded in another language runtime (such as Inline::Perl6 in Perl
5).
X<|$*EXECUTABLE>
=head4 C<$*EXECUTABLE>
Expand All @@ -1422,9 +1423,9 @@ running.
X<|$*EXECUTABLE-NAME>
=head4 C<$*EXECUTABLE-NAME>
This the name of the perl executable that is currently running. (e.g. perl6-p,
perl6-m). Favor C<$*EXECUTABLE> over this one, since it's not guaranteed that
the perl executable is in C<PATH>.
Contains the name of the Perl executable that is currently running. (e.g.
perl6-p, perl6-m). Favor C<$*EXECUTABLE> over this one, since it's not
guaranteed that the perl executable is in C<PATH>.
X<|$*USAGE>
=head4 C<$*USAGE>
Expand All @@ -1436,9 +1437,9 @@ C<sub MAIN> and C<sub USAGE>. The variable is I<read-only>.
X<|$*USER>
=head4 C<$*USER>
An C<Allomorph> with information about the user that is running the program.
It will evaluate to the username only if treated as a string and the numeric
user id if treated as a number.
An C<Allomorph> with information about the user that is running the program. It
will evaluate to the username if treated as a string and the numeric user id if
treated as a number.
X<|$*GROUP>
=head4 C<$*GROUP>
Expand All @@ -1447,14 +1448,26 @@ An C<Allomorph> with the primary group of the user who is running the program.
It will evaluate to the groupname only if treated as a string and the numeric
group id if treated as a number.
X<|$*HOMEDRIVE>
=head4 C<$*HOMEDRIVE>
Contains information about the "home drive" of the user that is running the
program on Windows. It's not defined in other OSs.
X<|$*HOMEPATH>
=head4 C<$*HOMEPATH>
Contains information about the path to the user directory that is running the
program on Windows. It's not defined in other OSs.
X<|$*HOME>
=head4 C<$*HOME>
Contains an L<IO::Path> object representing the "home directory"
of the user that is running the program. Uses
C«%*ENV<HOME>» if set. On Windows, uses
C«%*ENV<HOMEDRIVE> ~ %*ENV<HOMEPATH>». If the
home directory cannot be determined, it will be L<Any|/type/Any>.
Contains an L<IO::Path> object representing the "home directory" of the user
that is running the program. Uses C«%*ENV<HOME>» if set.
On Windows, uses C«%*ENV<HOMEDRIVE> ~ %*ENV<HOMEPATH>». If the home directory
cannot be determined, it will be L<Any|/type/Any>.
X<|$*SPEC>
=head4 C<$*SPEC>
Expand Down
9 changes: 5 additions & 4 deletions doc/Type/Kernel.pod6
Expand Up @@ -7,7 +7,8 @@
class Kernel does Systemic { }
Built-in class for providing kernel related information. Usually accessed
through the L«C<$*KERNEL>|/language/variables#Dynamic_variables» dynamic variable.
through the L«C<$*KERNEL>|/language/variables#Dynamic_variables» dynamic
variable.
=head1 Methods
Expand Down Expand Up @@ -107,9 +108,9 @@ C<Blob> type object if the signature could not be established.
method version(--> Version)
Instance method returning the version of the Kernel object as a L<Version|/type/Version>
object. Returns a Version object "unknown" if the version could not be
established.
Instance method returning the version of the Kernel object as a
L<Version|/type/Version> object. Returns a Version object "unknown" if the
version could not be established.
See Also: L<Systemic|/type/Systemic>
Expand Down

0 comments on commit aafb125

Please sign in to comment.