]> git.ipfire.org Git - thirdparty/gcc.git/commit
doc: Correct the return type of float comparison
authorTrevor Gross <tmgross@umich.edu>
Thu, 11 Sep 2025 20:50:04 +0000 (20:50 +0000)
committerJoseph Myers <josmyers@redhat.com>
Thu, 11 Sep 2025 20:52:27 +0000 (20:52 +0000)
commit9b6df34aa5a4a8a805e1c08256608fd302cb3874
tree26a060ee185ee705cc081100295e9882d30a708a
parent0899b826f7196f609fc8991456eb728802061318
doc: Correct the return type of float comparison

Documentation for `__cmpsf2` and similar functions currently indicate a
return type of `int`. This is not correct however; the `libgcc`
functions return `CMPtype`, the size of which is determined by the
`libgcc_cmp_return` mode.

Update documentation to use `CMPtype` and indicate that this is
target-dependent, also mentioning the usual modes.

Reported-by: beetrees <b@beetr.ee>
Fixes: https://github.com/rust-lang/compiler-builtins/issues/919#issuecomment-2905347318
Signed-off-by: Trevor Gross <tmgross@umich.edu>
* doc/libgcc.texi (Comparison functions): Document functions as
returning CMPtype.
gcc/doc/libgcc.texi