Ignore:
Timestamp:
Mar 18, 2008, 1:49:58 PM (12 years ago)
Author:
jaj
Message:

This commit includes support for docbook 4.5, stylesheet changes, and updated documentation.

In order to support docbook 4.5 in nXML mode, I have added a new directory called docbook-rng-4.5 and changed schemas.xml to point to it. This should just work when editing the documentation in EMACS.

The two most obvious changes to the stylesheets are that the table of contents for each chapter now occurs at the beginning of the chapter, and the format for refentries is cleaner and more concise.

I think that we should consistently use refentry elements for all of the definitions of functions, macros, variables, etc. This retains the structured data for the definitions that can be reformatted to have different appearences by the stylesheets. We should also consistently use other docbook elements such as function and varname. I'm not really happy with their appearance right now, but that can be easily tweaked in the stylesheets as long as they are consistently used throughout the documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/source/doc/src/sockets.xml

    r8606 r8820  
    11<?xml version="1.0" encoding="utf-8"?>
    2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
     2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
    33<!ENTITY rest "<varname>&amp;rest</varname>">
    44<!ENTITY key "<varname>&amp;key</varname>">
     
    77<!ENTITY aux "<varname>&amp;aux</varname>">
    88<!ENTITY allow-other-keys "<varname>&amp;allow-other-keys</varname>">
    9 <!ENTITY CCL "<literal>CCL</literal>">
     9<!ENTITY CCL "Clozure CL">
    1010]>
    1111
     
    106106
    107107        <refsynopsisdiv>
    108           <synopsis><function>make-socket</function>
    109           &key; address-family type connect eol format
    110           remote-host remote-port local-host local-port local-filename
    111           remote-filename keepalive reuse-address nodelay broadcast linger
    112           backlog</synopsis>
     108          <synopsis><function>make-socket</function> &key;
     109          address-family type connect eol format remote-host
     110          remote-port local-host local-port local-filename
     111          remote-filename keepalive reuse-address nodelay broadcast
     112          linger backlog input-timeout output-timeout connect-timeout
     113          auto-close deadline</synopsis>
    113114        </refsynopsisdiv>
    114115
     
    300301              </listitem>
    301302            </varlistentry>
     303
     304            <varlistentry>
     305              <term>input-timeout</term>
     306
     307              <listitem>
     308                <para>The number of seconds before an input operation
     309                times out.  Must be a real number between zero and one
     310                million.  If an input operation takes longer than the
     311                specified number of seconds, an
     312                <literal>input-timeout</literal> error is signalled.
     313                (see <xref
     314                linkend="Stream-Timeouts-And-Deadlines"/>)</para>
     315              </listitem>
     316            </varlistentry>
     317
     318            <varlistentry>
     319              <term>output-timeout</term>
     320
     321              <listitem>
     322                <para>The number of seconds before an output operation
     323                times out.  Must be a real number between zero and one
     324                million.  If an output operation takes longer than the
     325                specified number of seconds, an
     326                <literal>output-timeout</literal> error is signalled.
     327                (see <xref
     328                linkend="Stream-Timeouts-And-Deadlines"/>)</para>
     329              </listitem>
     330            </varlistentry>
     331
     332            <varlistentry>
     333              <term>connect-timeout</term>
     334
     335              <listitem>
     336                <para>The number of seconds before a connection
     337                attempt times out. [TODO: what are acceptable values?]
     338                If a connection attempt takes longer than the
     339                specified number of seconds, a
     340                <literal>socket-error</literal> is signalled.  This
     341                can be useful if the specified interval is shorter
     342                than the interval that the OS's socket layer imposes,
     343                which is sometimes a minute or two.</para>
     344              </listitem>
     345            </varlistentry>
     346
     347            <varlistentry>
     348              <term>auto-close</term>
     349
     350              <listitem>
     351                <para>When non-nil, any resulting socket stream will
     352                be closed when the GC can prove that the stream is
     353                unreferenced.  This is done via CCL's termination
     354                mechanism [TODO add xref].</para>
     355              </listitem>
     356            </varlistentry>
     357            <varlistentry>
     358              <term>deadline</term>
     359
     360              <listitem>
     361                <para>Specifies an absolute time in
     362                internal-time-units.  If an I/O operation on the
     363                stream does not complete before the deadline then a
     364                <literal>COMMUNICATION-DEADLINE-EXPIRED</literal>
     365                error is signalled.  A deadline takes precedence over
     366                any input/output timeouts that may be set.  (see <xref
     367                linkend="Stream-Timeouts-And-Deadlines"/>)</para>
     368              </listitem>
     369            </varlistentry>
     370
    302371          </variablelist>
    303372        </refsect1>
Note: See TracChangeset for help on using the changeset viewer.