docs: Update to reflect the HAL API changes - #4596
Merged
Merged
Conversation
grandixximo
reviewed
Sep 28, 2026
BsAtHome
force-pushed
the
hal64_update-docs
branch
from
September 28, 2026 16:29
8cf9d01 to
183c280
Compare
grandixximo
reviewed
Sep 29, 2026
| `hal.HAL_BOOL`, `hal.HAL_SINT`, `hal.HAL_UINT`, `hal.HAL_REAL`, `hal.HAL_PORT`. | ||
|
|
||
| Deprecated constants (replaced with new names, please use `hal.Type.XXXX`): | ||
| `hal.HAL_BIT`, `hal.HAL_S64`, `hal.HAL_U64`, `hal.HAL_FLOAT`. |
Contributor
There was a problem hiding this comment.
The deprecated list covers HAL_BIT/HAL_FLOAT/HAL_S64/HAL_U64, but the hal.py getattr shim also accepts HAL_S32 and HAL_U32 (with a 'no longer supported' FutureWarning). Add them here for completeness?
Contributor
Author
There was a problem hiding this comment.
I considered it, but rejected it. The base code no longer has them and the shim replaces them with UINT/SINT. The warning is different for these than for the others. In python we can just pretend because it does not really care about the integer size. Besides, there is a (very) large list of things you need to do when migrating and this doc is just a tiny fraction. Better put that in the "upgrade" doc(s) is my thinking.
grandixximo
added a commit
to grandixximo/linuxcnc
that referenced
this pull request
Sep 29, 2026
Bulk rename of type-position bit/float/s32/u32 to bool/real/sint/uint, which the HAL API docs update (LinuxCNC#4596-LinuxCNC#4599) did not cover. Prose uses (bit stream, firmware bit files, 16/18-bit galvanometer protocol widths) are left alone.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
These are the main documentation updates after the HAL API break (#4565).
Note: the code and components still need to be made 64-bit clean. The update only describes the HAL visibility for users.