[dpdk-dev] [PATCH v14 5/6] doc: add DMA device library guide

[fengchengwen]

Hi Conor,

Already sent v15, Most of feedback modified, unmodified inline

Thanks.

On 2021/8/10 23:27, Walsh, Conor wrote:
> [snip]
> 
> Hi Chengwen,
> I have included some feedback to improve the grammar and readability
> of the docs inline.
> 

[snip]

>> +the EAL command line options.
>> +
>> +And then dmadevs are dynamically allocated by
> 
> ^ Change "And then" to "After DPDK initialization".

It is part of DPDK initialization, I modify by other ways.

> 
>> rte_dmadev_pmd_allocate() based on
>> +the number of hardware DMA channels.

[snip]

>> +The first API returns the number of operation requests completed
>> successfully,
>> +the second API returns the number of operation requests completed which
>> may
>> +successfully or failed and also with meaningful status code.
> 
> Replace above line with the following:
> "``rte_dmadev_completed`` will return the number of successfully completed operations.
> ``rte_dmadev_completed_status`` will return the total number of completed operations

I remove the 'total' because the return limited by nb_cpls.

> along with the status of each operation (filled into the ``status`` array passed by user)>
>> Also these two
>> +APIs could return the last completed operation's ring_idx which will help to
>> +track application-defined circular ring.
> 
> Replace the last line with this:
> "These two APIs can also return the last completed operations ``ring_idx`` which
> could help developers track operations within their own application-defined rings."

I change the developers to user.

> 
> With the improvements suggested above,
> Acked-by: Conor Walsh <conor.walsh at intel.com>
> 
> Thanks,
> Conor.
> .
>