Skip to contentSkip to conversation

mm/gup.c: Corrected document reference path

PATCH Applied Souptick Joarder 3 participants 3 messages Apr 30, 2020 – May 1, 2020

Subsystems (2)
Memory management MM GUP
lore
Share & tools
lore

Souptick Joarder

author
#0 lore raw

PATCH 1/1 mm/gup.c: Corrected document reference path

Document path Documentation/vm/pin_user_pages.rst is not a correct reference and it should be Documentation/core-api/pin_user_pages.rst.

Signed-off-by Souptick Joarder <[email protected]>
---
 mm/gup.c | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
mm/gup.c +9 -9
index 7ce796c..4952f12 100644
@@ -2864,10 +2864,10 @@ int get_user_pages_fast(unsigned long start, int nr_pages,
  * the arguments here are identical.
  *
  * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
- * see Documentation/vm/pin_user_pages.rst for further details.
+ * see Documentation/core-api/pin_user_pages.rst for further details.
  *
- * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It
- * is NOT intended for Case 2 (RDMA: long-term pins).
+ * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst.
+ * It is NOT intended for Case 2 (RDMA: long-term pins).
  */
 int pin_user_pages_fast(unsigned long start, int nr_pages,
 			unsigned int gup_flags, struct page **pages)

@@ -2904,10 +2904,10 @@ int pin_user_pages_fast(unsigned long start, int nr_pages,
  * the arguments here are identical.
  *
  * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
- * see Documentation/vm/pin_user_pages.rst for details.
+ * see Documentation/core-api/pin_user_pages.rst for details.
  *
- * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It
- * is NOT intended for Case 2 (RDMA: long-term pins).
+ * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst.
+ * It is NOT intended for Case 2 (RDMA: long-term pins).
  */
 long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,
 			   unsigned long start, unsigned long nr_pages,

@@ -2940,10 +2940,10 @@ long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,
  * FOLL_PIN is set.
  *
  * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
- * see Documentation/vm/pin_user_pages.rst for details.
+ * see Documentation/core-api/pin_user_pages.rst for details.
  *
- * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It
- * is NOT intended for Case 2 (RDMA: long-term pins).
+ * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst.
+ * It is NOT intended for Case 2 (RDMA: long-term pins).
  */
 long pin_user_pages(unsigned long start, unsigned long nr_pages,
 		    unsigned int gup_flags, struct page **pages,
Signature · 1 line
1.9.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 4 lines · Souptick Joarder

Document path Documentation/vm/pin_user_pages.rst is not a correct reference and it should be Documentation/core-api/pin_user_pages.rst.

Signed-off-by Souptick Joarder <[email protected]>
Reviewed-by Ira Weiny <[email protected]>
Quoted 54 lines
---
 mm/gup.c | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
mm/gup.c +9 -9
index 7ce796c..4952f12 100644
@@ -2864,10 +2864,10 @@ int get_user_pages_fast(unsigned long start, int nr_pages,
  * the arguments here are identical.
  *
  * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
- * see Documentation/vm/pin_user_pages.rst for further details.
+ * see Documentation/core-api/pin_user_pages.rst for further details.
  *
- * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It
- * is NOT intended for Case 2 (RDMA: long-term pins).
+ * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst.
+ * It is NOT intended for Case 2 (RDMA: long-term pins).
  */
 int pin_user_pages_fast(unsigned long start, int nr_pages,
 			unsigned int gup_flags, struct page **pages)

@@ -2904,10 +2904,10 @@ int pin_user_pages_fast(unsigned long start, int nr_pages,
  * the arguments here are identical.
  *
  * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
- * see Documentation/vm/pin_user_pages.rst for details.
+ * see Documentation/core-api/pin_user_pages.rst for details.
  *
- * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It
- * is NOT intended for Case 2 (RDMA: long-term pins).
+ * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst.
+ * It is NOT intended for Case 2 (RDMA: long-term pins).
  */
 long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,
 			   unsigned long start, unsigned long nr_pages,

@@ -2940,10 +2940,10 @@ long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,
  * FOLL_PIN is set.
  *
  * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
- * see Documentation/vm/pin_user_pages.rst for details.
+ * see Documentation/core-api/pin_user_pages.rst for details.
  *
- * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It
- * is NOT intended for Case 2 (RDMA: long-term pins).
+ * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst.
+ * It is NOT intended for Case 2 (RDMA: long-term pins).
  */
 long pin_user_pages(unsigned long start, unsigned long nr_pages,
 		    unsigned int gup_flags, struct page **pages,
Signature · 1 line
1.9.1
reviewer Reviewed-by on v1 1/1
#2 lore raw
In reply to Souptick Joarder
Quoted 7 lines · Souptick Joarder

Document path Documentation/vm/pin_user_pages.rst is not a correct reference and it should be Documentation/core-api/pin_user_pages.rst.

Signed-off-by Souptick Joarder <[email protected]>
---
  mm/gup.c | 18 +++++++++---------
  1 file changed, 9 insertions(+), 9 deletions(-)
Reviewed-by John Hubbard <[email protected]>

thanks,

Signature · 2 lines
John Hubbard
NVIDIA
Quoted 48 lines
mm/gup.c +9 -9
index 7ce796c..4952f12 100644
@@ -2864,10 +2864,10 @@ int get_user_pages_fast(unsigned long start, int nr_pages,
   * the arguments here are identical.
   *
   * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
- * see Documentation/vm/pin_user_pages.rst for further details.
+ * see Documentation/core-api/pin_user_pages.rst for further details.
   *
- * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It
- * is NOT intended for Case 2 (RDMA: long-term pins).
+ * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst.
+ * It is NOT intended for Case 2 (RDMA: long-term pins).
   */
  int pin_user_pages_fast(unsigned long start, int nr_pages,
  			unsigned int gup_flags, struct page **pages)

@@ -2904,10 +2904,10 @@ int pin_user_pages_fast(unsigned long start, int nr_pages,
   * the arguments here are identical.
   *
   * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
- * see Documentation/vm/pin_user_pages.rst for details.
+ * see Documentation/core-api/pin_user_pages.rst for details.
   *
- * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It
- * is NOT intended for Case 2 (RDMA: long-term pins).
+ * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst.
+ * It is NOT intended for Case 2 (RDMA: long-term pins).
   */
  long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,
  			   unsigned long start, unsigned long nr_pages,

@@ -2940,10 +2940,10 @@ long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,
   * FOLL_PIN is set.
   *
   * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
- * see Documentation/vm/pin_user_pages.rst for details.
+ * see Documentation/core-api/pin_user_pages.rst for details.
   *
- * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It
- * is NOT intended for Case 2 (RDMA: long-term pins).
+ * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst.
+ * It is NOT intended for Case 2 (RDMA: long-term pins).
   */
  long pin_user_pages(unsigned long start, unsigned long nr_pages,
  		    unsigned int gup_flags, struct page **pages,