Commit graph

92 commits

Author SHA1 Message Date
Jeff Epler
996d682947 docs: improve some hm2_bspi manpages
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2017-06-17 21:16:05 -05:00
Sebastian Kuzminsky
ddfce26b74 hal_pin_new(3): clarify return value
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-04-22 09:11:09 -06:00
Sebastian Kuzminsky
7cf7f9f9d6 Merge remote-tracking branch 'origin/2.6' into 2.7 2015-12-12 18:13:29 -07:00
Sebastian Kuzminsky
c3304f1103 docs: fix manpage markup bug in rtapi_app_{main,exit}.3rtapi
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-12-12 18:11:38 -07:00
Jeff Epler
4c3c1609c1 manpages: document alias APIs
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-10-10 11:45:25 -05:00
Jeff Epler
f529fae1a7 rtapi: implement subset of <stdatomic.h>
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-08-03 19:06:43 -05:00
Sebastian Kuzminsky
5f9480d62c docs: ficks a typoe in rtapi_print(3) manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-07-14 14:56:58 -06:00
Jeff Epler
1ff8d47e9d rtapi: document that rtapi_task_self may be called from init/cleanup
.. and that it will return -EINVAL in this state

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-04-18 21:22:06 -05:00
Sebastian Kuzminsky
7021767c5f Merge remote-tracking branch 'origin/2.6' into 2.7 2015-04-03 17:09:56 -06:00
Sebastian Kuzminsky
de51d6bdb4 docs: fix hal_pin_new() and hal_param_new() manpages
The data types for the pin & parameter directions were wrong.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-04-01 08:33:25 -06:00
Norbert Schechner
e20164aba7 Merge branch '2.6' into 2.7 2014-12-27 18:47:12 +01:00
Sebastian Kuzminsky
4636af2152 docs: fixup manpage syntax for rtapi_app_main.3 & rtapi_app_exit.3
Before this, the rtapi_app_main.3 manpage had the #include and the
function declaration on the same line, this breaks them apart to separate
lines.

Also adds the #include <rtapi.h> to th rtapi_app_exit.3 manpage.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-12-27 08:56:06 -07:00
Sebastian Kuzminsky
00029a193b Merge remote-tracking branch 'origin/2.6' into 2.7 2014-12-25 11:44:19 -07:00
Sebastian Kuzminsky
7d2abeedb8 docs: fix inaccuracies in hal_init manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-12-25 11:43:38 -07:00
Sebastian Kuzminsky
37f73ab5f0 Merge origin/2.6 into 2.7 (using imerge) 2014-12-08 23:25:51 -07:00
Sebastian Kuzminsky
02b2bb3c94 docs: move the skeleton manpages out of the way
This means there's no need to filter out the skeletons from the manpage
list in the docs/src/Submakefile any more.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-12-05 23:33:03 -07:00
Sebastian Kuzminsky
e7e96c2742 docs: fix a misnamed rtapi manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-12-03 17:15:16 -07:00
Jeff Epler
bf9ee2de97 documentation: add manpage for rtapi_byteorder
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2014-10-02 19:19:36 -05:00
Jeff Epler
57e1d5465e docs: Note GPL license on files 2014-07-28 09:29:03 -05:00
Jeff Epler
756883ae61 rtapi: document rtapi_parport 2014-07-21 07:21:11 -05:00
Jeff Epler
d32671c21e rtapi: document new header 2014-07-21 07:21:11 -05:00
Jeff Epler
220f589ff6 rtapi: document new headers 2014-07-21 07:21:10 -05:00
Jeff Epler
3eac731ce7 rtapi: Can we run with realtime guarantee? 2014-07-20 20:49:09 -05:00
Jeff Epler
9a606843cb docs: Documentation changes for uspace 2014-07-20 20:49:09 -05:00
Jeff Epler
e2743b95fd rtapi: provide rtapi_bool.h
Including this header ensures that bool / true / false are available no matter
the circumstances (userspace / kernelspace, C / C++).
2014-07-20 20:49:08 -05:00
Jeff Epler
5c18f5a3b7 docs: Fix cut&paste errors
.. somebody forgot to fully customize their skeleton.
2014-07-12 10:24:06 -05:00
Sebastian Kuzminsky
3def129263 docs: rebrand manpages 2013-11-17 16:15:35 -07:00
Andy Pugh
3b736bb6ae Add (or make less ambiguous) the licensing of a number of files.
Signed-off-by: Andy Pugh <andy@bodgesoc.org>
2013-09-25 20:35:45 +01:00
Jeff Epler
a7ccc9add0 Add license notices
.. to these new-in-master files where git says I am the sole author
2013-09-18 21:43:00 -05:00
Jeff Epler
198b45e68f Merge branch 'v2.5_branch' 2013-09-17 11:28:35 -05:00
Jeff Epler
32460b2f95 document the interpretation of MODULE_LICENSE strings 2013-09-17 11:27:57 -05:00
Jeff Epler
6018a79e51 rtapi_math64: signed versions. (Seem to work, ap) 2013-09-08 21:42:54 +01:00
Andy Pugh
0cd2f98d52 Add support for the Hostmot2 UARTs
Signed-off-by: Andy Pugh <andy@bodgesoc.org>
2012-05-31 01:57:50 +01:00
Jeff Epler
f29fc9da60 rtapi_limits.h: define INT_MIN and friends portably
A quick check in LXR shows that in 2.6.28 and in 3.3 (and presumably the
intervening version), <linux/kernel.h> defines a dozen integer limit
macros including INT_MIN.
2012-04-05 10:55:01 -05:00
Michael Haberler
cf41ac29cf Merge branch 'v2.5_branch' 2012-01-27 20:16:12 +01:00
John Thornton
d4ff1bf165 Docs: re-branding
Signed-off-by: John Thornton <jthornton@gnipsel.com>
2012-01-27 07:02:25 -06:00
Sebastian Kuzminsky
b9baa4d105 Merge remote branch 'origin/v2.5_branch'
Conflicts:
	docs/src/gcode/overview.txt
	scripts/linuxcnc.in
2012-01-21 12:40:55 -07:00
Jeff Epler
f34124af79 manpages: say "LinuxCNC" 2012-01-19 18:31:23 -06:00
Jeff Epler
606d8328f6 hal: Introduce hal_bool, use it for hal_bit_t
The C99 _Bool type and the C++ bool type have an advantage over other
integral types: they only have two distinct values.  Expressions like
'b1 == b2', 'b1 << 3' and 'b1 ^ b2' behave like you would expect a
boolean type to behave, rather than having the problems that result from
using an integral type with more than two distinct values.
2011-11-17 15:05:56 -06:00
Andy
d696bccee3 Some part of my workstream has been randomly setting execute bits.
This commit resets all the ones I have spotted.


Signed-off-by: Andy Pugh <andy@bodgesoc.org>
2011-08-16 00:41:53 +01:00
Andy Pugh
ae88038288 Documentation for the Hostmot2 BSPI Driver
Signed-off-by: Andy Pugh <andy@bodgesoc.org>
2011-08-15 23:32:53 +01:00
Jeff Epler
1446aa6f28 rtapi_vsnprintf: document the limitations 2011-08-14 18:43:14 +00:00
Jeff Epler
a4971ede05 rtapi_math64.h: division and remainder of 64-bit quantities
this is frequently desirable, but merely writing the obvious
x % y formulation can lead to the 'undefined symbol __umoddi3'
error.

Linux provides some routines to do division of 64-bit quantities
by 32-bit divisors; adopt this in rtapi, and provide a version written
in the obvious way when in userspace.
2011-08-14 18:41:18 +00:00
Jeff Epler
4ab5a6b376 rtapi_byteorder: what's architecture's byte order?
as usual, a different gyration is required for kernel than for userspace.
Harmonize it.
2011-08-14 18:41:17 +00:00
Jeff Epler
78919de4a1 Remove outdated warning about rtapi_get_time
The current implementation in rtai returns accurate times without
much overhead (hundreds of ns at worst, according to measurements by
Andy Pugh).  Remove this superstitious advice.
2011-07-18 13:36:52 -05:00
Jeff Epler
1343de75fa hal: document hal_parport.h APIs 2011-02-07 08:57:20 -06:00
Jeff Epler
dc31d02f03 try to document the s32 gotcha 2011-02-04 09:08:21 -06:00
Jeff Epler
8bfab6831e documentation: HAL APIs don't truncate long names 2010-06-07 07:48:05 -05:00
Jeff Epler
e7bd83137d explain when rtapi_app_exit is not called 2009-09-20 12:39:36 -05:00
Jeff Epler
296ff42f20 fix typo 2009-09-20 12:39:36 -05:00