All of lore.kernel.org
 help / color / mirror / Atom feed
* EVL documentations issues
@ 2024-07-09 15:45 Giulio Moro
  2024-07-09 15:51 ` Giulio Moro
  2024-07-09 21:07 ` Philippe Gerum
  0 siblings, 2 replies; 7+ messages in thread
From: Giulio Moro @ 2024-07-09 15:45 UTC (permalink / raw)
  To: xenomai

Hi there,
going through the documentation for EVL I noticed the following:
- at https://evlproject.org/core/user-api/function_index/ the functions evl_udelay(), evl_new_clock(), evl_get_thread_mode() (at least) are not going anywhere and they are also not mentioned in the libevl source code.
- in practical use, evl_usleep() seems to have a limit of 1000000 as an argument. Is that expected? The limit is undocumented and the corresponding -EINVAL return value is also undocumented.
- evl_add_pollfd() and evl_mod_pollfd ()take an undocumented union evl_value pollval. The tests use evl_nil.
- there are several broken links. I found these with https://www.deadlinkchecker.com/ entering evlproject.org  as the starting page. I report the result  below for convenience, but the kast column "Source link text" is much more usable when viewed on the site as it is a clickable link to the page containing the broken link


      Status	URL	                                                                      Source link text
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/man1/latency/	Xenomai 3
404 Not Found	https://docs.zephyrproject.org/latest/getting_started/installation_linux.html	Zephyr SDK
404 Not Found	https://source.denx.de/Xenomai/xenomai4/revl/-/tags/0.4.0	0.4.0 [302 from https://git.xenomai.org/xenomai4/revl/-/tags/0.4.0]
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/man1/latency/index.html	latency
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/man1/autotune/index.html	autotune
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/xeno3prm/group__cobalt__core.html	Cobalt core
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/xeno3prm/group__rtdm.html	RTDM
-1 Not found: The host name in the certificate is invalid or does not match	https://rtai.org/	RTAI [302 from http://rtai.org/]
404 Not Found	https://man7.org/linux/man-pages/man3/clock_nanosleep.3.html	clock_nanosleep(3) [301 from http://man7.org/linux/man-pages/man3/clock_nanosleep.3.html]
404 Not Found	https://man7.org/linux/man-pages/man2/fcntl.2.html)	http://man7.org/linux/man-pages/man2/fcntl.2.html) [301 from http://man7.org/linux/man-pages/man2/fcntl.2.html)]
404 Not Found	https://www.kernel.org/doc/html/latest/core-api/genericirq.html)	https://www.kernel.org/doc/html/latest/core-api/genericirq.html)
404 Not Found	https://source.denx.de/Xenomai/xenomai4/libevl/-/tags/r41	libevl r41 [302 from https://git.xenomai.org/xenomai4/libevl/-/tags/r41]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/7af18f8a38ad68f581cf770819ccb98c29f41586	20 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/7af18f8a38ad68f581cf770819ccb98c29f41586]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/41dc88ab524cd32878646d98b57d390e2bcc1198	26 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/41dc88ab524cd32878646d98b57d390e2bcc1198]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/libevl/-/tags/r40	r40 [302 from https://git.xenomai.org/xenomai4/libevl/-/tags/r40]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/87ee9586fa60	17 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/87ee9586fa60]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/231089ed6028	16 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/231089ed6028]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/6b8a2319c02d	15 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/6b8a2319c02d]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/3d4ff940c1d3	14 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/3d4ff940c1d3]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/a142e2e027dc	19 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/a142e2e027dc]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/b8351b703ffb	18 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/b8351b703ffb]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/9397204d7484	8 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/9397204d7484]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/c1a5ca6a70e7	7 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/c1a5ca6a70e7]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/bc92ac9d3b90	6 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/bc92ac9d3b90]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/d9b664b5ecdb	5 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/d9b664b5ecdb]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/57ce409e23e6	4 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/57ce409e23e6]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/b81555f4f48b	1 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/b81555f4f48b]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/cfab80b242c4	0 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/cfab80b242c4]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/f6f6e58cbaff	9 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/f6f6e58cbaff]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/c1417f3dbe4f	3 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/c1417f3dbe4f]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/3af3b43bdf20	2 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/3af3b43bdf20]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/a2ba90db409a	13 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/a2ba90db409a]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/0b5a64ead6f6	12 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/0b5a64ead6f6]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/b7c6e2276983	11 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/b7c6e2276983]
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/8245a892b9ec	10 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/8245a892b9ec]
404 Not Found	https://evlproject.org/core/benchmarks/(/core/runtime-settings/)	calibration settings
404 Not Found	https://evlproject.org/core/user-api/io/_index.html	oob_read()
404 Not Found	https://evlproject.org/core/user-api/flags/(/core/abi-revs/)	ABI 33
404 Not Found	http://nanopi.io/nanopi-neo.html/	AllWinner H3 (NanoPI NEO)

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: EVL documentations issues
  2024-07-09 15:45 EVL documentations issues Giulio Moro
@ 2024-07-09 15:51 ` Giulio Moro
  2024-07-09 16:11   ` Philippe Gerum
  2024-07-09 21:07 ` Philippe Gerum
  1 sibling, 1 reply; 7+ messages in thread
From: Giulio Moro @ 2024-07-09 15:51 UTC (permalink / raw)
  To: xenomai

Giulio Moro wrote on 09/07/2024 10:45:>
> - there are several broken links. I found these with https://www.deadlinkchecker.com/ entering evlproject.org  as the starting page. I report the result  below for convenience, but the kast column "Source link text" is much more usable when viewed on the site as it is a clickable link to the page containing the broken link

Here's a better plain-text version of the broken link report from the same source.  Last column "Linked From"  is the page that contains the broken link

Error          	URL                                              	         Anchor Text	Linked From
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/man1/latency/	Xenomai 3	https://evlproject.org/core/benchmarks/
404 Not Found	https://evlproject.org/core/benchmarks/(/core/runtime-settings/)	calibration settings	https://evlproject.org/core/benchmarks/
404 Not Found	https://docs.zephyrproject.org/latest/getting_started/installation_linux.html	Zephyr SDK	https://evlproject.org/core/benchmarks/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/revl/-/tags/0.4.0	0.4.0 [302 from https://git.xenomai.org/xenomai4/revl/-/tags/0.4.0]	https://evlproject.org/
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/man1/latency/index.html	latency	https://evlproject.org/core/testing/
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/man1/autotune/index.html	autotune	https://evlproject.org/core/testing/
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/xeno3prm/group__cobalt__core.html	Cobalt core	https://evlproject.org/overview/
404 Not Found	https://evlproject.org/core/user-api/io/_index.html	oob_read()	https://evlproject.org/core/user-api/function_index/
404 Not Found	https://evlproject.org/core/user-api/flags/(/core/abi-revs/)	ABI 33	https://evlproject.org/core/user-api/flags/
404 Not Found	https://xenomai.org/documentation/xenomai-3/html/xeno3prm/group__rtdm.html	RTDM	https://evlproject.org/core/oob-drivers/
-1 Not found: The host name in the certificate is invalid or does not match	https://rtai.org/	RTAI [302 from http://rtai.org/]	https://evlproject.org/core/
404 Not Found	https://man7.org/linux/man-pages/man3/clock_nanosleep.3.html	clock_nanosleep(3) [301 from http://man7.org/linux/man-pages/man3/clock_nanosleep.3.html]	https://evlproject.org/core/user-api/clock/
404 Not Found	https://man7.org/linux/man-pages/man2/fcntl.2.html)	http://man7.org/linux/man-pages/man2/fcntl.2.html) [301 from http://man7.org/linux/man-pages/man2/fcntl.2.html)]	https://evlproject.org/core/user-api/poll/
404 Not Found	https://www.kernel.org/doc/html/latest/core-api/genericirq.html)	https://www.kernel.org/doc/html/latest/core-api/genericirq.html)	https://evlproject.org/core/kernel-api/interrupts/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/libevl/-/tags/r41	libevl r41 [302 from https://git.xenomai.org/xenomai4/libevl/-/tags/r41]	https://evlproject.org/core/user-api/api-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/7af18f8a38ad68f581cf770819ccb98c29f41586	20 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/7af18f8a38ad68f581cf770819ccb98c29f41586]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/41dc88ab524cd32878646d98b57d390e2bcc1198	26 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/41dc88ab524cd32878646d98b57d390e2bcc1198]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/libevl/-/tags/r40	r40 [302 from https://git.xenomai.org/xenomai4/libevl/-/tags/r40]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/87ee9586fa60	17 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/87ee9586fa60]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/231089ed6028	16 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/231089ed6028]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/6b8a2319c02d	15 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/6b8a2319c02d]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/3d4ff940c1d3	14 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/3d4ff940c1d3]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/a142e2e027dc	19 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/a142e2e027dc]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/b8351b703ffb	18 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/b8351b703ffb]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/b81555f4f48b	1 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/b81555f4f48b]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/cfab80b242c4	0 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/cfab80b242c4]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/f6f6e58cbaff	9 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/f6f6e58cbaff]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/9397204d7484	8 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/9397204d7484]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/c1a5ca6a70e7	7 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/c1a5ca6a70e7]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/bc92ac9d3b90	6 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/bc92ac9d3b90]	https://evlproject.org/core/abi-revs/
404 Not Found	http://nanopi.io/nanopi-neo.html/	AllWinner H3 (NanoPI NEO)	https://evlproject.org/ports/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/d9b664b5ecdb	5 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/d9b664b5ecdb]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/57ce409e23e6	4 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/57ce409e23e6]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/c1417f3dbe4f	3 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/c1417f3dbe4f]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/3af3b43bdf20	2 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/3af3b43bdf20]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/a2ba90db409a	13 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/a2ba90db409a]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/0b5a64ead6f6	12 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/0b5a64ead6f6]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/b7c6e2276983	11 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/b7c6e2276983]	https://evlproject.org/core/abi-revs/
404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/8245a892b9ec	10 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/8245a892b9ec]	https://evlproject.org/core/abi-revs/

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: EVL documentations issues
  2024-07-09 15:51 ` Giulio Moro
@ 2024-07-09 16:11   ` Philippe Gerum
  0 siblings, 0 replies; 7+ messages in thread
From: Philippe Gerum @ 2024-07-09 16:11 UTC (permalink / raw)
  To: Giulio Moro, xenomai

Giulio Moro <giulio@bela.io> writes:

> Giulio Moro wrote on 09/07/2024 10:45:>
>> - there are several broken links. I found these with https://www.deadlinkchecker.com/ entering evlproject.org  as the starting page. I report the result  below for convenience, but the kast column "Source link text" is much more usable when viewed on the site as it is a clickable link to the page containing the broken link
>
> Here's a better plain-text version of the broken link report from the same source.  Last column "Linked From"  is the page that contains the broken link
>
> Error          	URL                                              	         Anchor Text	Linked From
> 404 Not Found	https://xenomai.org/documentation/xenomai-3/html/man1/latency/	Xenomai 3	https://evlproject.org/core/benchmarks/
> 404 Not Found	https://evlproject.org/core/benchmarks/(/core/runtime-settings/)	calibration settings	https://evlproject.org/core/benchmarks/
> 404 Not Found	https://docs.zephyrproject.org/latest/getting_started/installation_linux.html	Zephyr SDK	https://evlproject.org/core/benchmarks/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/revl/-/tags/0.4.0	0.4.0 [302 from https://git.xenomai.org/xenomai4/revl/-/tags/0.4.0]	https://evlproject.org/
> 404 Not Found	https://xenomai.org/documentation/xenomai-3/html/man1/latency/index.html	latency	https://evlproject.org/core/testing/
> 404 Not Found	https://xenomai.org/documentation/xenomai-3/html/man1/autotune/index.html	autotune	https://evlproject.org/core/testing/
> 404 Not Found	https://xenomai.org/documentation/xenomai-3/html/xeno3prm/group__cobalt__core.html	Cobalt core	https://evlproject.org/overview/
> 404 Not Found	https://evlproject.org/core/user-api/io/_index.html	oob_read()	https://evlproject.org/core/user-api/function_index/
> 404 Not Found	https://evlproject.org/core/user-api/flags/(/core/abi-revs/)	ABI 33	https://evlproject.org/core/user-api/flags/
> 404 Not Found	https://xenomai.org/documentation/xenomai-3/html/xeno3prm/group__rtdm.html	RTDM	https://evlproject.org/core/oob-drivers/
> -1 Not found: The host name in the certificate is invalid or does not match	https://rtai.org/	RTAI [302 from http://rtai.org/]	https://evlproject.org/core/
> 404 Not Found	https://man7.org/linux/man-pages/man3/clock_nanosleep.3.html	clock_nanosleep(3) [301 from http://man7.org/linux/man-pages/man3/clock_nanosleep.3.html]	https://evlproject.org/core/user-api/clock/
> 404 Not Found	https://man7.org/linux/man-pages/man2/fcntl.2.html)	http://man7.org/linux/man-pages/man2/fcntl.2.html) [301 from http://man7.org/linux/man-pages/man2/fcntl.2.html)]	https://evlproject.org/core/user-api/poll/
> 404 Not Found	https://www.kernel.org/doc/html/latest/core-api/genericirq.html)	https://www.kernel.org/doc/html/latest/core-api/genericirq.html)	https://evlproject.org/core/kernel-api/interrupts/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/libevl/-/tags/r41	libevl r41 [302 from https://git.xenomai.org/xenomai4/libevl/-/tags/r41]	https://evlproject.org/core/user-api/api-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/7af18f8a38ad68f581cf770819ccb98c29f41586	20 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/7af18f8a38ad68f581cf770819ccb98c29f41586]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/41dc88ab524cd32878646d98b57d390e2bcc1198	26 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/41dc88ab524cd32878646d98b57d390e2bcc1198]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/libevl/-/tags/r40	r40 [302 from https://git.xenomai.org/xenomai4/libevl/-/tags/r40]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/87ee9586fa60	17 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/87ee9586fa60]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/231089ed6028	16 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/231089ed6028]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/6b8a2319c02d	15 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/6b8a2319c02d]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/3d4ff940c1d3	14 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/3d4ff940c1d3]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/a142e2e027dc	19 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/a142e2e027dc]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/b8351b703ffb	18 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/b8351b703ffb]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/b81555f4f48b	1 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/b81555f4f48b]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/cfab80b242c4	0 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/cfab80b242c4]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/f6f6e58cbaff	9 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/f6f6e58cbaff]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/9397204d7484	8 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/9397204d7484]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/c1a5ca6a70e7	7 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/c1a5ca6a70e7]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/bc92ac9d3b90	6 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/bc92ac9d3b90]	https://evlproject.org/core/abi-revs/
> 404 Not Found	http://nanopi.io/nanopi-neo.html/	AllWinner H3 (NanoPI NEO)	https://evlproject.org/ports/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/d9b664b5ecdb	5 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/d9b664b5ecdb]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/57ce409e23e6	4 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/57ce409e23e6]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/c1417f3dbe4f	3 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/c1417f3dbe4f]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/3af3b43bdf20	2 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/3af3b43bdf20]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/a2ba90db409a	13 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/a2ba90db409a]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/0b5a64ead6f6	12 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/0b5a64ead6f6]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/b7c6e2276983	11 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/b7c6e2276983]	https://evlproject.org/core/abi-revs/
> 404 Not Found	https://source.denx.de/Xenomai/xenomai4/linux-evl/-/commit/8245a892b9ec	10 [302 from https://git.xenomai.org/xenomai4/linux-evl/-/commit/8245a892b9ec]	https://evlproject.org/core/abi-revs/

Thanks for the heads up. Fixing in progress.

-- 
Philippe.

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: EVL documentations issues
  2024-07-09 15:45 EVL documentations issues Giulio Moro
  2024-07-09 15:51 ` Giulio Moro
@ 2024-07-09 21:07 ` Philippe Gerum
  2024-07-09 22:07   ` Giulio Moro
  1 sibling, 1 reply; 7+ messages in thread
From: Philippe Gerum @ 2024-07-09 21:07 UTC (permalink / raw)
  To: Giulio Moro; +Cc: xenomai

Giulio Moro <giulio@bela.io> writes:

> Hi there,
> going through the documentation for EVL I noticed the following:
> - at https://evlproject.org/core/user-api/function_index/ the
> functions evl_udelay(),

Mm, legacy name which eventually became evl_usleep() in order to match usleep(3).

> evl_new_clock(),

Once a forward looking statement which did not go anywhere
eventually. We don't need that call, a custom clock can be accessed by
opening the corresponding clock device in the /dev/evl/clock hierarchy
as soon as some EVL driver implements and advertises it to the EVL
core. The returned fd can be used with the generic oob_read/write()
calls to submit requests to such clock.

> evl_get_thread_mode() (at least) are not going anywhere and they are also not mentioned in the libevl source code.

This fell into the cracks in the early days. This would be an alias to
evl_set_thread_mode(fd, 0, &oldmask), with oldmask containing the
current state.

> - in practical use, evl_usleep() seems to have a limit of 1000000 as an argument. Is that expected? The limit is undocumented and the corresponding -EINVAL return value is also undocumented.

Yes, the 1sec limit is wanted, for longer sleeps evl_sleep_until() can
be used with an absolute timeout though. Documentation mentioning EINVAL
was indeed missing though, fixed now.

> - evl_add_pollfd() and evl_mod_pollfd ()take an undocumented union evl_value pollval. The tests use evl_nil.

Doc is upcoming.

> - there are several broken links. I found these with https://www.deadlinkchecker.com/ entering evlproject.org  as the starting page. I report the result  below for convenience, but the kast column "Source link text" is much more usable when viewed on the site as it is a clickable link to the page containing the broken link
>
>

Thanks, all fixed now.

-- 
Philippe.

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: EVL documentations issues
  2024-07-09 21:07 ` Philippe Gerum
@ 2024-07-09 22:07   ` Giulio Moro
  2024-07-10  8:51     ` Philippe Gerum
  0 siblings, 1 reply; 7+ messages in thread
From: Giulio Moro @ 2024-07-09 22:07 UTC (permalink / raw)
  To: Philippe Gerum; +Cc: xenomai

Thanks for getting the fixes in.

This one is still wrong:

> -EINVAL if usecs is invalid, i.e. not in the [1..1000] range.

It should be [1..1000000] ...

I am also wondering whether returning -EINVAL when the argument is 0 is the best choice. FWIW, usleep(0) returns 0. I believe I have seen code use usleep(0) as an equivalent to sched_yield(), which I guess evl_usleep() would be "for free" if it didn't do the early return for usecs < 1 : evl_sleep_until() would return immediately because `next` would be in the past. Similarly glibc (I checked 2.39) goes through with the sleep even if the argument is 0. I guess the rationale would be that no matter of short the sleep, it should always at least cause a reschedule. As this function aims "to match usleep(3)", maybe it's worth considering using the same approach?

Also evl_get_thread_mode() hasn't yet been removed from the function list.

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: EVL documentations issues
  2024-07-09 22:07   ` Giulio Moro
@ 2024-07-10  8:51     ` Philippe Gerum
  2024-07-10 12:40       ` Giulio Moro
  0 siblings, 1 reply; 7+ messages in thread
From: Philippe Gerum @ 2024-07-10  8:51 UTC (permalink / raw)
  To: Giulio Moro; +Cc: xenomai

Giulio Moro <giulio@bela.io> writes:

> Thanks for getting the fixes in.
>
> This one is still wrong:
>
>> -EINVAL if usecs is invalid, i.e. not in the [1..1000] range.
>
> It should be [1..1000000] ...
>
> I am also wondering whether returning -EINVAL when the argument is 0
> is the best choice. FWIW, usleep(0) returns 0. I believe I have seen
> code use usleep(0) as an equivalent to sched_yield(), which I guess
> evl_usleep() would be "for free" if it didn't do the early return for
> usecs < 1 : evl_sleep_until() would return immediately because `next`
> would be in the past. Similarly glibc (I checked 2.39) goes through
> with the sleep even if the argument is 0. I guess the rationale would
> be that no matter of short the sleep, it should always at least cause
> a reschedule. As this function aims "to match usleep(3)", maybe it's
> worth considering using the same approach?
>

I'm unsure usleep(0) should amount to a manual round-robin, at the very
least the POSIX standard does not states that [1]. I cannot find any
explicit reference to such behavior in the manpages either. However,
evl_usleep() seems wrong nevertheless regarding this if we want to stay
close to the POSIX behavior when this makes sense.

evl_yield() may be what you are looking for in order to do a manual
round-robin.

> Also evl_get_thread_mode() hasn't yet been removed from the function list.

Fixed, thanks.

[1] https://pubs.opengroup.org/onlinepubs/7908799/xsh/usleep.html

-- 
Philippe.

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: EVL documentations issues
  2024-07-10  8:51     ` Philippe Gerum
@ 2024-07-10 12:40       ` Giulio Moro
  0 siblings, 0 replies; 7+ messages in thread
From: Giulio Moro @ 2024-07-10 12:40 UTC (permalink / raw)
  To: Philippe Gerum; +Cc: xenomai

> I'm unsure usleep(0) should amount to a manual round-robin, at the very
> least the POSIX standard does not states that [1]. I cannot find any
> explicit reference to such behavior in the manpages either. However,
> evl_usleep() seems wrong nevertheless regarding this if we want to stay
> close to the POSIX behavior when this makes sense.

You are right. The Linux man page on my systems doesn't mention that the call has no effect is the argument is 0, rather it says "suspends execution of the calling thread for (at least) usec microseconds" which hints that a suspension of the calling thread happens even if the argument is 0. The POSIX.1-2001 page instead states explicitly that if the argument is 0 the call has no effect. Either way, it seems that usleep() should return 0 and not EINVAL when the argument is 0. It's up to you to decide how evl_usleep() should behave in that respect.

Best,
Giulio

^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2024-07-10 13:17 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-07-09 15:45 EVL documentations issues Giulio Moro
2024-07-09 15:51 ` Giulio Moro
2024-07-09 16:11   ` Philippe Gerum
2024-07-09 21:07 ` Philippe Gerum
2024-07-09 22:07   ` Giulio Moro
2024-07-10  8:51     ` Philippe Gerum
2024-07-10 12:40       ` Giulio Moro

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.