[dpdk-dev] [PATCH 1/6] doc: add empty PMDs todo list

Mcnamara, John john.mcnamara at intel.com
Mon Dec 11 12:52:29 CET 2017



> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Tuesday, November 21, 2017 1:43 AM
> To: Thomas Monjalon <thomas at monjalon.net>; Mcnamara, John
> <john.mcnamara at intel.com>
> Cc: dev at dpdk.org; Yigit, Ferruh <ferruh.yigit at intel.com>
> Subject: [PATCH 1/6] doc: add empty PMDs todo list
> 
> Some library modifications require extra checks or modifications in PMDs
> but currently we don't have a good way to trace these modifications.
> 
> And number of these kind of updates increasing by time.
> 
> This is an effort to document and track library updates that requires
> attention in PMDs.
> 
> Although this is under documentation main use case is for internal
> development.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>

>...
>
> +PMDs internal TODO list
> +=======================
> +
> +This is the list for tracking required PMD changes triggered by library
> modifications.
> +
> +.. table:: PMDs internal TODO list
> +
> + +------+------+----------+----------------+------+
> + | TODO | PMDs | Deadline | Related Commit | Note |
> + +======+======+==========+================+======+
> + |      |      |          |                |      |
> + +------+------+----------+----------------+------+


The table should have a label, and it should be indented to the level of .. table
as shown in the guidelines: http://dpdk.org/doc/guides/contributing/documentation.html#rst-guidelines

Something like this:

.. _table_nic_todo:

.. table:: PMDs internal TODO list

   +------+------+----------+----------------+------+
   | TODO | PMDs | Deadline | Related Commit | Note |
   +======+======+==========+================+======+
   |      |      |          |                |      |
   +------+------+----------+----------------+------+

However, it isn't an error so:


Acked-by: John McNamara <john.mcnamara at intel.com>



More information about the dev mailing list