Re: [PATCH, net-next] net: page_pool: Add documentation on page_pool API

[Ilias Apalodimas <ilias.apalodimas@linaro.org>]

[...]
> 
> what about 'order'?  is it optional?

I actually forgot about it, i'll add it on v2

> 
> > +    * pool_size:  size of the ptr_ring
> > +    * nid:        preferred NUMA node for allocation
> > +    * dev:        struct device. Used on DMA operations
> > +    * dma_dir:    DMA direction
> > +    * max_len:    max DMA sync memory size
> > +    * offset:     DMA address offset
> > +
> > +* page_pool_put_page(): The outcome of this depends on the page refcnt. If the
> > +  driver uses refcnt > 1 this will unmap the page. If the pool object is
> > +  responsible for DMA operations and account for the in-flight counting. 
> 
> Hm, above is not a sentence and it ends with a space character.
> Several lines end with a space character.  :(

i'll fix both on V2

> 
> > +  If the refcnt is 1, the allocator owns the page and will try to recycle and 
> > +  sync it to be re-used by the device using dma_sync_single_range_for_device().
> > +
> > +* page_pool_release_page(): Unmap the page (if mapped) and account for it on
> > +  inflight counters.
> 
> inflight is spelled as in-flight earlier.  Just choose one way, please.

ok

[...]
> > +    page_pool_put_page(page_pool, page, false);
> > +    xdp_rxq_info_unreg(&xdp_rxq);
> > +    page_pool_destroy(page_pool);

Thanks for the review, i'll wait until net-next reopens and update this

/Ilias