Commit graph

155 commits

Author SHA1 Message Date
0c0bb3056f
Merge remote-tracking branch 'origin/2.9' into alternate-bad-merge-fix 2023-01-07 12:15:33 -06:00
Steffen Moeller
3df87ab3f6 docs: misc changes while translating. 2022-12-30 16:00:27 +01:00
Steffen Möller
ec02e63f4f docs: More translation-triggered changes 2022-12-29 01:34:45 +01:00
Dewey Garrett
131761f462 Merge 'origin/2.9' 2022-12-07 06:00:51 -07:00
andypugh
e26c34a6ff
Merge branch '2.9' into 2.9-rtapi-ioperm 2022-12-07 01:31:32 +00:00
andypugh
052b0b83c7
Merge pull request #2165 from petterreinholdtsen/2.9-man-rtapi-io
Corrected rtapi_io(3rtapi) man page fixing typos and adding references.
2022-12-07 01:28:49 +00:00
andypugh
cadd89a54d Merge branch '2.9' 2022-12-04 21:21:45 +00:00
Steffen Moeller
f7f33803f7 docs: resolved conflict in hostmot2.9 2022-12-03 15:00:30 +01:00
Petter Reinholdtsen
b48a99a4d6 Corrected rtapi_io(3rtapi) man page fixing typos and adding references. 2022-11-29 06:25:06 +01:00
Petter Reinholdtsen
88874bdfff Added rtapi_ioperm() declaration for hal_speaker
This fixes the following compiler warning:

hal/drivers/hal_speaker.c: In function ‘rtapi_app_main’:
hal/drivers/hal_speaker.c:164:9: warning: implicit declaration of function ‘ioperm’ [-Wimplicit-function-declaration]
  164 |     if (ioperm(SPEAKER_PORT, 1, 1) < 0) {
      |         ^~~~~~
2022-11-29 06:18:40 +01:00
Steffen Moeller
c1668e2092 docs: smallish changes+fixes while translating 2022-11-18 00:31:32 +01:00
Steffen Moeller
9ce4147bd5 docs: more smallish changes while translating. 2022-11-07 14:21:04 +01:00
Petter Reinholdtsen
ed7bade7b2 Changed to regular format for man page cross references.
Man page viewers like khelp are able to convert hostmot2(9) into a link
to the hostmot2 manual page, while they do not understand 'man hostmot2'
or similar notation.  Thus, converted references to the regular fomat used
in manual pages.
2022-09-23 08:54:00 +02:00
Steffen Moeller
2c0a78efbc docs: screeing man pages prior to translations 2022-09-08 00:07:41 +02:00
Steffen Moeller
110fdb8c50 docs: more smallish changes to man pages 2022-09-07 19:08:40 +02:00
Steffen Moeller
6f7cb9978b More changes performed while translating
Separating units from value

Khz -> kHz

More on units, ohm -> Ω

More changes performed while translating

More changes performed while translating

Requested changes during peer review
2022-07-28 22:10:58 +02:00
Steffen Moeller
bb7ecf0460 More changes performed while translating 2022-07-11 11:23:52 +02:00
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