Driver-API: Documentation: Replace deprecated :c:func: Usage
PATCH 1/1 Driver-API: Documentation: Replace deprecated :c:func: Usage
Replace :c:func: with func() as the previous usage is deprecated.
--- Documentation/driver-api/device-io.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-)
Documentation/driver-api/device-io.rst +11 -11
@@ -36,14 +36,14 @@ are starting with one. Physical addresses are of type unsigned long. This address should not be used directly. Instead, to get an address suitable for passing to the accessor functions described below, you -should call :c:func:`ioremap()`. An address suitable for accessing +should call ioremap(). An address suitable for accessing the device will be returned to you. After you've finished using the device (say, in your module's exit -routine), call :c:func:`iounmap()` in order to return the address +routine), call iounmap() in order to return the address space to the kernel. Most architectures allocate new address space each -time you call :c:func:`ioremap()`, and they can run out unless you -call :c:func:`iounmap()`. +time you call ioremap(), and they can run out unless you +call iounmap(). Accessing the device --------------------
@@ -60,8 +60,8 @@ readb_relaxed(), readw_relaxed(), readl_relaxed(), readq_relaxed(), writeb(), writew(), writel() and writeq(). Some devices (such as framebuffers) would like to use larger transfers than -8 bytes at a time. For these devices, the :c:func:`memcpy_toio()`, -:c:func:`memcpy_fromio()` and :c:func:`memset_io()` functions are +8 bytes at a time. For these devices, the memcpy_toio(), +memcpy_fromio() and memset_io() functions are provided. Do not use memset or memcpy on IO addresses; they are not guaranteed to copy data in order.
@@ -135,15 +135,15 @@ Accessing Port Space Accesses to this space are provided through a set of functions which allow 8-bit, 16-bit and 32-bit accesses; also known as byte, word and -long. These functions are :c:func:`inb()`, :c:func:`inw()`, -:c:func:`inl()`, :c:func:`outb()`, :c:func:`outw()` and -:c:func:`outl()`. +long. These functions are inb(), inw(), +inl(), outb(), outw() and +outl(). Some variants are provided for these functions. Some devices require that accesses to their ports are slowed down. This functionality is provided by appending a ``_p`` to the end of the function. -There are also equivalents to memcpy. The :c:func:`ins()` and -:c:func:`outs()` functions copy bytes, words or longs to the given +There are also equivalents to memcpy. The ins() and +outs() functions copy bytes, words or longs to the given port. Public Functions Provided
Signature · 1 line
2.27.0
Quoted 1 line · Puranjay Mohan
Replace :c:func: with
func()as the previous usage is deprecated.
Generally, reflowing text as part of these patches is discouraged, but I'd make an exception here:
Documentation/driver-api/device-io.rst Accessing Port Space · line 140
Quoted 10 lines
Documentation/driver-api/device-io.rst +3
-3@@ -135,15 +135,15 @@ Accessing Port Space Accesses to this space are provided through a set of functions which allow 8-bit, 16-bit and 32-bit accesses; also known as byte, word and -long. These functions are :c:func:`inb()`, :c:func:`inw()`, -:c:func:`inl()`, :c:func:`outb()`, :c:func:`outw()` and -:c:func:`outl()`. +long. These functions are inb(), inw(), +inl(), outb(), outw() and +outl().
...
+long. These functions are inb(), inw(), inl(), outb(), outw() and outl().
The others are more of a judgement call where we could go either way.
Jonathan Corbet
maintainerQuoted 6 lines · On Mon, 10 Aug 2020 23:51:07 +0530 Puranjay Mohan <[email protected]> wrote:
Replace :c:func: with
func()as the previous usage is deprecated.Signed-off-by Puranjay Mohan <[email protected]>--- Documentation/driver-api/device-io.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-)
I applied this patch from you in early July, and it's in mainline now...?
jon
Quoted 11 lines · Jonathan Corbet
Quoted 6 lines · On Mon, 10 Aug 2020 23:51:07 +0530 Puranjay Mohan <[email protected]> wrote:
Replace :c:func: with
func()as the previous usage is deprecated.Signed-off-by Puranjay Mohan <[email protected]>--- Documentation/driver-api/device-io.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-)I applied this patch from you in early July, and it's in mainline now...?
this is a new patch with same name I think?, this is not that patch.
Quoted 3 lines
jon
thanks,
puranjay