stv0g/comedilib
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
1254 commits 2 branches 20 tags 2 MiB
Commit graph

195 commits

Author SHA1 Message Date
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
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
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
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
Ian Abbott
be4e3b4007 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.
 2012-04-25 17:14:16 +01:00
Ian Abbott
08448172d8 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>
 2012-04-23 18:12:41 +01:00
Ian Abbott
31b558634a 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.
 2012-04-23 17:52:06 +01:00
Bernd Porr
456421c4f6 Fixed a path issue with comedilib.pdf. Got correctly 
saved into the pdf subfolder but install exprected
it in the doc folder.
 2012-04-23 12:43:04 +01:00
Bernd Porr
9a76f63cd3 automake now checks for dblatex and the pdf version 
of the comedi manual is now generated
 2012-04-23 12:22:16 +01:00
Bernd Porr
0d8c6e9661 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.
 2012-04-23 00:23:03 +01:00
Ian Abbott
a61c28c696 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>
 2012-04-20 13:28:15 +01:00
Ian Abbott
4f21a64daa doc/Makefile: Remove *.css files on uninstallation. 
Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
 2012-04-20 12:26:34 +01:00
W. Trevor King
679c0fb5f7 driverwriting.xml: COMEDI_CB_EOA is also used to report end-of-output. 2012-04-16 08:58:20 -04:00
W. Trevor King
1fd268ccdb driverwriting.xml: COMEDI_CB_OVERFLOW is also used to report underflows. 2012-04-16 07:52:48 -04:00
Ian Abbott
b8a4f1a265 Added channel parameter to comedi_set_clock_source() and 
comedi_get_clock_source().  Bumped library version to 0.10.0.
 2010-03-19 13:44:56 +00:00
Ian Abbott
c234d5afbc Oops, I missed one of the info to board_info changes. 2008-12-18 11:43:27 +00:00
Ian Abbott
80ac38a5b1 demo/info is now demo/board_info. Thanks to JuanPi for pointing it out. 2008-12-18 11:23:48 +00:00
Frank Mori Hess
f21482f6c2 Added specification of return value for comedi_dio_bitfield2. 2008-05-01 17:30:11 +00:00
Frank Mori Hess
758813e955 Added description of return value from comedi_internal_trigger(). 2008-03-28 21:11:49 +00:00
Frank Mori Hess
8952c74075 Added reference entry for comedi_get_hardware_buffer_size(). 2008-03-28 18:16:45 +00:00
Frank Mori Hess
7e3ad2a0fd Made it very slightly more clear that comedi_apply_calibration is only 
useful for hardware-calibrated boards.
 2008-03-14 18:22:24 +00:00
Ian Abbott
051f58fd8b Sync with comedi 2008-02-21 12:59:07 +00:00
Frank Mori Hess
cd0469894b Made mkref script handle the case of a void parameter correctly. Allowed 
text lines to begin with any whitespace character (not just space).
 2008-02-13 20:14:38 +00:00
Frank Mori Hess
d127a63155 Updated references for error reporting functions. 2008-02-13 20:13:39 +00:00
Frank Mori Hess
7eb7a64566 Updated the dio function reference 2008-02-12 19:31:26 +00:00
Frank Mori Hess
2d4cc8f6d0 Updated and added some links to reference for asynchronous command 
functions.
 2008-02-12 17:01:43 +00:00
Frank Mori Hess
d2809f82d5 Added some "type" elements to docbook output, although they don't really 
have much effect.
 2008-02-11 16:42:28 +00:00
Frank Mori Hess
a7ece13dbd Added a link and remove some wrong (obsolete?) bits in the description 
of comedi_cancel().
 2008-02-11 16:25:15 +00:00
Frank Mori Hess
4e7a93e646 Rearranged section heirarchy. Made capitalization of section titles 
consistent.
 2008-02-11 15:50:36 +00:00
Frank Mori Hess
86a6fa5989 Added section for comedi_subdevice_type enum. 2008-02-08 21:42:25 +00:00
Frank Mori Hess
3a5c3a8fb0 Added some links to core function references, and fixed some bitrot. 
Deprecated comedi_set_global_oor_behavior since it only affects
comedi_to_phys (which is already deprecated).
 2008-02-08 21:41:32 +00:00
Frank Mori Hess
db048dfa6f Fixed some spelling errors "sucess"->"success". 2008-02-08 19:02:18 +00:00
Frank Mori Hess
e3526fbd7c Removed some wrong or obsolete information. Made it xinclude the 
tutorial programs tut1.c and tut2.c
 2008-02-08 18:48:27 +00:00
Frank Mori Hess
d73685a254 Minor tweak to comedi_get_softcal_converter description. 2008-02-08 18:28:26 +00:00
Frank Mori Hess
6639f730fc Some minor tweaks. 2008-02-07 19:58:13 +00:00
Frank Mori Hess
cdb1384675 Updated drivers.txt from comedi 0.7.76 2008-01-28 21:34:06 +00:00
Frank Mori Hess
064f43b4f8 Added css stylesheet for html docs. At the momment, it just gives a 
light gray background to display of "programlisting" elements.
 2008-01-28 19:30:01 +00:00
Frank Mori Hess
32c98f9506 Added some links. 2008-01-25 15:00:01 +00:00
Frank Mori Hess
d5d5d74cf5 Links to http://www.comedi.org everywhere. 2008-01-24 21:35:24 +00:00
Frank Mori Hess
0b172a6493 Did a little editing and updating for bitrotten parts. 2008-01-24 21:09:32 +00:00