doc: Add Comedilib version number

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.

demo/tut3.c: memset options to 0 before modifying

options.verbose was used uninitialized.

demo/tut3: Removed a couple of unused variables.

demo/pwm: Removed an unused variable.

demo/pwm: Bug fix - should have called comedi_close()

The code called close(device) instead of comedi_close(device) where
device came from comedi_open.

demo/choose_clock: Fix a printf.

"Selecting master clock %d for channel %d on subdevice %d.\n"

The %d after subdevice was missing although the corresponding parameter
in the argument list was present.

comedi_board_info: Moved man page into ../man

I'm not sure if all man pages should go in the general 'man'
subdirectory or a more specific subdirectory, but as the general 'man'
subdirectory already contained a man page for comedi_config (which has
its own source subdirectory), I moved the man page for comedi_board_info
there for consistency.

Also changed the EXTRA_DIST line in man/Makefile.am.

doc/drivers.txt: Minor correction for USB-DUX-FAST.

The Devices line still showed USB-DUX-FAST as USB-DUX.

Updated the drivers.txt

Changed my e-mail address to the linux-usb-daq one to be
consistent with the driver e-mails which I also changed
to the company e-mails adress.

doc/funcref: Fix "Returns:" for comedi_to_physical.

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.

doc/funcref: Add links between comedi_to_phys and comedi_set_global_oor_behavior.

doc/funcref: Moved in comedi_set_global_oor_behavior

Moved function comedi_set_global_oor_behavior out of the deprecated
section as it is associated with the comedi_to_phys function.

Moved comedi_to_phys and comedi_from_phys back to the main
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.

doc/comedilib_html_config.xsl: Use numbered sections.

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.

doc/intro.xml: Replace a link to figure 1 with an xref.

demo/python/mmap.py: Fix buffer wraparound bug.

Fix bug reported by Ross Williamson where the code does not deal with
buffer wraparound within a chunk of data.

doc/other.xml: Add extra details about range and aref.

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!

doc/other.xml: Small DocBook mark-up fix.

Use proper mark-up for sqrt function in slowly varying inputs section.

doc/comedilib_dblatex_config.xsl: Set function.parens to "1".

Persuades dblatex to output parentheses for all the <function> tags,
even those without <parameter> tags inside.

doc/comedilib_html_config.xsl: Set function.parens to "1".

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.

doc/reference.xml: Added CR_PACK_FLAGS()

Added description of CR_PACK_FLAGS() macro and the various flag bits.

doc/glossary.xml: A few DocBook mark-up changes.

doc/driverwriting.xml: Various changes.

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.

doc/extensions_funcref.txt: Some DocBook mark-up changes.

doc/error_funcref.txt: Some DocBook mark-up changes.

doc/dio_funcref.txt: Some DocBook mark-up changes.

doc/deprecated_funcref.txt: Some DocBook mark-up changes.

doc/calibration_funcref.txt: Some DocBook mark-up changes.

doc/command_funcref.txt: Some DocBook mark-up changes.

doc/funcref: Some DocBook mark-up changes.

doc/install.xml: Fixed a link.

doc/reference.xml: Minor change.

Used a proper cross reference to driver structures.

doc/other.xml: More DocBook mark-up changes.

More changes, mostly adding <structfield> tags.

doc/comedilib.ent: Got rid of a couple of redundant entities.

Got rid of the 'hellip' and 'uuml' entities in favour of predefined
versions of these entities.

doc/install.xml: A few DocBook mark-up changes.

doc/tutorial.xml: A few DocBook mark-up changes.

doc/other.xml, reference.xml: Slowly varying inputs and comedi triggers

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.

doc/reference.xml: Improve description of comedi_insnlist...

... by adding a link to the comedi_do_insnlist function.

doc/reference.xml: Removed some comedilib internals.

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.

doc/reference.xml: More DocBook mark-up changes.

doc: Use a stylesheet for dblatex

Add comedilib_dblatex_config.xsl stylesheet and pass it to dblatex when
producing PDF output.  The current version of the stylesheet doesn't
make much difference to the output, but it's somewhere we can put stuff
later.

We probably want to do something similar for the other PDF backends, but
those are currently broken anyway.

doc/other.xml: Moved a few tags around and minor changes.

Moved <link> tags inside <function>, <type>, <constant> etc. tags so
fonts stay a bit more consistent.

Merge branch 'master' of git://comedi.org/git/comedi/comedilib

Removed a para from the section about proc which mentioned an NI
card but that's now the dux board from above actually.

Just spotted that the documentation also talks about board_info.
I've updated it as well: explained the new command comedi_board_info.

Added a couple of sentences about async acquisition and the
two modes cards do it and then mentioned our new board_info.

Changed some of the descriptions for the SDF flags which were
a bit misleading.

Just what I said in the git log is now also actually in the man page
namely that the frequency option is only there for debugging.

Added comedi_board_info which has been inspired by the original
info in the demo directory. I've made it a bit more verbose
and also took into account that now the generic_timed command
takes more than one channel so that a user can experiment which
sampling rates are possible with different channel numbers.
I've also added an option to set the sampling rate for the generic_timed
command. That sould actually not be needed but I'm sure there
are drivers out there which do not correct the sampling rate
downwards automatically.

Added info that '-n' is used to select the waveform.

Merge branch 'master' of ssh://comedi.org/git/comedi/comedilib

Created a PWM demo using the newly introduced defines to
manipulate PWM frequency.

doc/other.xml: More fiddling about.

More documentation tidy-ups.  I'll probably get bored eventually!

doc/comedilib.xml: Add myself (Ian Abbott) to list of authors.

doc/tutorial.xml: Fix a broken link.

doc/other.xml: Use comedi_dio_bitfield2 instead of comedi_dio_bitfield.

Rework text to use comedi_dio_bitfield2 as comedi_dio_bitfield is marked
as deprecated elsewhere in the document.

I've added a bit more "meat" to the asynchronous acquisition section
and added myself to the authors section.

configure: Avoid PDF generation by default if don't have dblatex

Changed handling of --with-pdf-backend[=yes] to avoid picking the default
xmlto backend for PDF generation because it's broken.

The default xmlto backend for PDF generation can still be selected using
--with-pdf-backend=default if you really want to try it.

doc/funcref: Added missing comedi_data_read_n

There was a broken link to the comedi_data_read_n function from
elsewhere, so we'd better add a section for it.

doc: Use ansi style funcsynopsis for html output.

Set XSL parameter "funcsynopsis.style" to "ansi" in the XSL stylesheet
used for HTML output (comedilib_html_config.xsl).

doc/mkref: Add some refmiscinfo for man pages

Make the man pages a bit neater.

doc/other.xml: Some DocBook markup changes.

doc: A few whitespace tweaks in program listings

doc/other.xml: Replaced simplelists

Replaced some simplelists with variablelists to fix some dblatex layout
problems.

I've updated the manual in the section configuration and
also updated the tutorial. I've simplified the tut2.c
by using comedi2phys instead of comedi2physical. The use of
polynomials as a 2nd comedi program is a bit too difficult
for a novice and might deter the user to dig deeper into
the coding. Also, I've added tut3.c which is a stripped
down version of cmd.c and of that again the relevant lines
for the handbook to save space.

Removed old hotplug install which is no longer used at all and
just left udev as the only hotplug mechanism. I've also added
an option to disable the installation of the firmware. This
is useful for debian or ubuntu packages where the firmware
is now provided by a package accompanying the staging kernel.
All usbdux files are included in the kernel firmware packages.
Package maintainers should use the --disable-firmware option.

doc/other.xml: Make table of configuration instructions less ugly.

The PDF output of the table of configurations was awful.  Fiddled with
the column widths a bit and simplified the layout "Meanings of data[1],..."
column to allow it to wrap.

configure: Allow choice of backend for PDF generation.

Add --with-pdf-backend=[yes|no|dblatex|fop|default] option which
defaults to "yes".  This controls the option passed to 'xmlto' to
generate PDFs.

If set to "yes" (the default) it looks for 'dblatex' and uses it as the
backend for 'xmlto' if found, otherwise 'xmlto' will use the default
backend.

If set to "no" (same as --without-pdf-backend), PDF generation is
disabled.

If set to "dblatex" it looks for 'dblatex' and uses it as the backend
for 'xmlto' if found, otherwise PDF generation is disabled.

If set to "fop" it looks for 'fop' and uses it as the backend
for 'xmlto' if found, otherwise PDF generation is disabled.

If set to "default", 'xmlto' will use the default backend.

doc/drivers.txt: Rebuilt from comedi

Rebuilt "doc/drivers.txt" using "make Documentation/comedi/drivers.txt"
in the Comedi package.  Note: this scans the driver sources included
with the comedi.org Comedi package, not the Linux "staging" Comedi
sources, so some newer, staging-only drivers are missing.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>

doc/Makefile.am: Create directory for pdf output

dblatex is passed the option `-o $(srcdir)/pdf`, but if this directory
does not exist, the PDF file is created with the name 'pdf' in
$(srcdir).  Make the directory so that the -o option treats the
specified name as an output directory instead of an output filename.

etc/hotplug/usbduxsigma: Remove Makefile and Makefile.in ...

... but keep Makefile.am of course!

Updated usbdux firmware files. The udev hotplug mechanism
now takes binary files and no longer hex files. Also
added the firmware for usbduxsigma.

Fixed an issue reported by Graeme Hattan that the udev
rules were installed in the etc directory and not the lib.
See also:
http://lintian.debian.org/tags/udev-rule-in-etc.html
./configure --with-udev-hotplug=/lib places now all
files in /lib. The scripts were wrongly prefixed with the
sysconf directory which is /etc but should be /lib.
The directory is now also taken from --with-udev-hotplug=/lib.

Fixed a path issue with comedilib.pdf. Got correctly
saved into the pdf subfolder but install exprected
it in the doc folder.

Removed two scripts which are no longer used by hotplug.
In the early udev days the firmware had to be uploaded
by comedi_config. However now the driver requests the
firmware by itself and there is no need to have dedicated
scripts for every kernel module in udev.

automake now checks for dblatex and the pdf version
of the comedi manual is now generated

Comedilib.pdf can now be generated with
dblatex -t pdf ./comedilib.xml

There were two major issues in the comedilb.xml:
1) there were too many nested sections so that
   latex ran out of sub-sub-sub-sub-sections.
2) A section needs a title and can no longer
   exist without one. The first line
   of the textfiles contains now the title
   and will be inserted by mkref into the xml file.

todo: switch from xmlto to dblatex for the pdf generation
and re-enable it in the makefile.

Generate ChangeLog from git log during 'make dist'

Generate the ChangeLog using git log in the dist-hook target of the main
Makefile.  The git command used is:

git log --stat --name-only --date=iso

The format of the resulting ChangeLog is different to the old one that
was produced with cvs2cl.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>

doc/reference.xml: Added section for comedi_polynomial_t.

The tutorial.xml contained links to a missing section for the
comedi_polynomial_t type, so I added one.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>

doc/Makefile: Remove *.css files on uninstallation.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>

Makefile.am: Remove 'debian' from EXTRA_DIST.

The 'debian' target doesn't exist and there is no rule to make it, so
remove it from EXTRA_DIST.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>

Makefile.am: Don't bother removing CVS directories in dist-hook.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>

todo: Added note about Ruby bindings disabled by default.

Signed-off-by: Ian Abbott <abbotti.mev.co.uk>

configure.ac: Use AS_HELP_STRING()

Use AS_HELP_STRING() to make the HELP-STRING arguments for the
AC_ARG_ENABLE() and AC_ARG_WITH() macro calls.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>

configure: Disable Ruby bindings by default.

The SWIG Ruby bindings do not build cleanly from scratch.  They need an
existing installation of comedilib.  So disable them in the default
configuration.  They can be enabled with the --enable-ruby-bindings
configure option.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>

include/comedi.h: synced with comedi

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>

driverwriting.xml: COMEDI_CB_EOA is also used to report end-of-output.

driverwriting.xml: COMEDI_CB_OVERFLOW is also used to report underflows.

Add myself to the comedi.i copyright, since I just tweaked it.

I also added 2010 for:

  commit 3fe8e6baac051d80906c6fac6c18c04c8df9ce4a
  Author: Ian Abbott <abbotti@mev.co.uk>
  Date:   Mon Dec 20 14:50:21 2010 +0000

    Add sampl_t and lsampl_t array_class()es to comedi.i.
    ...
    Patch from W. Trevor King.

Suggest people use `PYTHONPATH` rather than adjusting `sys.path` internally.

The old method only worked out of the box if you were running Python
2.1 on a 586.  I imagine that is too small a slice of current users to
be worth hard coding ;).

Add myself to the old Python demo copyrights, since I just tweaked each demo.

Oops, fix copyright month on `demo/python/insn.py`.

Cast the period to an integer in `demo/python/mmap.py`'s command setup.

This avoids:

   Traceback (most recent call last):
     ...
     File ".../mmap.py", line 96, in prepare_cmd
       C.scan_begin_arg = 1e9/freq
     ...
   TypeError: in method 'comedi_cmd_struct_scan_begin_arg_set',
      argument 2 of type 'unsigned int'

Adjust `sys.path` before importing `mmap` in `demo/python/mmap.py`.

With the previous implementation, `mmap` was importing the demo
script, not the standard `mmap` library module.  From the docs [1]:

  The directory containing the script being run is placed at the
  beginning of the search path, ahead of the standard library
  path. This means that scripts in that directory will be loaded
  instead of modules of the same name in the library directory.

I'm not sure when this changed in Python, since the demo script
presumably worked with an earlier version.

[1]: http://docs.python.org/tutorial/modules.html#the-module-search-path

Cast the period to an integer in `demo/python/cmd.py`'s command setup.

This avoids:

  TypeError: in method 'comedi_get_cmd_generic_timed',
    argument 5 of type 'unsigned int'

Add serial and PWM subdevice types to `demo/python/info.py`.

This catches it up for the folowing commits to the comedi repository:

  commit 311e9c540217d60bdf56a1dba9eafe474fd3b218
  Author: Bernd Porr <Bernd.Porr@f2s.com>
  Date:   Sun Jan 13 23:07:02 2008 +0000

    Added a proper PWM subdevice for comedi.

  commit 8092ed57ff38e1fcaf75a7e0bf3b8c4f5372f3d7
  Author: Frank Mori Hess <fmhess@speakeasy.net>
  Date:   Sat Jan 31 22:13:09 2004 +0000

    serial dio (SCXI) support from Caleb Tennis

Add `chanlist_len` to `comedi_get_cmd_generic_timed()` calls in Python demos.

This catches the Python demos up to:

  commit 003b9ec501b5c69f25bfbc68e8b3f923d482bb04
  Author: Ian Abbott <abbotti@mev.co.uk>
  Date:   Mon Nov 8 11:01:42 2010 +0000

    Add chanlist_len parameter to comedi_get_cmd_generic_timed.

Add `demo/python/insn.py`, a Python clone of `demo/insn.c`.

Add an `insn_array` array_class to `comedi.i`.

This makes it possible to populate `comedi_insnslist_struct` for use
with `comedi_do_insnlist`.

I also removed my earlier re-typedefs of `sampl_array` and
`lsampl_array`.  I didn't understand the reason for the underlying
`TypeError` when I added them.  The proper way to avoid that error is
to use the `.cast()` and `.frompointer()` methods.  See
`demo/python/insn.py` (coming soon) for details.