Changeset 14528

Timestamp:

Dec 30, 2010, 9:05:05 AM (14 years ago)

Author:

R. Matthew Emerson

Message:

Document with-interrupts-enabled. Document that unwind-protect
cleanup forms are executed as if wrapped in without-interrupts.

Location:

trunk/source/doc/src

Files:

• threads.xml (modified) (1 diff)
• using.xml (modified) (1 diff)

trunk/source/doc/src/threads.xml

@@ -2169 +2169 @@
     </refentry>
 
+    <refentry id="m_with-interrupts-enabled">
+          <indexterm zone="m_with-interrupts-enabled">
+            <primary>with-interrupts-enabled</primary>
+          </indexterm>
+
+          <refnamediv>
+            <refname>WITH-INTERRUPTS-ENABLED</refname>
+            <refpurpose>Evaluates its body in an environment in which
+              process-interrupt requests have immediate effect.</refpurpose>
+            <refclass>Macro</refclass>
+          </refnamediv>
+
+          <refsynopsisdiv>
+            <synopsis><function>with-interrupts-enabled</function>
+              &body; body => result</synopsis>
+          </refsynopsisdiv>
+
+          <refsect1>
+            <title>Arguments and Values</title>
+
+            <variablelist>
+              <varlistentry>
+                <term>body</term>
+                <listitem>
+                      <para>an implicit progn.</para>
+                </listitem>
+              </varlistentry>
+              <varlistentry>
+                <term>result</term>
+                <listitem>
+                      <para>the primary value returned by
+                        <varname>body</varname>.</para>
+                </listitem>
+              </varlistentry>
+            </variablelist>
+          </refsect1>
+
+          <refsect1>
+            <title>Description</title>
+
+            <para>Executes <varname>body</varname>
+              in an environment in which <xref linkend="f_process-interrupt"/>
+              requests have immediate effect.
+            </para>
+          </refsect1>
+    </refentry>
+
     <refentry id="f_make-lock">
           <indexterm zone="f_make-lock">

trunk/source/doc/src/using.xml

@@ -3248 +3248 @@
 </refentry>
 
+<refentry id="v_unwind-protect">
+  <indexterm zone="v_unwind-protect">
+    <primary>unwind-protect</primary>
+  </indexterm>
+  
+  <refnamediv>
+    <refname>UNWIND-PROTECT</refname>
+    <refpurpose>
+      Ensure cleanup-forms are executed.
+    </refpurpose>
+    <refclass>Special operator</refclass>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <synopsis>
+      <function>unwind-protect</function> protected-form {cleanup-form}*
+    </synopsis>
+  </refsynopsisdiv>
+
+  <refsect1><title>Summary</title>
+    <para>
+      In &CCL;, the cleanup forms are always executed as if they were
+      wrapped with <xref linkend="m_without-interrupts"/>.
+      To allow interrupts, use
+      <xref linkend="m_with-interrupts-enabled"/>.
+    </para>
+  </refsect1>
+</refentry>
 
 </sect1>