Skip to content

docs: Update man3 pages after uses_fp arg was removed in HAL API changes #4598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
grandixximo merged 1 commit into from
Sep 29, 2026
Merged

docs: Update man3 pages after uses_fp arg was removed in HAL API changes #4598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions docs/src/man/man3/hal_create_thread.3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ hal_create_thread - Create a HAL thread
----
#include <hal.h>

int hal_create_thread(const char *name, unsigned long period, int uses_fp);
int hal_create_thread(const char *name, unsigned long period);
int hal_thread_delete(const char *name);
----

Expand All @@ -22,9 +22,6 @@ name::
The name of the thread.
period::
The interval, in nanoseconds, between iterations of the thread.
uses_fp::
Deprecated and ignored. All threads now unconditionally save and restore
floating point state. This parameter will be removed in a future version.

== DESCRIPTION

Expand Down
7 changes: 2 additions & 5 deletions docs/src/man/man3/hal_export_funct.3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ hal_export_funct, hal_export_functf - create a realtime function callable from a

typedef void(*hal_funct_t)(void *arg, long period);

int hal_export_funct(const char *name, hal_funct_t funct, void *arg, int uses_fp, int reentrant, int comp_id);
int hal_export_functf(hal_funct_t funct, void *arg, int uses_fp, int reentrant, int comp_id, const char *fmt, ...);
int hal_export_funct(const char *name, hal_funct_t funct, void *arg, int reentrant, int comp_id);
int hal_export_functf(hal_funct_t funct, void *arg, int reentrant, int comp_id, const char *fmt, ...);
----

== ARGUMENTS
Expand All @@ -26,9 +26,6 @@ funct::
The pointer to the function.
arg::
The argument to be passed as the first parameter of _funct_.
uses_fp::
Deprecated and ignored. All threads now unconditionally save and restore
floating point state. This parameter will be removed in a future version.
reentrant::
If reentrant is non-zero, the function may be preempted and called again before the first call completes.
Otherwise, it may only be added to one thread.
Expand Down
8 changes: 3 additions & 5 deletions docs/src/man/man3/rtapi_task_new.3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ rtapi_task_new, rtapi_task_delete - create a realtime task

[source,c]
----
int rtapi_task_new(void (*_taskcode_)(void*), void *_arg_, int _prio_,
unsigned long _stacksize_, int _uses_fp_);
int rtapi_task_new(void (*_taskcode_)(void*), void *_arg_, int _prio_, int _owner_, unsigned long _stacksize_);
int rtapi_task_delete(int _task_id_);
----

Expand All @@ -23,9 +22,8 @@ arg::
An argument to be passed to the _taskcode_ function when the task is started
prio::
A task priority value returned by *rtapi_prio_xxxx*
uses_fp::
Deprecated and ignored. All tasks now unconditionally save and restore
floating point state. This parameter will be removed in a future version.
owner::
The module ID from rtapi_init(3).
task_id::
A task ID returned by a previous call to *rtapi_task_new*

Expand Down
Loading