diff options
Diffstat (limited to 'Documentation/core-api')
| -rw-r--r-- | Documentation/core-api/xarray.rst | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/Documentation/core-api/xarray.rst b/Documentation/core-api/xarray.rst index 6a6d67acaf69..5d54b27c6eba 100644 --- a/Documentation/core-api/xarray.rst +++ b/Documentation/core-api/xarray.rst | |||
| @@ -108,12 +108,13 @@ some, but not all of the other indices changing. | |||
| 108 | 108 | ||
| 109 | Sometimes you need to ensure that a subsequent call to :c:func:`xa_store` | 109 | Sometimes you need to ensure that a subsequent call to :c:func:`xa_store` |
| 110 | will not need to allocate memory. The :c:func:`xa_reserve` function | 110 | will not need to allocate memory. The :c:func:`xa_reserve` function |
| 111 | will store a reserved entry at the indicated index. Users of the normal | 111 | will store a reserved entry at the indicated index. Users of the |
| 112 | API will see this entry as containing ``NULL``. If you do not need to | 112 | normal API will see this entry as containing ``NULL``. If you do |
| 113 | use the reserved entry, you can call :c:func:`xa_release` to remove the | 113 | not need to use the reserved entry, you can call :c:func:`xa_release` |
| 114 | unused entry. If another user has stored to the entry in the meantime, | 114 | to remove the unused entry. If another user has stored to the entry |
| 115 | :c:func:`xa_release` will do nothing; if instead you want the entry to | 115 | in the meantime, :c:func:`xa_release` will do nothing; if instead you |
| 116 | become ``NULL``, you should use :c:func:`xa_erase`. | 116 | want the entry to become ``NULL``, you should use :c:func:`xa_erase`. |
| 117 | Using :c:func:`xa_insert` on a reserved entry will fail. | ||
| 117 | 118 | ||
| 118 | If all entries in the array are ``NULL``, the :c:func:`xa_empty` function | 119 | If all entries in the array are ``NULL``, the :c:func:`xa_empty` function |
| 119 | will return ``true``. | 120 | will return ``true``. |
| @@ -183,6 +184,8 @@ Takes xa_lock internally: | |||
| 183 | * :c:func:`xa_store_bh` | 184 | * :c:func:`xa_store_bh` |
| 184 | * :c:func:`xa_store_irq` | 185 | * :c:func:`xa_store_irq` |
| 185 | * :c:func:`xa_insert` | 186 | * :c:func:`xa_insert` |
| 187 | * :c:func:`xa_insert_bh` | ||
| 188 | * :c:func:`xa_insert_irq` | ||
| 186 | * :c:func:`xa_erase` | 189 | * :c:func:`xa_erase` |
| 187 | * :c:func:`xa_erase_bh` | 190 | * :c:func:`xa_erase_bh` |
| 188 | * :c:func:`xa_erase_irq` | 191 | * :c:func:`xa_erase_irq` |
