Skip to content

hal: Several trivial man-page updates #4273

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
Jul 28, 2026
+17 −8
Merged

hal: Several trivial man-page updates #4273

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
2 changes: 1 addition & 1 deletion docs/src/man/man3/hm2_pktuart.3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ I.e., the data is filled right-to-left and right-justified with consecutive pack

Because the transactions are necessarily split over multiple reads, and some steps will have serial-port latency delays it is recommended to use a state machine in the realtime code where waiting on input is not possible.

[source, C]
[source,c]
----
int process(void *arg, long period) {
static int state = START;
Expand Down
2 changes: 1 addition & 1 deletion docs/src/man/man3/hm2_pktuart_read.3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ int hm2_pktuart_read(char* name, unsigned char data[], rtapi_u8* num_frames,

DEPRECATED except in setup code.

Please see the combined document hm2_pktuart.3
Please see the combined document hm2_pktuart(3)
2 changes: 1 addition & 1 deletion docs/src/man/man3/hm2_pktuart_send.3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ int hm2_uart_send(char* name, unsigned char data[], rtapi_u8* num_frames,
*hm2_pktuart_send* writes "num_frames" of data to the PktUART "name"
from the buffer "data" with frame sizes preset in "frame_sizes[]" array.

Please see the combined document hm2_pktuart.3 for how to use this function.
Please see the combined document hm2_pktuart(3) for how to use this function.
2 changes: 1 addition & 1 deletion docs/src/man/man3/hm2_pktuart_setup.3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ int hm2_pktuart_setup(char* name, int bitrate, rtapi_s32 tx_mode,

*hm2_pktuart_setup*

Please see the combined document hm2_pktuart.3 for how to use this function.
Please see the combined document hm2_pktuart(3) for how to use this function.
7 changes: 3 additions & 4 deletions docs/src/man/man3/rtapi_bool.3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ rtapi_bool - RTAPI wrappers for linux kernel functionality
[source,c]
----
#include <rtapi_bool.h>

// Specific abstraction for HAL
typedef bool rtapi_bool;
----

== DESCRIPTION
Expand All @@ -19,7 +22,3 @@ to obtain suitable declarations of "bool", "true" and "false".
== REALTIME CONSIDERATIONS

None.

== NOTES

Also permitted in C++ programs, where including it has no effect.
10 changes: 10 additions & 0 deletions docs/src/man/man3/rtapi_stdint.3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ typedef ... rtapi_uintptr_t;
#define RTAPI_INT__xx___MIN ...
#define RTAPI_INT__xx___MAX ...
#define RTAPI_UINT__xx___MAX ...

// Specific abstractions for HAL
typedef ... rtapi_real;
typedef ... rtapi_sint;
typedef ... rtapi_uint;
typedef ... rtapi_port;

#define RTAPI_SINT_MIN ...
#define RTAPI_SINT_MAX ...
#define RTAPI_UINT_MAX ...
----

== DESCRIPTION
Expand Down
Loading