Re: EVL documentations issues

[Philippe Gerum <rpm@xenomai.org>]

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.