doc/glossary.xml: A few DocBook mark-up changes.
authorIan Abbott <abbotti@mev.co.uk>
Wed, 9 May 2012 15:05:02 +0000 (16:05 +0100)
committerIan Abbott <abbotti@mev.co.uk>
Wed, 9 May 2012 15:05:02 +0000 (16:05 +0100)
doc/glossary.xml

index 1f93e28a267d3b64691212447b289c658f1abc58..0be93fc0af024b4408ed736991295aa59eee5295 100644 (file)
@@ -34,8 +34,9 @@ buffer
 &comedi; uses permanently allocated kernel memory for streaming input
 and output to store data that has been measured by a device, but has
 not been read by an application.  These buffers can be resized by the
-Comedilib function <function>comedi_buffer_XXX()</function> or the
-<function>comedi_config</function>
+Comedilib functions <function>comedi_set_buffer_size</function> and
+<function>comedi_set_max_buffer_size</function> or the
+<command>comedi_config</command>
 utility.
       </para>
     </glossdef>
@@ -51,7 +52,7 @@ This is an error message that indicates that the driver ran out of
 space in a &comedi; buffer to put samples.  It means that the application
 is not copying data out of the buffer quickly enough.  Often, this
 problem can be fixed by making the &comedi; buffer larger.  See
-<function>comedi_buffer_XXX</function> for more information.
+<function>comedi_set_buffer_size</function> for more information.
       </para>
     </glossdef>
   </glossentry>
@@ -79,7 +80,8 @@ a device and the main memory of a computer.  DMA operates differently
 on ISA and PCI cards.  ISA DMA is handled by a controller on the
 motherboard and is limited to transfers to/from the lowest 16 MB of
 physical RAM and can only handle a single segment of memory at a time.
-These limitations make it almost useless.  PCI ("bus mastering") DMA
+These limitations make it almost useless.  PCI (<quote>bus
+mastering</quote>) DMA
 is handled by a controller on the device, and can typically address
 4 GB of RAM and handle many segments of memory simultaneously.  DMA
 is usually not the only means to data transfer, and may or may not
@@ -178,7 +180,7 @@ option list
     </glossterm>
     <glossdef>
       <para>
-Option lists are used with <function>comedi_config</function> to
+Option lists are used with the <command>comedi_config</command> utility to
 perform driver configuration.
       </para>
       <glossseealso otherterm="configoption"></glossseealso>
@@ -207,10 +209,10 @@ poll
       <para>
 The term poll (and polling) is used for several different related
 concepts in &comedi;.  &comedi; implements the
-<function>poll()</function> system call for Comedi devices, which is
-similar to <function>select()</function>, and returns information
+<function>poll</function> system call for Comedi devices, which is
+similar to <function>select</function>, and returns information
 about file descriptors that can be read or written.  Comedilib also
-has a function called <function>comedi_poll()</function>, which causes
+has a function called <function>comedi_poll</function>, which causes
 the driver to copy all available data from the device to the &comedi;
 buffer.  In addition, some drivers may use a polling technique in
 place of interrupts.