Skip to content

Commit ec8213f

Browse files
puranjaymohanJonathan Corbet
authored andcommitted
Core-api: Documentation: Replace deprecated :c:func: Usage
Replace :c:func: with func() as the previous usage is deprecated. Signed-off-by: Puranjay Mohan <[email protected]> Reviewed-by: Matthew Wilcox (Oracle) <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 2d88fc6 commit ec8213f

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

Documentation/core-api/idr.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,48 +20,48 @@ only ID allocation, and as a result is much more memory-efficient.
2020
IDR usage
2121
=========
2222

23-
Start by initialising an IDR, either with :c:func:`DEFINE_IDR`
24-
for statically allocated IDRs or :c:func:`idr_init` for dynamically
23+
Start by initialising an IDR, either with DEFINE_IDR()
24+
for statically allocated IDRs or idr_init() for dynamically
2525
allocated IDRs.
2626

27-
You can call :c:func:`idr_alloc` to allocate an unused ID. Look up
28-
the pointer you associated with the ID by calling :c:func:`idr_find`
29-
and free the ID by calling :c:func:`idr_remove`.
27+
You can call idr_alloc() to allocate an unused ID. Look up
28+
the pointer you associated with the ID by calling idr_find()
29+
and free the ID by calling idr_remove().
3030

3131
If you need to change the pointer associated with an ID, you can call
32-
:c:func:`idr_replace`. One common reason to do this is to reserve an
32+
idr_replace(). One common reason to do this is to reserve an
3333
ID by passing a ``NULL`` pointer to the allocation function; initialise the
3434
object with the reserved ID and finally insert the initialised object
3535
into the IDR.
3636

3737
Some users need to allocate IDs larger than ``INT_MAX``. So far all of
3838
these users have been content with a ``UINT_MAX`` limit, and they use
39-
:c:func:`idr_alloc_u32`. If you need IDs that will not fit in a u32,
39+
idr_alloc_u32(). If you need IDs that will not fit in a u32,
4040
we will work with you to address your needs.
4141

4242
If you need to allocate IDs sequentially, you can use
43-
:c:func:`idr_alloc_cyclic`. The IDR becomes less efficient when dealing
43+
idr_alloc_cyclic(). The IDR becomes less efficient when dealing
4444
with larger IDs, so using this function comes at a slight cost.
4545

4646
To perform an action on all pointers used by the IDR, you can
47-
either use the callback-based :c:func:`idr_for_each` or the
48-
iterator-style :c:func:`idr_for_each_entry`. You may need to use
49-
:c:func:`idr_for_each_entry_continue` to continue an iteration. You can
50-
also use :c:func:`idr_get_next` if the iterator doesn't fit your needs.
47+
either use the callback-based idr_for_each() or the
48+
iterator-style idr_for_each_entry(). You may need to use
49+
idr_for_each_entry_continue() to continue an iteration. You can
50+
also use idr_get_next() if the iterator doesn't fit your needs.
5151

52-
When you have finished using an IDR, you can call :c:func:`idr_destroy`
52+
When you have finished using an IDR, you can call idr_destroy()
5353
to release the memory used by the IDR. This will not free the objects
5454
pointed to from the IDR; if you want to do that, use one of the iterators
5555
to do it.
5656

57-
You can use :c:func:`idr_is_empty` to find out whether there are any
57+
You can use idr_is_empty() to find out whether there are any
5858
IDs currently allocated.
5959

6060
If you need to take a lock while allocating a new ID from the IDR,
6161
you may need to pass a restrictive set of GFP flags, which can lead
6262
to the IDR being unable to allocate memory. To work around this,
63-
you can call :c:func:`idr_preload` before taking the lock, and then
64-
:c:func:`idr_preload_end` after the allocation.
63+
you can call idr_preload() before taking the lock, and then
64+
idr_preload_end() after the allocation.
6565

6666
.. kernel-doc:: include/linux/idr.h
6767
:doc: idr sync

0 commit comments

Comments
 (0)