luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-10-05 05:09:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document not to use volatile qualifiers

Browse Source 
Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Fixes: #600
This commit is contained in:
Philip Withnall
2020-11-17 10:15:15 +00:00
parent 7d417f8406
commit 83e48d8ac1
4 changed files with 66 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
glib/gatomic.c
View File

@@ -105,6 +105,9 @@
* This call acts as a full compiler and hardware
* memory barrier (before the get).
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of the integer
*
* Since: 2.4
@@ -125,6 +128,9 @@ gint
* This call acts as a full compiler and hardware
* memory barrier (after the set).
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Since: 2.4
*/
void
@@ -144,6 +150,9 @@ void
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Since: 2.4
**/
void
@@ -163,6 +172,9 @@ void
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: %TRUE if the resultant value is zero
*
* Since: 2.4
@@ -189,6 +201,9 @@ gboolean
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: %TRUE if the exchange took place
*
* Since: 2.4
@@ -216,6 +231,9 @@ gboolean
* Before version 2.30, this function did not return a value
* (but g_atomic_int_exchange_and_add() did, and had the same meaning).
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of @atomic before the add, signed
*
* Since: 2.4
@@ -240,6 +258,9 @@ gint
* Think of this operation as an atomic version of
* `{ tmp = *atomic; *atomic &= val; return tmp; }`.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of @atomic before the operation, unsigned
*
* Since: 2.30
@@ -264,6 +285,9 @@ guint
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of @atomic before the operation, unsigned
*
* Since: 2.30
@@ -288,6 +312,9 @@ guint
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of @atomic before the operation, unsigned
*
* Since: 2.30
@@ -309,6 +336,9 @@ guint
* This call acts as a full compiler and hardware
* memory barrier (before the get).
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of the pointer
*
* Since: 2.4
@@ -329,6 +359,9 @@ gpointer
* This call acts as a full compiler and hardware
* memory barrier (after the set).
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Since: 2.4
**/
void
@@ -354,6 +387,9 @@ void
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: %TRUE if the exchange took place
*
* Since: 2.4
@@ -379,6 +415,9 @@ gboolean
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of @atomic before the add, signed
*
* Since: 2.30
@@ -403,6 +442,9 @@ gssize
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of @atomic before the operation, unsigned
*
* Since: 2.30
@@ -427,6 +469,9 @@ gsize
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of @atomic before the operation, unsigned
*
* Since: 2.30
@@ -451,6 +496,9 @@ gsize
*
* This call acts as a full compiler and hardware memory barrier.
*
* While @atomic has a `volatile` qualifier, this is a historical artifact and
* the pointer passed to it should not be `volatile`.
*
* Returns: the value of @atomic before the operation, unsigned
*
* Since: 2.30