Skip to content

Commit b80c73e

Browse files
committed
documentation: Link refs to make, release, release-all, wait-for
Pointed out by Bruce in #1494, just after I merged it.
1 parent a0704bf commit b80c73e

File tree

1 file changed

+17
-17
lines changed
  • documentation/library-reference/source/dylan

1 file changed

+17
-17
lines changed

documentation/library-reference/source/dylan/threads.rst

+17-17
Original file line numberDiff line numberDiff line change
@@ -715,7 +715,7 @@ Locks
715715
a thread uses a lock for *mutual-exclusion* in this way, the thread
716716
is said to *own the lock*.
717717

718-
:class:`<lock>` has no direct instances; calling *make* on :class:`<lock>`
718+
:class:`<lock>` has no direct instances; calling :drm:`make` on :class:`<lock>`
719719
returns an instance of :class:`<simple-lock>`.
720720

721721
:operations:
@@ -744,21 +744,21 @@ Locks
744744

745745
:conditions:
746746

747-
*with-lock* may signal a condition of the following class (a
747+
:macro:`with-lock` may signal a condition of the following class (a
748748
subclass of :drm:`<serious-condition>`):
749749

750750
:class:`<timeout-expired>`
751-
This is signalled when *with-lock* did not succeed in claiming
751+
This is signalled when :macro:`with-lock` did not succeed in claiming
752752
the lock within the timeout period.
753753

754754
:description:
755755

756756
Execute the *body* with *lock* held. If a *failure* clause is
757757
supplied, then it will be evaluated and its values returned from
758-
*with-lock* if the lock cannot be claimed (because a timeout
758+
:macro:`with-lock` if the lock cannot be claimed (because a timeout
759759
occurred). The default, if no *failure* clause is supplied, is
760760
to signal an exception of class :class:`<timeout-expired>`. If there
761-
is no failure, *with-lock* returns the results of evaluating the
761+
is no failure, :macro:`with-lock` returns the results of evaluating the
762762
body.
763763

764764
:example:
@@ -855,7 +855,7 @@ Semaphores
855855

856856
:conditions:
857857

858-
An implementation of this *release* method is permitted to signal a
858+
An implementation of this :gf:`release` method is permitted to signal a
859859
condition of the following class, which is a subclass of
860860
:drm:`<error>`:
861861

@@ -893,13 +893,13 @@ Exclusive locks
893893
The notion of ownership is directly supported by the class, and a
894894
thread can test whether an :class:`<exclusive-lock>` is currently owned.
895895
An instance of :class:`<exclusive-lock>` can only be owned by one thread
896-
at a time, by calling *wait-for* on the lock.
896+
at a time, by calling :gf:`wait-for` on the lock.
897897

898898
Once owned, any attempt by any other thread to wait for the lock
899899
will cause that thread to block. It is an error for a thread to
900900
release an :class:`<exclusive-lock>` if another thread owns it.
901901

902-
:class:`<exclusive-lock>` has no direct instances; calling *make* on
902+
:class:`<exclusive-lock>` has no direct instances; calling :drm:`make` on
903903
:class:`<exclusive-lock>` returns an instance of :class:`<simple-lock>`.
904904

905905
:operations:
@@ -921,7 +921,7 @@ Exclusive locks
921921

922922
:conditions:
923923

924-
Implementations of *release* methods for subclasses of
924+
Implementations of :gf:`release` methods for subclasses of
925925
:class:`<exclusive-lock>` are permitted to signal a condition
926926
of the following class, which is a subclass of :drm:`<error>`:
927927

@@ -935,7 +935,7 @@ Exclusive locks
935935
Releases a lock that is owned by the calling thread. It is an error
936936
if the lock is not owned.
937937

938-
The Threads module does not provide a method on *release* for
938+
The Threads module does not provide a method on :gf:`release` for
939939
:class:`<exclusive-lock>`, which is an open abstract class. Each
940940
concrete subclass will have an applicable method which may signal
941941
errors according to the protocol described above.
@@ -1359,19 +1359,19 @@ Notifications
13591359
for another thread to release the notification. The current thread
13601360
reclaims the lock once it has received the notification.
13611361

1362-
Note that the state should be tested again once *wait-for* has
1362+
Note that the state should be tested again once :gf:`wait-for` has
13631363
returned, because there may have been a delay between the
13641364
:meth:`release <release(<notification>)>` of the notification and
13651365
the claiming of the lock, and the state may have been changed
13661366
during that time. If a timeout is supplied, then this is used for
1367-
waiting for the release of the notification only. The *wait-for*
1367+
waiting for the release of the notification only. The :gf:`wait-for`
13681368
function always waits for the lock with no timeout, and it is
1369-
guaranteed that the lock will be owned on return. The *wait-for*
1369+
guaranteed that the lock will be owned on return. The :gf:`wait-for`
13701370
function returns :drm:`#f` if the notification wait times out.
13711371

13721372
:conditions:
13731373

1374-
Implementations of this *wait-for* method are permitted to signal a
1374+
Implementations of this :gf:`wait-for` method are permitted to signal a
13751375
condition of the following class, which is a subclass of :drm:`<error>`:
13761376

13771377
:class:`<not-owned-error>`
@@ -1392,7 +1392,7 @@ Notifications
13921392

13931393
:conditions:
13941394

1395-
Implementations of this *release* method are permitted to signal a
1395+
Implementations of this :gf:`release` method are permitted to signal a
13961396
condition of the following class, which is a subclass of
13971397
:drm:`<error>`:
13981398

@@ -1420,7 +1420,7 @@ Notifications
14201420

14211421
:conditions:
14221422

1423-
Implementations of the *release-all* function are permitted to signal a
1423+
Implementations of the :gf:`release-all` function are permitted to signal a
14241424
condition of the following class, which is a subclass of :drm:`<error>`:
14251425

14261426
:class:`<not-owned-error>`
@@ -1457,7 +1457,7 @@ Thread variables
14571457
.. macro:: thread
14581458
:macro-type: variable definition adjective
14591459

1460-
An adjective to *define variable* for defining thread variables.
1460+
An adjective to :drm:`define variable` for defining thread variables.
14611461

14621462
:macrocall:
14631463
.. parsed-literal:: define thread variable `bindings` = `init` ;

0 commit comments

Comments
 (0)