Skip to content

Commit 2deedb5

Browse files
committed
Remove Rakudo filenames
Readers of this doc don't need to know where in Rakudo things are defined. Move all the Types to a separate line, following the new standard.
1 parent 11555f5 commit 2deedb5

File tree

1 file changed

+39
-15
lines changed

1 file changed

+39
-15
lines changed

doc/Programs/03-environment-variables.rakudoc

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,27 @@ to use a arguments with spaces in them.
3737
=head2 Module loading
3838

3939
X<|Programs,RAKUDOLIB>X<|Programs,RAKULIB>X<|Programs,PERL6LIB>
40-
=item C<RAKUDOLIB>, C<RAKULIB> (I<Str>; B<src/core/Inc.pm>)
40+
=item C<RAKUDOLIB>, C<RAKULIB>
41+
42+
Type: L<C<Str>|/type/Str>.
4143

4244
C<RAKUDOLIB> and C<RAKULIB> append a comma-delimited list of paths to the
4345
search list for modules. C<RAKUDOLIB> is evaluated first. B<NOTE:> These env
4446
vars were added in the Rakudo compiler in version 2020.05. The deprecated older
4547
env var C<PERL6LIB> is still available.
4648

4749
X<|Programs,RAKUDO_MODULE_DEBUG>
48-
=item C<RAKUDO_MODULE_DEBUG> (I<Bool>; B<src/Perl6/ModuleLoader.nqp>)
50+
=item C<RAKUDO_MODULE_DEBUG>
51+
52+
Type: L<C<Bool>|/type/Bool>.
4953

5054
If true, causes the module loader to print debugging information to standard
5155
error.
5256

5357
X<|Programs,RAKUDO_PRECOMPILATION_PROGRESS>
54-
=item C<RAKUDO_PRECOMPILATION_PROGRESS> (I<Bool>; B<src/Perl6/ModuleLoader.nqp>)
58+
=item C<RAKUDO_PRECOMPILATION_PROGRESS>
59+
60+
Type: L<C<Bool>|/type/Bool>.
5561

5662
Available as of the 2012.12 release of the Rakudo compiler.
5763

@@ -81,44 +87,54 @@ such as IDEs.
8187
# {"X::AdHoc":{"payload":"foo","message":"foo"}}
8288

8389
X<|Programs,RAKUDO_NO_DEPRECATIONS>
84-
=item C<RAKUDO_NO_DEPRECATIONS> (I<Bool>; B<src/core.c/Deprecations.rakumod>)
90+
=item C<RAKUDO_NO_DEPRECATIONS>
91+
92+
Type: L<C<Bool>|/type/Bool>.
8593

8694
If true, suppresses deprecation warnings triggered by the C<is DEPRECATED>
8795
trait.
8896

8997
X<|Programs,RAKUDO_DEPRECATIONS_FATAL>
90-
=item C<RAKUDO_DEPRECATIONS_FATAL> (I<Bool>; B<src/core.c/Deprecations.rakumod>)
98+
=item C<RAKUDO_DEPRECATIONS_FATAL>
99+
100+
Type: L<C<Bool>|/type/Bool>.
91101

92102
If true, deprecation warnings become thrown exceptions.
93103

94104
X<|Programs,RAKUDO_VERBOSE_STACKFRAME>
95-
=item C<RAKUDO_VERBOSE_STACKFRAME> (I<UInt>; B<src/core.c/Backtrace.rakumod>)
105+
=item C<RAKUDO_VERBOSE_STACKFRAME>
106+
107+
Type: L<C<Uint>|/type/Uint>.
96108

97109
Displays source code in stack frames surrounded by the specified number of
98110
lines of context; for instance C<RAKUDO_VERBOSE_STACKFRAME = 1> will use one
99111
context line.
100112

101113
X<|Programs,RAKUDO_BACKTRACE_SETTING>
102-
=item C<RAKUDO_BACKTRACE_SETTING> (I<Bool>; B<src/core.c/Backtrace.rakumod>)
114+
=item C<RAKUDO_BACKTRACE_SETTING>
115+
116+
Type: L<C<Bool>|/type/Bool>.
103117

104118
Controls whether C<.setting> files are included in backtraces.
105119

106120
=head2 Affecting precompilation
107121

108122
X<|Programs,RAKUDO_PREFIX>
109-
=item C<RAKUDO_PREFIX> (I<Str>; B<src/core.c/CompUnit/RepositoryRegistry.rakumod>)
123+
=item C<RAKUDO_PREFIX>
124+
125+
Type: L<C<Str>|/type/Str>.
110126

111127
When this is set, Rakudo will look for the standard repositories (perl, vendor,
112128
site) in the specified directory. This is intended as an escape hatch for
113129
build-time bootstrapping issues, where Rakudo may be built as an unprivileged
114130
user without write access to the runtime paths in NQP's config.
115131

116132
X<|Programs,RAKUDO_PRECOMP_DIST>
117-
=item C<RAKUDO_PRECOMP_DIST> (B<src/core.c/CompUnit/PrecompilationRepository.rakumod>)
133+
=item C<RAKUDO_PRECOMP_DIST>
118134
X<|Programs,RAKUDO_PRECOMP_LOADING>
119-
=item C<RAKUDO_PRECOMP_LOADING> (B<src/core.c/CompUnit/PrecompilationRepository.rakumod>)
135+
=item C<RAKUDO_PRECOMP_LOADING>
120136
X<|Programs,RAKUDO_PRECOMP_WITH>
121-
=item C<RAKUDO_PRECOMP_WITH> (B<src/core.c/CompUnit/PrecompilationRepository.rakumod>)
137+
=item C<RAKUDO_PRECOMP_WITH>
122138

123139
These are internal variables for passing serialized state to precompilation jobs
124140
in child processes. Please do not set them manually.
@@ -178,7 +194,9 @@ L«C<$*DEFAULT-READ-ELEMS>|/language/variables#$*DEFAULT-READ-ELEMS» dynamic
178194
variable.
179195

180196
X<|Programs,RAKUDO_ERROR_COLOR>
181-
=item C<RAKUDO_ERROR_COLOR> (I<Bool>; B<src/core.c/Exception.rakumod>)
197+
=item C<RAKUDO_ERROR_COLOR>
198+
199+
Type: L<C<Bool>|/type/Bool>.
182200

183201
Controls whether to emit ANSI codes for error highlighting. Defaults to true
184202
if unset, except on Windows.
@@ -192,7 +210,9 @@ the C<REPL>. This allows the C<REPL> to be better integrated in the Emacs
192210
environment (which sets this environment variable).
193211

194212
X<|Programs,RAKUDO_MAX_THREADS>
195-
=item C<RAKUDO_MAX_THREADS> (I<UInt>; B<src/core.c/ThreadPoolScheduler.rakumod>)
213+
=item C<RAKUDO_MAX_THREADS>
214+
215+
Type: L<C<Uint>|/type/Uint>.
196216

197217
Indicates the maximum number of threads used by default when creating a
198218
L<C<ThreadPoolScheduler>|/type/ThreadPoolScheduler>. Defaults to 64 unless there appear to be more than
@@ -203,7 +223,9 @@ specify "B<unlimited>" or "B<Inf>" to indicate that the number of threads
203223
available by the operating system, will be the limiting factor.
204224

205225
X<|Programs,TMPDIR>X<|Programs,TEMP>X<|Programs,TMP>
206-
=item C<TMPDIR>, C<TEMP>, C<TMP> (I<Str>; B<src/core.c/IO/Spec/>)
226+
=item C<TMPDIR>, C<TEMP>, C<TMP>
227+
228+
Type: L<C<Str>|/type/Str>.
207229

208230
The C<IO::Spec::Unix.tmpdir> method will return C<$TMPDIR> if it points to a
209231
directory with full access permissions for the current user, with a fallback
@@ -213,7 +235,9 @@ L<C<IO::Spec::Cygwin>|/type/IO::Spec::Cygwin> and L<C<IO::Spec::Win32>|/type/IO:
213235
which also include the C<%TEMP%> and C<%TMP%> environment variables.
214236

215237
X<|Programs,PATH>
216-
=item C<PATH>, C<Path> (I<Str>; B<src/core.c/IO/Spec/>)
238+
=item C<PATH>, C<Path>
239+
240+
Type: L<C<Str>|/type/Str>.
217241

218242
The C<IO::Spec::Unix.path> method splits C<$PATH> as a
219243
shell would; i.e. as a colon-separated list. L<C<IO::Spec::Cygwin>|/type/IO::Spec::Cygwin> inherits this

0 commit comments

Comments
 (0)