linux-kernel-mentees.lists.linuxfoundation.org archive mirror
 help / color / mirror / Atom feed
* [Linux-kernel-mentees] [PATCH] Driver-API: Documentation: Replace deprecated :c:func: Usage
@ 2020-08-10 18:21 Puranjay Mohan
  2020-08-10 18:44 ` Matthew Wilcox
  2020-08-11 16:36 ` Jonathan Corbet
  0 siblings, 2 replies; 6+ messages in thread
From: Puranjay Mohan @ 2020-08-10 18:21 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: linux-doc, linux-kernel-mentees, linux-kernel, Puranjay Mohan

Replace :c:func: with func() as the previous usage is deprecated.

Signed-off-by: Puranjay Mohan <puranjay12@gmail.com>
---
 Documentation/driver-api/device-io.rst | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/Documentation/driver-api/device-io.rst b/Documentation/driver-api/device-io.rst
index 0e389378f71d..764963876d08 100644
--- a/Documentation/driver-api/device-io.rst
+++ b/Documentation/driver-api/device-io.rst
@@ -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
-- 
2.27.0

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [Linux-kernel-mentees] [PATCH] Driver-API: Documentation: Replace deprecated :c:func: Usage
  2020-08-10 18:21 [Linux-kernel-mentees] [PATCH] Driver-API: Documentation: Replace deprecated :c:func: Usage Puranjay Mohan
@ 2020-08-10 18:44 ` Matthew Wilcox
  2020-08-11 16:36 ` Jonathan Corbet
  1 sibling, 0 replies; 6+ messages in thread
From: Matthew Wilcox @ 2020-08-10 18:44 UTC (permalink / raw)
  To: Puranjay Mohan
  Cc: linux-kernel, linux-kernel-mentees, linux-doc, Jonathan Corbet

On Mon, Aug 10, 2020 at 11:51:07PM +0530, Puranjay Mohan wrote:
> 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:

> @@ -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.
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [Linux-kernel-mentees] [PATCH] Driver-API: Documentation: Replace deprecated :c:func: Usage
  2020-08-10 18:21 [Linux-kernel-mentees] [PATCH] Driver-API: Documentation: Replace deprecated :c:func: Usage Puranjay Mohan
  2020-08-10 18:44 ` Matthew Wilcox
@ 2020-08-11 16:36 ` Jonathan Corbet
  2020-08-11 17:13   ` Puranjay Mohan
  1 sibling, 1 reply; 6+ messages in thread
From: Jonathan Corbet @ 2020-08-11 16:36 UTC (permalink / raw)
  To: Puranjay Mohan; +Cc: linux-doc, linux-kernel-mentees, linux-kernel

On Mon, 10 Aug 2020 23:51:07 +0530
Puranjay Mohan <puranjay12@gmail.com> wrote:

> Replace :c:func: with func() as the previous usage is deprecated.
> 
> Signed-off-by: Puranjay Mohan <puranjay12@gmail.com>
> ---
>  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
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [Linux-kernel-mentees] [PATCH] Driver-API: Documentation: Replace deprecated :c:func: Usage
  2020-08-11 16:36 ` Jonathan Corbet
@ 2020-08-11 17:13   ` Puranjay Mohan
  0 siblings, 0 replies; 6+ messages in thread
From: Puranjay Mohan @ 2020-08-11 17:13 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: linux-doc, linux-kernel-mentees, linux-kernel

On Tue, Aug 11, 2020 at 10:36:40AM -0600, Jonathan Corbet wrote:
> On Mon, 10 Aug 2020 23:51:07 +0530
> Puranjay Mohan <puranjay12@gmail.com> wrote:
> 
> > Replace :c:func: with func() as the previous usage is deprecated.
> > 
> > Signed-off-by: Puranjay Mohan <puranjay12@gmail.com>
> > ---
> >  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.
> 

> jon

thanks,
puranjay
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [Linux-kernel-mentees] [PATCH] Driver-API: Documentation: Replace deprecated :c:func: Usage
  2020-07-07  5:32 Puranjay Mohan
@ 2020-07-13 15:56 ` Jonathan Corbet
  0 siblings, 0 replies; 6+ messages in thread
From: Jonathan Corbet @ 2020-07-13 15:56 UTC (permalink / raw)
  To: Puranjay Mohan; +Cc: linux-doc, linux-kernel-mentees, linux-kernel

On Tue,  7 Jul 2020 11:02:52 +0530
Puranjay Mohan <puranjay12@gmail.com> wrote:

> Replace :c:func: with func() as the previous usage is deprecated.
> 
> Signed-off-by: Puranjay Mohan <puranjay12@gmail.com>
> ---
>  Documentation/driver-api/device-io.rst | 22 +++++++++++-----------
>  1 file changed, 11 insertions(+), 11 deletions(-)

Applied, thanks.

jon
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [Linux-kernel-mentees] [PATCH] Driver-API: Documentation: Replace deprecated :c:func: Usage
@ 2020-07-07  5:32 Puranjay Mohan
  2020-07-13 15:56 ` Jonathan Corbet
  0 siblings, 1 reply; 6+ messages in thread
From: Puranjay Mohan @ 2020-07-07  5:32 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: linux-doc, linux-kernel-mentees, linux-kernel, Puranjay Mohan

Replace :c:func: with func() as the previous usage is deprecated.

Signed-off-by: Puranjay Mohan <puranjay12@gmail.com>
---
 Documentation/driver-api/device-io.rst | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/Documentation/driver-api/device-io.rst b/Documentation/driver-api/device-io.rst
index 0e389378f71d..764963876d08 100644
--- a/Documentation/driver-api/device-io.rst
+++ b/Documentation/driver-api/device-io.rst
@@ -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
-- 
2.27.0

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2020-08-11 17:13 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-08-10 18:21 [Linux-kernel-mentees] [PATCH] Driver-API: Documentation: Replace deprecated :c:func: Usage Puranjay Mohan
2020-08-10 18:44 ` Matthew Wilcox
2020-08-11 16:36 ` Jonathan Corbet
2020-08-11 17:13   ` Puranjay Mohan
  -- strict thread matches above, loose matches on Subject: below --
2020-07-07  5:32 Puranjay Mohan
2020-07-13 15:56 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).