[PATCH] docs: mm/gup: Minor documentation update

[PATCH] docs: mm/gup: Minor documentation update

[Souptick Joarder]

Now there are 5 cases. Updated the same.

Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
Cc: John Hubbard <jhubbard@nvidia.com>
---
 Documentation/core-api/pin_user_pages.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/core-api/pin_user_pages.rst b/Documentation/core-api/pin_user_pages.rst
index 6068266..7ca8c7b 100644
--- a/Documentation/core-api/pin_user_pages.rst
+++ b/Documentation/core-api/pin_user_pages.rst
@@ -33,7 +33,7 @@ all combinations of get*(), pin*(), FOLL_LONGTERM, and more. Also, the
 pin_user_pages*() APIs are clearly distinct from the get_user_pages*() APIs, so
 that's a natural dividing line, and a good point to make separate wrapper calls.
 In other words, use pin_user_pages*() for DMA-pinned pages, and
-get_user_pages*() for other cases. There are four cases described later on in
+get_user_pages*() for other cases. There are five cases described later on in
 this document, to further clarify that concept.
 
 FOLL_PIN and FOLL_GET are mutually exclusive for a given gup call. However,
-- 
1.9.1

Re: [PATCH] docs: mm/gup: Minor documentation update

[John Hubbard]

On 2020-06-17 12:27, Souptick Joarder wrote:
> Now there are 5 cases. Updated the same.
> 
> Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
> Cc: John Hubbard <jhubbard@nvidia.com>
> ---
>   Documentation/core-api/pin_user_pages.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/core-api/pin_user_pages.rst b/Documentation/core-api/pin_user_pages.rst
> index 6068266..7ca8c7b 100644
> --- a/Documentation/core-api/pin_user_pages.rst
> +++ b/Documentation/core-api/pin_user_pages.rst
> @@ -33,7 +33,7 @@ all combinations of get*(), pin*(), FOLL_LONGTERM, and more. Also, the
>   pin_user_pages*() APIs are clearly distinct from the get_user_pages*() APIs, so
>   that's a natural dividing line, and a good point to make separate wrapper calls.
>   In other words, use pin_user_pages*() for DMA-pinned pages, and
> -get_user_pages*() for other cases. There are four cases described later on in
> +get_user_pages*() for other cases. There are five cases described later on in


Probably better to just say "several" instead of "five", but either way is fine.

     Reviewed-by: John Hubbard <jhubbard@nvidia.com>

thanks,
-- 
John Hubbard
NVIDIA

Re: [PATCH] docs: mm/gup: Minor documentation update

[Jonathan Corbet]

On Thu, 18 Jun 2020 00:57:03 +0530
Souptick Joarder <jrdr.linux@gmail.com> wrote:

> Now there are 5 cases. Updated the same.
> 
> Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
> Cc: John Hubbard <jhubbard@nvidia.com>
> ---
>  Documentation/core-api/pin_user_pages.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/core-api/pin_user_pages.rst b/Documentation/core-api/pin_user_pages.rst
> index 6068266..7ca8c7b 100644
> --- a/Documentation/core-api/pin_user_pages.rst
> +++ b/Documentation/core-api/pin_user_pages.rst
> @@ -33,7 +33,7 @@ all combinations of get*(), pin*(), FOLL_LONGTERM, and more. Also, the
>  pin_user_pages*() APIs are clearly distinct from the get_user_pages*() APIs, so
>  that's a natural dividing line, and a good point to make separate wrapper calls.
>  In other words, use pin_user_pages*() for DMA-pinned pages, and
> -get_user_pages*() for other cases. There are four cases described later on in
> +get_user_pages*() for other cases. There are five cases described later on in
>  this document, to further clarify that concept.

Applied, thanks.

jon