[dpdk-dev,1/6] doc: add empty PMDs todo list
Checks
Commit Message
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@intel.com>
---
MAINTAINERS | 1 +
doc/guides/nics/index.rst | 1 +
doc/guides/nics/todo.rst | 43 +++++++++++++++++++++++++++++++++++++++++++
3 files changed, 45 insertions(+)
create mode 100644 doc/guides/nics/todo.rst
Comments
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Tuesday, November 21, 2017 1:43 AM
> To: Thomas Monjalon <thomas@monjalon.net>; Mcnamara, John
> <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Yigit, Ferruh <ferruh.yigit@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@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@intel.com>
@@ -315,6 +315,7 @@ Networking Drivers
M: Ferruh Yigit <ferruh.yigit@intel.com>
T: git://dpdk.org/next/dpdk-next-net
F: doc/guides/nics/features/default.ini
+F: doc/guides/nics/todo.rst
Link bonding
M: Declan Doherty <declan.doherty@intel.com>
@@ -37,6 +37,7 @@ Network Interface Controller Drivers
overview
features
+ todo
build_and_test
ark
avp
new file mode 100644
@@ -0,0 +1,43 @@
+.. BSD LICENSE
+ Copyright(c) 2017 Intel Corporation. All rights reserved.
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
+ the documentation and/or other materials provided with the
+ distribution.
+ * Neither the name of Intel Corporation nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+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 |
+ +======+======+==========+================+======+
+ | | | | | |
+ +------+------+----------+----------------+------+