This patch documents the new interpretation of stop_arg when stop_src ==
TRIG_NONE. In the new interpretation, if stop_src==TRIG_NONE, a user may
specify that a buffer of finite length (and less than or equal to the
maximum buffer size) be repeated indefinitely.
For now, only the NI MIO driver implements this new interpretation. All
other drivers should continue to force stop_arg==0 when
stop_src==TRIG_NONE. In this case, the old behavior is maintained.
In "comedilib.ent", Add an XML entity 'comedilib_version' expanding to
the Comedilib version '0.10.0'. This is hard-edited in rather than set
dynamically. Setting it dynamically would be nice but producing it from
an AC_OUTPUT() file isn't all that nice as it would end up in the
'build' tree and we'd some ugly 'make' rule to copy it to the 'source'
tree. For now, just edit it manually as required. At least having it
as an entity means it only needs to be set in a single documentation
file!
In "comedilib.xml", change the subtitle to mention Comedilib and the
version number, using the comediliv_version entity.
There was a stray space before the "Returns:" heading so it wasn't
processed as intended. Also, there was an empty line above it leading
to an empty paragraph in the DocBook funcref.xml.
section. Both comedi_to_phys and comedi_to_physical complement
each other. Comedi_to_phys is linear and very fast whereas
comedi_to_physical is more precise but requires polynomials
and calibration data.
Change DocBook XSL parameters for HTML output to use numbered sections
(like it was before we switched from SGML to XML) and to use just the
numbers in cross references, rather than number and/or title.
Add extra detail to the section on acquisition functions about the
range and aref parameters, and describe the comedi_range type.
The whole section is still a bit higgledy-piggledy and could do with
some rearrangement one day!
This makes sure the HTML output for
<function>foo<parameter>bar</parameter><parameter>baz</parameter></function>
includes parentheses, although it doesn't seem to add empty parentheses
after a plain <function>foo</function> which perhaps it should.
Some DocBook mark-up changes. Also avoided absolute path-names for
sources as people tend to put them in different places! Also changed
instructions for submitting drivers for review.
Mention that the stuff that relies on the COMEDI_TRIG ioctl, including
the slowly varying input (comedi_sv_...) functions no longer work with
current versions of the Comedi kernel layer.
Removed subdevice_struct as it is internal to comedilib. Removed
struct comedi_t_struct, leaving only the comedi_t typedef as
applications only see it as a pointer to an opaque, incomplete type.
