atomic.h: Reword confusing comment for qatomic_cmpxchg
commitd346feed696c536f178f8110666e2bcc4c21b983
authorPeter Maydell <peter.maydell@linaro.org>
Fri, 23 Feb 2024 18:20:35 +0000 (23 18:20 +0000)
committerPeter Maydell <peter.maydell@linaro.org>
Tue, 5 Mar 2024 13:22:56 +0000 (5 13:22 +0000)
tree0fc292e80556d7f053d4d8e21f5ab6f54221adf1
parent728b923f548dba640cecb693ff1f1f134ef1097a
atomic.h: Reword confusing comment for qatomic_cmpxchg

The qatomic_cmpxchg() and qatomic_cmpxchg__nocheck() macros have
a comment that reads:
 Returns the eventual value, failed or not

This is somewhere between cryptic and wrong, since the value actually
returned is the value that was in memory before the cmpxchg.  Reword
to match how we describe these macros in atomics.rst.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: Zhao Liu <zhao1.liu@intel.com>
Message-id: 20240223182035.1048541-1-peter.maydell@linaro.org
include/qemu/atomic.h