diff mbox series

[RESEND,v2] lib/scatterlist: Remove leftover from sg_page_iter comment

Message ID 1557154976-8070-1-git-send-email-galpress@amazon.com (mailing list archive)
State Mainlined
Commit d2c4ada1ed883ea1310112965f2f1d713a470699
Delegated to: Jason Gunthorpe
Headers show
Series [RESEND,v2] lib/scatterlist: Remove leftover from sg_page_iter comment | expand

Commit Message

Gal Pressman May 6, 2019, 3:02 p.m. UTC
Commit d901b2760dc6 ("lib/scatterlist: Provide a DMA page iterator")
added the sg DMA iterator but a leftover remained in the sg_page_iter
documentation as you cannot get the page dma address (only the page
itself), fix it.

Cc: Jason Gunthorpe <jgg@mellanox.com>
Signed-off-by: Gal Pressman <galpress@amazon.com>
Reviewed-by: Mukesh Ojha <mojha@codeaurora.org>
---
This patch was sent twice to linux-kernel list with no response, I'm sending it
to the rdma list as that's where the cited patch was sent to.

Changelog:
v1->v2:
* Reword commit message
---
 include/linux/scatterlist.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Jason Gunthorpe May 6, 2019, 7:54 p.m. UTC | #1
On Mon, May 06, 2019 at 06:02:56PM +0300, Gal Pressman wrote:
> Commit d901b2760dc6 ("lib/scatterlist: Provide a DMA page iterator")
> added the sg DMA iterator but a leftover remained in the sg_page_iter
> documentation as you cannot get the page dma address (only the page
> itself), fix it.
> 
> Cc: Jason Gunthorpe <jgg@mellanox.com>
> Signed-off-by: Gal Pressman <galpress@amazon.com>
> Reviewed-by: Mukesh Ojha <mojha@codeaurora.org>
> ---
> This patch was sent twice to linux-kernel list with no response, I'm sending it
> to the rdma list as that's where the cited patch was sent to.

Okay, applied to for-next thanks

Jason
diff mbox series

Patch

diff --git a/include/linux/scatterlist.h b/include/linux/scatterlist.h
index b4be960c7e5d..30a9a55c28ba 100644
--- a/include/linux/scatterlist.h
+++ b/include/linux/scatterlist.h
@@ -340,11 +340,11 @@  int sg_alloc_table_chained(struct sg_table *table, int nents,
  * sg page iterator
  *
  * Iterates over sg entries page-by-page.  On each successful iteration, you
- * can call sg_page_iter_page(@piter) to get the current page and its dma
- * address. @piter->sg will point to the sg holding this page and
- * @piter->sg_pgoffset to the page's page offset within the sg. The iteration
- * will stop either when a maximum number of sg entries was reached or a
- * terminating sg (sg_last(sg) == true) was reached.
+ * can call sg_page_iter_page(@piter) to get the current page.
+ * @piter->sg will point to the sg holding this page and @piter->sg_pgoffset to
+ * the page's page offset within the sg. The iteration will stop either when a
+ * maximum number of sg entries was reached or a terminating sg
+ * (sg_last(sg) == true) was reached.
  */
 struct sg_page_iter {
 	struct scatterlist	*sg;		/* sg holding the page */