Changeset 8776


Ignore:
Timestamp:
Mar 13, 2008, 4:35:35 PM (12 years ago)
Author:
gz
Message:

document a few more trace variables, add indexterm entries for all definitions

File:
1 edited

Legend:

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

    r8775 r8776  
    3434
    3535    <para>
    36     <command><varname>TRACE</varname> {<replaceable>keyword</replaceable>
     36    <indexterm zone="trace"/>
     37    <command><varname id="trace">TRACE</varname> {<replaceable>keyword</replaceable>
    3738    <replaceable>global-value</replaceable>}* {<replaceable>spec</replaceable> |
    3839    (<replaceable>spec</replaceable> {<replaceable>keyword</replaceable>
     
    411412
    412413    <para>
    413     <command><varname>CCL:*TRACE-LEVEL*</varname> [Variable]</command>
    414     </para>
    415 
    416     <para>Variable bound to the current nesting level during execution of before and after trace actions.</para>
    417 
    418     <para>
    419       <command><varname>CCL:TRACE-FUNCTION</varname> <replaceable>spec</replaceable> &key; {<replaceable>keyword</replaceable> <replaceable>value</replaceable>}*  [Function]</command>
     414      <indexterm zone="trace-level"/>
     415      <command><varname id="trace-level">CCL:*TRACE-LEVEL*</varname>    [Variable]</command>
     416    </para>
     417
     418    <para>Variable bound to the current nesting level during execution of before and after trace actions.  The default printing actions use it to determine the amount of indentation.</para>
     419
     420    <para>
     421      <indexterm zone="trace-max-indent"/>
     422      <command><varname id="trace-max-indent">CCL:*TRACE-MAX-INDENT*</varname>    [Variable]</command>
     423    </para>
     424
     425    <para>The default before and after print actions will not indent by more than the value of <varname>ccl:*trace-max-indent*</varname> regardless of the current trace level.</para>
     426
     427    <para>
     428      <indexterm zone="trace-function"/>
     429      <command><varname id="trace-function">CCL:TRACE-FUNCTION</varname> <replaceable>spec</replaceable> &key; {<replaceable>keyword</replaceable> <replaceable>value</replaceable>}*    [Function]</command>
    420430    </para>
    421431     
     
    424434      <replaceable>keyword</replaceable>s are as for TRACE, except that all arguments are evaluated.
    425435    </para>
     436
     437    <para>
     438      <indexterm zone="trace-print-level"/>
     439      <command><varname id="trace-print-level">CCL:*TRACE-PRINT-LEVEL*</varname>   [Variable]</command>
     440    </para>
     441
     442    <para>The default print actions bind <varname>CL:*PRINT-LEVEL*</varname> to this value while
     443    printing. Note that this rebinding is only in effect during the default entry and exit messages.
     444    It does not apply to printing of <varname>:print-before/:print-after</varname> forms or any
     445    explicit printing done by user code.</para>
     446
     447    <para>
     448      <indexterm zone="trace-print-length"/>
     449      <command><varname id="trace-print-length">CCL:*TRACE-PRINT-LENGTH*</varname>    [Variable]</command>
     450    </para>
     451 
     452    <para>The default print actions bind <varname>CL:*PRINT-LENGTH*</varname> to this value while
     453    printing. Note that this rebinding is only in effect during the default entry and exit messages.
     454    It does not apply to printing of <varname>:print-before/:print-after</varname> forms or any
     455    explicit printing done by user code.</para>
     456
     457    <para>
     458      <indexterm zone="trace-bar-frequency"/>
     459      <command><varname id="trace-bar-frequency">CCL:*TRACE-BAR-FREQUENCY*</varname>    [Variable]</command>
     460    </para>
     461
     462    <para>By default, this is nil. If non-nil it should be a integer, and the default entry and exit messages will print a | instead of space every this many levels of indentation.</para>
     463
    426464
    427465  </sect1>
     
    506544
    507545    <para>
    508       <command><varname>CCL:MAP-FILE-TO-IVECTOR</varname>
     546      <indexterm zone="map-file-to-ivector"/>
     547      <command><varname id="map-file-to-ivector">CCL:MAP-FILE-TO-IVECTOR</varname>
    509548        <parameter>pathname</parameter>
    510549        <parameter>element-type</parameter>
     
    567606
    568607    <para>
    569       <command><varname>CCL:UNMAP-IVECTOR</varname>
     608      <indexterm zone="unmap-ivector"/>
     609      <command><varname id="unmap-ivector">CCL:UNMAP-IVECTOR</varname>
    570610        <parameter>displaced-array</parameter>
    571611        [Function]</command>
     
    580620
    581621    <para>
    582       <command><varname>CCL:MAP-FILE-TO-OCTET-VECTOR</varname>
     622      <indexterm zone="map-file-to-octet-vector"/>
     623      <command><varname id="map-file-to-octet-vector">CCL:MAP-FILE-TO-OCTET-VECTOR</varname>
    583624        <parameter>pathname</parameter>
    584625        [Function]</command>
     
    591632
    592633    <para>
    593       <command><varname>CCL:UNMAP-OCTET-VECTOR</varname>
     634      <indexterm zone="unmap-octet-vector"/>
     635      <command><varname id="unmap-octet-vector">CCL:UNMAP-OCTET-VECTOR</varname>
    594636        <parameter>displaced-array</parameter>
    595637        [Function]</command>
     
    630672
    631673    <para>
    632       <command><varname>DEFSTATIC</varname>
     674      <indexterm zone="defstatic"/>
     675      <command><varname id="defstatic">DEFSTATIC</varname>
    633676        <parameter>var</parameter>
    634677        <parameter>value</parameter>
Note: See TracChangeset for help on using the changeset viewer.