Petter Reinholdtsen
e7f312f6be
Enable translations for more manual pages
...
Some manual pages uses roff macros and other features not handled by
po4a. Make more manual pages translatable by removing the use of such
macros where it is trivial to do.
2022-06-08 20:15:14 +02:00
Sebastian Kuzminsky
65b2093905
Merge remote-tracking branch 'origin/2.8'
...
* origin/2.8:
add a test that verifies that rtapi shmem is initialized to zeros
hal_lib: fix a race in hal_init()
rtapi fix shmem comment
docs: fix an omission in the rtapi_shmem manpage
hal_lib: whitespace fixes only, no code change
hal_lib: minor cosmetic fix to a seldom-seen debug message
mitsub_vfd docs: add point we are not using MODBUS
mitsub_vfd -add open, close then open agaon - some systems require it.
2022-01-27 09:09:50 -07:00
Sebastian Kuzminsky
d04578b40c
docs: fix an omission in the rtapi_shmem manpage
...
Make explicit an important promise made by rtapi_shmem_new(): When a
block of memory is first allocated, it is initialized to all zero bytes.
On Uspace rtapi_shmem_new() calls shmget(), which zeros the memory when
creating a new shared memory block:
https://man7.org/linux/man-pages/man2/shmget.2.html#DESCRIPTION
On RTAI rtapi_shmem_new() calls rtai_kmalloc() and rtai_malloc(), which
both end up calling _rt_shmem_new(). The documentation does not say
anything about initialization of freshly allocated memory buffers, but
Paolo Mantegazza (one of the main RTAI developers) said that RTAI *does*
zeros shmem buffers, and pointed to this code:
https://mail.rtai.org/pipermail/rtai/2022-January/028282.html
http://cvs.savannah.nongnu.org/viewvc/rtai/magma/base/ipc/shm/shm.c?view=markup#l69
2022-01-26 13:27:11 -07:00
Petter Reinholdtsen
e08b394a30
Fix typo in hal_type_t(3) manual page.
2021-12-24 13:18:40 +01:00
andypugh
381bbfeb5d
Merge branch 'master' into typos-docs-tests
2021-05-14 00:00:13 +01:00
john
18f727b5fb
Merge branch '2.8'
2021-05-08 08:19:48 -05:00
Rene Hopf
81da98db3e
rx_mode typo in hm2_uart_setup
2021-04-29 00:05:09 +02:00
luz paz
fa855db600
fix typos in docs/ and tests/
...
Found via codespell
2021-02-24 12:25:33 -05:00
andypugh
0ebc3adef0
Merge branch '2.8'
...
Signed-off-by: andypugh <andy@bodgesoc.org>
2020-09-01 00:43:57 +01:00
Håvard Flaget Aasen
13a9824a26
Fix minor typos in man-page
2020-08-24 23:23:16 +02:00
Chris Morley
fd243eeff3
Merge branch '2.8'
2020-06-12 23:42:36 -07:00
andypugh
07dcd21111
rtapi: add a halcmd command to set the messaging level
...
Signed-off-by: andypugh <andy@bodgesoc.org>
2020-06-11 23:05:45 +01:00
Rene Hopf
3765decc86
Merge branch '2.8'
2020-04-19 20:39:26 +02:00
Håvard Flaget Aasen
c108377bb2
Some more spelling errors reported by lintian
2020-04-18 23:16:00 +02:00
4234878df8
rtapi_string: provide rtapi_strlcat, rtapi_strxcat
2020-04-18 19:43:52 +02:00
19b6de210c
rtapi_string.h: Provide rtapi_strxcpy
2020-04-18 19:35:23 +02:00
b0808e7fd2
rtapi_string.h: Add 'rtapi_strlcpy'
2020-04-18 19:33:53 +02:00
Håvard Flaget Aasen
375fa9cea5
Fix spelling error reported by lintian
2020-04-18 17:03:41 +02:00
Curtis Dutton
b987b3fce5
Adds PORT pin type to hal.
...
A HAL port pin is a hal pin that acts as a real time one way byte oriented data stream An output port on any component may be connected to an input port on any other component via a signal. Data written on the output pin becomes accessible to the input pin. A HAL port signal may link only a single writer and a single reader. A port buffers data with a user definable buffer size.
Includes:
Documentation on how to use a port object.
a ctypes wrapper for the hal api (pyhal.py)
a test to exersice hal port code along with pyhal.py
changes to allow halcmd to understand and manipulate ports.
2019-08-08 15:17:37 -04:00
Jeff Epler
05e762de30
docs: note correct headers for hm2 public APIs
2018-10-25 21:36:14 -05:00
6ab27989fe
docs: rtapi_print: fix markup error leading to excessive indentation
2018-06-13 21:28:49 -05:00
8cb2de3cba
docs: rtapi_print: Fix typo'd name of one of the functions
2018-06-13 21:27:32 -05:00
7d1f4a1b1a
docs: rtapi_print: improve discussion of limited formatting capability
2018-06-13 21:27:20 -05:00
Jeff Epler
95f02b2bbc
rtapi: add rtapi_{u,}intptr_t to rtapi_stdint.h
2018-03-18 20:22:46 -05:00
Jeff Epler
0204d4ff23
hm2_bspi: document samplelate parameter
...
thanks to pcw for the accurate description
2018-03-17 10:09:05 -05:00
Jeff Epler
c1af378d98
hm2_bspi_setup_chan: rename sense-inverted parameters in docs
2018-03-17 09:17:16 -05:00
Jeff Epler
354c59f3d0
hm2_bspi manpages: add REALTIME CONSIDERATIONS
2018-03-17 09:12:51 -05:00
Jeff Epler
205e53334b
hm2_bspi manpages: standardize SEE ALSO section
2018-03-17 09:12:51 -05:00
Jeff Epler
a62cd30d22
hm2_bspi_setup_chan: insert fiddly markup
2018-03-17 09:04:30 -05:00
Sebastian Kuzminsky
304ace43d3
Merge remote-tracking branch 'origin/2.7'
...
Conflicts:
docs/man/man1/halstreamer.1
lib/python/gladevcp/combi_dro.py
src/emc/motion/command.c
src/emc/task/emccanon.cc
src/emc/usr_intf/emcrsh.cc
src/emc/usr_intf/gmoccapy/getiniinfo.py
src/hal/components/biquad.comp
src/hal/components/orient.comp
src/hal/components/streamer.c
2018-01-22 10:32:44 -07:00
Sebastian Kuzminsky
986e9c194e
docs: remove obsolete bug warning in rtapi_region manpage
2018-01-21 14:49:13 -07:00
Sebastian Kuzminsky
c69df759b3
docs: fix GPL name in rtapi_module_param manpage
2018-01-21 14:49:13 -07:00
Sebastian Kuzminsky
dec6b8580a
Merge remote-tracking branch 'origin/2.7'
...
Conflicts:
debian/control.bottom.in
docs/man/man1/halstreamer.1
docs/man/man1/halui.1
docs/man/man1/linuxcncrsh.1
docs/man/man1/shuttlexpress.1
docs/man/man1/sim_pin.1
docs/man/man9/gantrykins.9
docs/man/man9/kins.9
docs/man/man9/motion.9
docs/man/man9/sserial.9
docs/man/man9/streamer.9
tests/startup-state/sim.var.clean
tests/startup-state/sim.var.orig
tests/startup-state/sim.var.pre
tests/startup-state/test.sh
2018-01-19 08:25:06 -07:00
Sebastian Kuzminsky
4a897203bc
docs: fix hyphen/minus confusion in manpages
...
groff treats '-' (the character you get when you hit the "minus" key on
the keyboard) as "hyphen", not as "minus". Thus it renders incorrectly
in some locales, and line-wraps strangely.
groff treats the two-character sequence "\-" as "minus", and the
four-character sequence "\(hy" as "hyphen".
Details here: https://lists.debian.org/debian-devel/2003/03/msg01481.html
This commit replaces every instance of "-" in our manpages where the
meaning is "minus" with "\-", so it works right.
This fixes many lintian warnings.
2018-01-18 08:12:31 -07:00
Jeff Epler
84ed1868b1
rtapi: Add sized integer min/max defines
2018-01-09 11:49:26 -06:00
Lubomir Rintel
a63ec765cb
all: update FSF address in GPL 2.0 notices
...
If you write to 59 Temple Place you're unlikely to get a response.
Let's realign the address with a more up-to-date one from [1].
[1] https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
This is purely a cosmetic change, doesn't affect the meaning of the
license. Done to make rpmlint happy.
Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
2017-09-15 13:06:22 +02:00
Sebastian Kuzminsky
e375e3affc
Merge remote-tracking branch 'origin/2.7'
2017-06-18 15:58:33 -06:00
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
d42bdf6b25
Merge remote-tracking branch 'origin/2.7'
2017-04-22 09:11:53 -06: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
Jeff Epler
5f0865a7ea
rtapi: Add rtapi_open_as_root API
...
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-08-20 15:02:50 -05:00
Boris Skegin
25031ef5b4
PktUART symbolic error codes defined in pktuart_errno.h
...
* corrected man files
Signed-off-by: Boris Skegin <boris.skegin.de at gmail.com>
2016-05-10 16:57:01 +02:00
Boris Skegin
8f82be8363
PktUART driver for MESA
...
* man files
* test component
Signed-off-by: Boris Skegin <boris.skegin.de at gmail.com>
2016-05-10 16:56:58 +02:00
Jeff Epler
b8fcd14d03
docs: rename hal_stream manpage
...
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-12-31 09:54:35 -06:00
Jeff Epler
eef9f52585
hal: document the new C API
...
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-12-23 16:18:08 -06:00
Sebastian Kuzminsky
67463494e2
Merge remote-tracking branch 'origin/2.7'
2015-12-12 18:14:23 -07: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
232d2a85cd
rtapi: split mutex to new header
...
most source files that include rtapi.h don't use mutexes, so split it out.
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-11-25 17:00:03 -06:00
Jeff Epler
eced6ad99f
docs: fix formatting in rtapi_mutex page
...
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-11-25 16:59:39 -06:00