Commit graph

1282 commits

Author SHA1 Message Date
Ian Abbott
98869fa36d doc/other.xml: Small DocBook mark-up fix.
Use proper mark-up for sqrt function in slowly varying inputs section.
2012-05-09 17:40:34 +01:00
Ian Abbott
2c729dbb34 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.
2012-05-09 17:28:58 +01:00
Ian Abbott
24d02fde41 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.
2012-05-09 17:22:31 +01:00
Ian Abbott
b41732fa62 doc/reference.xml: Added CR_PACK_FLAGS()
Added description of CR_PACK_FLAGS() macro and the various flag bits.
2012-05-09 17:12:23 +01:00
Ian Abbott
c3ba569f87 doc/glossary.xml: A few DocBook mark-up changes. 2012-05-09 16:05:02 +01:00
Ian Abbott
4a6276c257 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.
2012-05-09 15:50:17 +01:00
Ian Abbott
382f445b4a doc/extensions_funcref.txt: Some DocBook mark-up changes. 2012-05-09 14:45:18 +01:00
Ian Abbott
054ceeb77e doc/error_funcref.txt: Some DocBook mark-up changes. 2012-05-09 14:16:23 +01:00
Ian Abbott
32047d460b doc/dio_funcref.txt: Some DocBook mark-up changes. 2012-05-09 12:32:05 +01:00
Ian Abbott
4566a4a433 doc/deprecated_funcref.txt: Some DocBook mark-up changes. 2012-05-08 18:44:48 +01:00
Ian Abbott
c1cd802546 doc/calibration_funcref.txt: Some DocBook mark-up changes. 2012-05-08 18:08:56 +01:00
Ian Abbott
09106917de doc/command_funcref.txt: Some DocBook mark-up changes. 2012-05-08 17:08:16 +01:00
Ian Abbott
1c64dcb1b5 doc/funcref: Some DocBook mark-up changes. 2012-05-08 16:51:49 +01:00
Ian Abbott
eab51a0d94 doc/install.xml: Fixed a link. 2012-05-08 14:12:11 +01:00
Ian Abbott
5f95a358a6 doc/reference.xml: Minor change.
Used a proper cross reference to driver structures.
2012-05-08 14:04:55 +01:00
Ian Abbott
4874091364 doc/other.xml: More DocBook mark-up changes.
More changes, mostly adding <structfield> tags.
2012-05-08 13:58:27 +01:00
Ian Abbott
4bbaa29b41 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.
2012-05-08 12:25:28 +01:00
Ian Abbott
5d91ff685d doc/install.xml: A few DocBook mark-up changes. 2012-05-08 12:11:55 +01:00
Ian Abbott
a814061d88 doc/tutorial.xml: A few DocBook mark-up changes. 2012-05-08 11:35:22 +01:00
Ian Abbott
df4d8963de 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.
2012-05-04 18:45:33 +01:00
Ian Abbott
8fae5ac58c doc/reference.xml: Improve description of comedi_insnlist...
... by adding a link to the comedi_do_insnlist function.
2012-05-04 18:29:47 +01:00
Ian Abbott
683e685c9f 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.
2012-05-04 18:20:42 +01:00
Ian Abbott
c63732907e doc/reference.xml: More DocBook mark-up changes. 2012-05-04 18:10:55 +01:00
Ian Abbott
a3c29c87a8 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.
2012-05-04 16:32:35 +01:00
Ian Abbott
9bd59e1def 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.
2012-05-03 19:56:59 +01:00
Ian Abbott
2d82ee25b3 Merge branch 'master' of git://comedi.org/git/comedi/comedilib 2012-05-03 13:06:46 +01:00
Bernd Porr
048c280a9a Removed a para from the section about proc which mentioned an NI
card but that's now the dux board from above actually.
2012-05-03 02:11:14 +01:00
Bernd Porr
ee16e47509 Just spotted that the documentation also talks about board_info.
I've updated it as well: explained the new command comedi_board_info.
2012-05-03 02:07:30 +01:00
Bernd Porr
2d0ed0442c Added a couple of sentences about async acquisition and the
two modes cards do it and then mentioned our new board_info.
2012-05-03 01:24:22 +01:00
Bernd Porr
47b3edd6e2 Changed some of the descriptions for the SDF flags which were
a bit misleading.
2012-05-03 01:03:16 +01:00
Bernd Porr
33f3a2eada 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.
2012-05-03 00:52:13 +01:00
Bernd Porr
c22d498dc0 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.
2012-05-03 00:39:04 +01:00
Bernd Porr
74a1207a29 Added info that '-n' is used to select the waveform. 2012-05-02 18:40:07 +01:00
Bernd Porr
58e0e21ea9 Merge branch 'master' of ssh://comedi.org/git/comedi/comedilib 2012-05-02 17:59:46 +01:00
Bernd Porr
90ea57b2e9 Created a PWM demo using the newly introduced defines to
manipulate PWM frequency.
2012-05-02 17:58:15 +01:00
Ian Abbott
c1a454bb40 doc/other.xml: More fiddling about.
More documentation tidy-ups.  I'll probably get bored eventually!
2012-05-02 15:47:59 +01:00
Ian Abbott
708b802811 doc/comedilib.xml: Add myself (Ian Abbott) to list of authors. 2012-05-02 13:04:24 +01:00
Ian Abbott
ad6a93952f doc/tutorial.xml: Fix a broken link. 2012-05-02 13:01:41 +01:00
Ian Abbott
6892b40468 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.
2012-05-02 12:54:46 +01:00
Bernd Porr
aaa4514804 I've added a bit more "meat" to the asynchronous acquisition section
and added myself to the authors section.
2012-05-01 19:41:38 +01:00
Ian Abbott
14d401376f 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.
2012-05-01 18:03:57 +01:00
Ian Abbott
5392632a1c 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.
2012-05-01 17:42:15 +01:00
Ian Abbott
7655653daf 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).
2012-05-01 17:14:27 +01:00
Ian Abbott
cc82998ec7 doc/mkref: Add some refmiscinfo for man pages
Make the man pages a bit neater.
2012-05-01 16:54:39 +01:00
Ian Abbott
1d351bfa04 doc/other.xml: Some DocBook markup changes. 2012-05-01 15:42:07 +01:00
Ian Abbott
5fdc15c302 doc: A few whitespace tweaks in program listings 2012-05-01 12:51:08 +01:00
Ian Abbott
c938e2bf60 doc/other.xml: Replaced simplelists
Replaced some simplelists with variablelists to fix some dblatex layout
problems.
2012-05-01 11:48:46 +01:00
Bernd Porr
df6a97ec6c 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.
2012-04-27 01:37:33 +01:00
Bernd Porr
12155822bc 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.
2012-04-26 23:24:50 +01:00
Ian Abbott
e7a3e54042 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.
2012-04-25 18:34:54 +01:00