[dpdk-dev] [PATCH] doc: fix PDF build of bbdev prog guide
Chautru, Nicolas
nicolas.chautru at intel.com
Thu Jul 18 16:59:11 CEST 2019
From: Thomas Monjalon [mailto:thomas at monjalon.net]
>18/07/2019 15:33, Chautru, Nicolas:
>> From: Thomas Monjalon [mailto:thomas at monjalon.net]
>> >Anyway all the documentation about the API details should be removed.
>> >The guide is expected to give an understanding of the whole design, not replacing the details maintained in the doxygen comments.
>>
>> Thanks Thomas.
>> These tables are arguably useful on that page with the related contextual verbose information aside which provide more context usage. Still I am reformatting into simpler table structure.
>> I have just pushed a parallel patch here :
>> https://patches.dpdk.org/patch/56715/
>
>Sorry, I am not sure to understand.
>You want to keep all this information?
I would rather yes. I can see your point with some redundancy between code and documentation, but the bbdev.rst documentation is arguably clearer as it is : the detailed information in paragraphs puts into context some of the information captured in a nice and concise table. Clearer than having to go back and forth in doxygen capturing some of this in a less compact format (which still has its own complementary value). Matter of opinion, let me know if you have a fundamental concern with keeping such table in that document.
More information about the dev
mailing list