docs: mm/gup: Minor documentation update
PATCH 1/1 docs: mm/gup: Minor documentation update
Now there are 5 cases. Updated the same.
Signed-off-by Souptick Joarder <[email protected]>
Cc John Hubbard <[email protected]>
--- Documentation/core-api/pin_user_pages.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/core-api/pin_user_pages.rst +1 -1
@@ -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,
Signature · 1 line
1.9.1
Quoted 13 lines · Souptick Joarder
Now there are 5 cases. Updated the same.
Signed-off-by Souptick Joarder <[email protected]>Cc John Hubbard <[email protected]>--- Documentation/core-api/pin_user_pages.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/core-api/pin_user_pages.rst +0
-0
Documentation/core-api/pin_user_pages.rst all combinations of get*(), pin*(), FOLL_LONGTERM, and more. Also, the · line 36
Quoted 5 lines
Documentation/core-api/pin_user_pages.rst +1
-1@@ -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 <[email protected]>
thanks,
Signature · 2 lines
John Hubbard NVIDIA
Quoted 13 lines · On Thu, 18 Jun 2020 00:57:03 +0530 Souptick Joarder <[email protected]>…
Now there are 5 cases. Updated the same.
Signed-off-by Souptick Joarder <[email protected]>Cc John Hubbard <[email protected]>--- Documentation/core-api/pin_user_pages.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/core-api/pin_user_pages.rst +0
-0
Documentation/core-api/pin_user_pages.rst all combinations of get*(), pin*(), FOLL_LONGTERM, and more. Also, the · line 37
Quoted 6 lines
Documentation/core-api/pin_user_pages.rst +1
-1@@ -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