Skip to content

Commit da2e867

Browse files
author
Luca Toniolo
committed
docs: mark uses_fp as deprecated in man pages
Minimal doc update for 2.9. Full refactor of component docs, halcompile, and API removal planned for 2.10. Ref: #3895
1 parent ea49c4a commit da2e867

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

docs/man/man3/hal_create_thread.3hal

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ The name of the thread
1818
The interval, in nanoseconds, between iterations of the thread
1919

2020
.IP \fIuses_fp\fR
21-
Must be nonzero if a function which uses floating-point will be attached to this thread.
21+
\fBDeprecated.\fR All threads now unconditionally save and restore
22+
floating-point state. This parameter is accepted but ignored.
2223

2324
.SH DESCRIPTION
2425
\fBhal_create_thread\fR establishes a realtime thread that will execute one or more HAL functions periodically.

docs/man/man3/hal_export_funct.3hal

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ The pointer to the function
2020
The argument to be passed as the first parameter of \fIfunct\fR
2121

2222
.IP \fIuses_fp\fR
23-
Nonzero if the function uses floating-point operations, including assignment
24-
of floating point values with "=".
23+
\fBDeprecated.\fR All threads now unconditionally save and restore
24+
floating-point state, so this flag has no effect.
2525

2626
.IP \fIreentrant\fR
2727
If reentrant is non-zero, the function may be preempted and called again

docs/man/man3/rtapi_task_new.3rtapi

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ started
1919
.IP \fIprio\fR
2020
A task priority value returned by \fBrtapi_prio_xxxx\fR
2121
.IP \fIuses_fp\fR
22-
A flag that tells the OS whether the task uses floating point or not.
22+
\fBDeprecated.\fR All tasks now unconditionally save and restore
23+
floating-point state. This parameter is accepted but ignored.
2324
.IP \fItask_id\fR
2425
A task ID returned by a previous call to \fBrtapi_task_new\fR
2526
.SH DESCRIPTION

docs/man/man9/motion.9

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ Optionally the number of Digital I/O is set with num_dio. The number of Analog I
4242
Pin names starting with "\fBjoint\fR" or "\fBaxis\fR" are are read and updated by the motion-controller function.
4343

4444
.SH DESCRIPTION
45-
By default, the base thread does not support floating point. Software stepping, software encoder counting, and software pwm do not use floating point. \fBbase_thread_fp\fR can be used to enable floating point in the base thread (for example for brushless DC motor control).
45+
\fBbase_thread_fp\fR is \fBdeprecated\fR and has no effect. All threads now
46+
unconditionally save and restore floating-point state.
4647

4748
.P
4849
These pins and parameters are created by the realtime \fBmotmod\fR module. This module provides a HAL interface for LinuxCNC's motion planner. Basically \fBmotmod\fR takes in a list of waypoints and generates a nice blended and constraint-limited stream of joint positions to be fed to the motor drives.

0 commit comments

Comments
 (0)