Changeset 15497


Ignore:
Timestamp:
Nov 15, 2012, 4:25:55 PM (7 years ago)
Author:
rme
Message:

Document new :error-if-exited keyword argument to the
signal-external-process function. See ticket:1015.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/source/doc/src/external-process.xml

    r15288 r15497  
    306306          <refsynopsisdiv>
    307307            <synopsis><function>signal-external-process</function>
    308             proc signal-number</synopsis>
     308            proc signal-number &key; (error-if-exited t)</synopsis>
    309309          </refsynopsisdiv>
    310310
     
    328328                </listitem>
    329329              </varlistentry>
    330             </variablelist>
    331           </refsect1>
    332 
    333           <refsect1>
    334             <title>Description</title>
    335 
    336             <para>Sends the specified "signal" to the specified
    337             external process. (Typically, it would only be useful to call
    338             this function if the EXTERNAL-PROCESS was created with :WAIT
    339             NIL. ) Returns T if successful; signals an error otherwise.</para>
     330              <varlistentry>
     331                <term>error-if-exited</term>
     332
     333                <listitem>
     334                  <para>A boolean, by default T.</para>
     335                </listitem>
     336              </varlistentry>
     337            </variablelist>
     338          </refsect1>
     339
     340          <refsect1>
     341            <title>Description</title>
     342
     343            <para>
     344              Sends <varname>signal</varname> to the external process
     345              <varname>proc</varname>. (Typically, it would only be
     346              useful to call this function if the EXTERNAL-PROCESS was
     347              created with :WAIT NIL.)
     348            </para>
     349            <para>
     350              If successful, the function returns T; otherwise, an
     351              error is signaled.
     352            </para>
     353            <para>
     354              However, if <varname>error-if-exited</varname> is nil,
     355              and the attempt to signal the external process fails
     356              because the external process has already exited, the
     357              function will return nil rather than signaling an error.
     358            </para>
    340359          </refsect1>
    341360        </refentry>
Note: See TracChangeset for help on using the changeset viewer.