Skip to content

Commit 11555f5

Browse files
committed
Fix type formatting for several files.
(and some very minor textual cleanups)
1 parent 14b1f56 commit 11555f5

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

doc/Programs/03-environment-variables.rakudoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ X<|Programs,RAKU_REPL_OUTPUT_METHOD>
143143
This specifies the name of the method that should be called on the result
144144
value of a statement in the L<REPL|/language/REPL> if the statement did B<not> cause any
145145
output of its own. If absent, C<gist> will be assumed. One can use
146-
C<raku> to force a more literal, parsable representation. Or C<Str> to force a
146+
C<raku> to force a more literal, parsable representation. Or L<C<Str>|/type/Str> to force a
147147
complete string representation. Available as of the 2020.06 release of
148148
the Rakudo compiler.
149149

@@ -195,7 +195,7 @@ X<|Programs,RAKUDO_MAX_THREADS>
195195
=item C<RAKUDO_MAX_THREADS> (I<UInt>; B<src/core.c/ThreadPoolScheduler.rakumod>)
196196

197197
Indicates the maximum number of threads used by default when creating a
198-
C<ThreadPoolScheduler>. Defaults to 64 unless there appear to be more than
198+
L<C<ThreadPoolScheduler>|/type/ThreadPoolScheduler>. Defaults to 64 unless there appear to be more than
199199
8 CPU cores available: in which case it defaults to 8 * number of cores.
200200

201201
As of release 2022.06 of the Rakudo compiler, it is also possible to
@@ -209,15 +209,15 @@ The C<IO::Spec::Unix.tmpdir> method will return C<$TMPDIR> if it points to a
209209
directory with full access permissions for the current user, with a fallback
210210
default of C<'/tmp'>.
211211

212-
C<IO::Spec::Cygwin> and C<IO::Spec::Win32> use more Windows-appropriate lists
212+
L<C<IO::Spec::Cygwin>|/type/IO::Spec::Cygwin> and L<C<IO::Spec::Win32>|/type/IO::Spec::Win32> use more Windows-appropriate lists
213213
which also include the C<%TEMP%> and C<%TMP%> environment variables.
214214

215215
X<|Programs,PATH>
216216
=item C<PATH>, C<Path> (I<Str>; B<src/core.c/IO/Spec/>)
217217

218218
The C<IO::Spec::Unix.path> method splits C<$PATH> as a
219-
shell would; i.e. as a colon-separated list. C<IO::Spec::Cygwin> inherits this
220-
from C<IO::Spec::Unix>. C<IO::Spec::Win32.path> will read the first defined of
219+
shell would; i.e. as a colon-separated list. L<C<IO::Spec::Cygwin>|/type/IO::Spec::Cygwin> inherits this
220+
from L<C<IO::Spec::Unix>|/type/IO::Spec::Unix>. C<IO::Spec::Win32.path> will read the first defined of
221221
either C<%PATH%> or C<%Path%> as a semicolon-delimited list.
222222

223223
X<|Programs,RAKUDO_SNAPPER>

doc/Type/Lock.rakudoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,19 @@ so a thread that is waiting to acquire a lock is, from the point of view
4545
of the operating system, blocked.
4646

4747
Code using high-level Raku concurrency constructs should avoid using
48-
C<Lock>. Waiting to acquire a C<Lock> blocks a real C<Thread>, meaning
48+
C<Lock>. Waiting to acquire a C<Lock> blocks a real L<C<Thread>|/type/Thread>, meaning
4949
that the thread pool (used by numerous higher-level Raku concurrency
5050
mechanisms) cannot use that thread in the meantime for anything else.
5151

5252
Any C<await> performed while a C<Lock> is held will behave in a blocking
5353
manner; the standard non-blocking behavior of C<await> relies on the
54-
code following the `await` resuming on a different C<Thread> from the
54+
code following the `await` resuming on a different L<C<Thread>|/type/Thread> from the
5555
pool, which is incompatible with the requirement that a C<Lock> be
5656
unlocked by the same thread that locked it. See
57-
L<C<Lock::Async>|/type/Lock/Async>
57+
L<C<Lock::Async>|/type/Lock::Async>
5858
for an alternative mechanism that does not have this shortcoming. Other than
5959
that, the main difference is that C<Lock> mainly maps to operating system
60-
mechanisms, while C<Lock::Async> uses Raku primitives to achieve similar
60+
mechanisms, while L<C<Lock::Async>|/type/Lock::Async> uses Raku primitives to achieve similar
6161
effects. If you're doing low-level stuff (native bindings) and/or actually
6262
want to block real OS threads, use C<Lock>. However, if you want a
6363
non-blocking mutual exclusion and don't need recursion and are running code
@@ -67,7 +67,7 @@ By their nature, C<Lock>s are not composable, and it is possible to
6767
end up with hangs should circular dependencies on locks occur. Prefer
6868
to structure concurrent programs such that they communicate results
6969
rather than modify shared data structures, using mechanisms like
70-
L<Promise|/type/Promise>, L<Channel|/type/Channel> and L<Supply|/type/Supply>.
70+
L<C<Promise>|/type/Promise>, L<C<Channel>|/type/Channel> and L<C<Supply>|/type/Supply>.
7171

7272

7373
=head1 Methods
@@ -80,12 +80,12 @@ Obtains the lock, runs C<&code>, and releases the lock afterwards. Care
8080
is taken to make sure the lock is released even if the code is left through
8181
an exception.
8282

83-
Note that the L<Lock|/type/Lock> itself needs to be created outside the portion
83+
Note that the C<Lock> itself needs to be created outside the portion
8484
of the code that gets threaded and it needs to protect. In the first
85-
example below, L<Lock|/type/Lock> is first created and assigned to C<$lock>,
86-
which is then used I<inside> the L<Promises|/type/Promise> to protect
85+
example below, C<Lock> is first created and assigned to C<$lock>,
86+
which is then used I<inside> the L<C<Promise>|/type/Promise>s to protect
8787
the sensitive code. In the second example, a mistake is made: the
88-
C<Lock> is created right inside the L<Promise|/type/Promise>, so the code ends up
88+
C<Lock> is created right inside the L<C<Promise>|/type/Promise>, so the code ends up
8989
with a bunch of separate locks, created in a bunch of threads, and
9090
thus they don't actually protect the code we want to protect.
9191

@@ -156,7 +156,7 @@ calling C<lock> and C<unlock>. Failing that, use a C<LEAVE> phaser.
156156

157157
method condition(Lock:D: )
158158

159-
Returns a L<condition variable as a C<Lock::ConditionVariable> object|/type/Lock/ConditionVariable>.
159+
Returns a condition variable as a L<C<Lock::ConditionVariable>|/type/Lock::ConditionVariable> object.
160160
Check
161161
L<this article|https://web.stanford.edu/~ouster/cgi-bin/cs140-spring14/lecture.php?topic=locks> or
162162
L<the Wikipedia|https://en.wikipedia.org/wiki/Monitor_%28synchronization%29>

doc/Type/Lock/ConditionVariable.rakudoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
class Lock::ConditionVariable {}
88

9-
Condition variables are used in L<C<Lock>s|/type/Lock> to wait for a
9+
Condition variables are used in L<C<Lock>|/type/Lock>s to wait for a
1010
particular condition to become true. You will normally not create one from
1111
scratch, but call L<C<Lock.condition>|/type/Lock#method_condition> to acquire
12-
one on a particular C<Lock>.
12+
one on a particular L<C<Lock>|/type/Lock>.
1313

1414
=head1 Methods
1515

0 commit comments

Comments
 (0)