[PATCH] lib/scatterlist: Remove leftover from sg_page_iter comment

[PATCH] lib/scatterlist: Remove leftover from sg_page_iter comment

[Gal Pressman]

Commit d901b2760dc6 ("lib/scatterlist: Provide a DMA page iterator")
added the sg DMA iterator but a leftover remained in the sg_page_iter
documentation, remove it.

Cc: Jason Gunthorpe <jgg@mellanox.com>
Signed-off-by: Gal Pressman <galpress@amazon.com>
---
 include/linux/scatterlist.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

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 */
-- 
2.7.4

Re: [PATCH] lib/scatterlist: Remove leftover from sg_page_iter comment

[Mukesh Ojha]

On 3/29/2019 12:44 AM, 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, remove it.
>
> Cc: Jason Gunthorpe <jgg@mellanox.com>
> Signed-off-by: Gal Pressman <galpress@amazon.com>
> ---
>   include/linux/scatterlist.h | 10 +++++-----
>   1 file changed, 5 insertions(+), 5 deletions(-)
>
> 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.


It took me a while till i exact found what you meant by left over.

could have been more specific in the commit,but

Looks  good to me to be removed.

Reviewed-by: Mukesh Ojha <mojha@codeaurora.org>

-Mukesh


>   @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 */

Re: [PATCH] lib/scatterlist: Remove leftover from sg_page_iter comment

[Gal Pressman]

On 29-Mar-19 11:36, Mukesh Ojha wrote:
> 
> On 3/29/2019 12:44 AM, 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, remove it.
>>
>> Cc: Jason Gunthorpe <jgg@mellanox.com>
>> Signed-off-by: Gal Pressman <galpress@amazon.com>
>> ---
>>   include/linux/scatterlist.h | 10 +++++-----
>>   1 file changed, 5 insertions(+), 5 deletions(-)
>>
>> 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.
> 
> 
> It took me a while till i exact found what you meant by left over.
> 
> could have been more specific in the commit,but
> 
> Looks  good to me to be removed.
> 
> Reviewed-by: Mukesh Ojha <mojha@codeaurora.org>

You're right, should've been more specific.
Should I resubmit?

> 
> -Mukesh
> 
> 
>>   @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 */