[PATCH v3] doc: reword glossary

2024-12-01 Thread Nandini Persad
I added additional reference links and definitions to many of the terms in the glossary. Please feel free to provide feedback to ensure my definitions suit the proper context in the DPDK community. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/glossary.rst | 120

[PATCH v2] doc: reword glossary

2024-11-21 Thread Nandini Persad
I added additional reference links and definitions to many of the terms in the glossary. Please feel free to provide feedback to ensure my definitions suit the proper context in the DPDK community. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/glossary.rst | 101

[PATCH] doc: reword glossary

2024-11-21 Thread Nandini Persad
I added additional reference links and definitions to many of the terms in the glossary. Please feel free to provide feedback to ensure my definitions suit the proper context in the DPDK community. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/glossary.rst | 107

[PATCH v3] doc: add security document

2024-11-19 Thread Nandini Persad
This is a new document covering security protocols implemented in DPDK. Signed-off-by: Nandini Persad Signed-off-by: Thomas Monjalon Reviewed-by: Stephen Hemminger --- doc/guides/index.rst | 1 + doc/guides/security/index.rst | 336 ++ 2 files

[PATCH v2] doc: add security document

2024-11-18 Thread Nandini Persad
This is a new document covering security protocols implemented in DPDK. Signed-off-by: Nandini Persad Signed-off-by: Thomas Monjalon Reviewed-by: Stephen Hemminger --- V2 - incorporate review feedback doc/guides/index.rst | 1 + doc/guides/security/security.rst | 337

[PATCH] doc/guides: add security document

2024-11-12 Thread Nandini Persad
This is a new document covering security protocols implemented in DPDK. Signed-off-by: Nandini Persad Signed-off-by: Thomas Monjalon Reviewed-by: Stephen Hemminger --- doc/guides/index.rst | 1 + doc/guides/security/index.rst | 333 ++ 2 files

[PATCH] doc: reword sample app guides

2024-10-21 Thread Nandini Persad
I revised these sections mostly for grammar and clarity. Signed-off-by: Nandini Persad --- doc/guides/sample_app_ug/l2_forward_cat.rst | 24 +++-- doc/guides/sample_app_ug/l2_forward_event.rst | 96 +-- .../sample_app_ug/l2_forward_macsec.rst | 8 +- .../sample_app_ug

[PATCH v3] doc: reword sample app guides

2024-10-14 Thread Nandini Persad
I have reviewed these sections for grammar/clarity and made small modifications to the formatting of sections to adhere to a template which will create uniformality in the sample application user guides overall. Signed-off-by: Nandini Persad Acked-by: Chengwen Feng --- doc/guides/sample_app_ug

[PATCH v2] doc: reword sample app guides

2024-10-10 Thread Nandini Persad
I have reviewed these sections for grammar/clarity and made small modifications to the formatting of sections to adhere to a template which will create uniformality in the sample application user guides overall. Signed-off-by: Nandini Persad Acked-by: Chengwen Feng --- doc/guides/sample_app_ug

[PATCH] doc: reword sample app guides

2024-10-09 Thread Nandini Persad
I have reviewed these sections for grammar/clarity and made small modifications to the formatting of sections to adhere to a template which will create uniformality in the sample application user guides overall. Signed-off-by: Nandini Persad Acked-by: Chengwen Feng --- doc/guides/sample_app_ug

[PATCH v2] doc: reword sample app guides

2024-10-06 Thread Nandini Persad
I have reviewed these sections for grammar/clarity and made small modifications to the formatting of sections to adhere to a template which will create uniformality in the sample application user guides overall. Signed-off-by: Nandini Persad --- .../prog_guide/switch_representation.rst

[PATCH] doc: reword sample app guides

2024-10-06 Thread Nandini Persad
I have reviewed these sections for grammar/clarity and made small modifications to the formatting of sections to adhere to a template which will create uniformality in the sample application user guides overall. Signed-off-by: Nandini Persad --- .../prog_guide/switch_representation.rst

[PATCH] doc: reword sample app guides

2024-10-06 Thread Nandini Persad
I have reviewed these sections for grammar/clarity and made small modifications to the formatting of sections to adhere to a template which will create uniformality in the sample application user guides overall. Signed-off-by: Nandini Persad --- .../prog_guide/switch_representation.rst

[PATCH v6] doc: add new driver guidelines

2024-10-06 Thread Nandini Persad
This document was created to assist contributors in creating DPDK drivers and provides suggestions and guidelines on how to upstream effectively. Signed-off-by: Ferruh Yigit Signed-off-by: Nandini Persad Reviewed-by: Stephen Hemminger Acked-by: Chengwen Feng --- doc/guides/contributing

[PATCH v5] doc: add new driver guidelines

2024-10-04 Thread Nandini Persad
This document was created to assist contributors in creating DPDK drivers and provides suggestions and guidelines on how to upstream effectively. Signed-off-by: Ferruh Yigit Signed-off-by: Nandini Persad Reviewed-by: Stephen Hemminger Acked-by: Chengwen Feng --- doc/guides/contributing

Re: [PATCH v3] doc: add new driver guidelines

2024-09-12 Thread Nandini Persad
Excellent. Will send the update in accordingly. From: Ferruh Yigit Sent: Thursday, September 12, 2024 6:37:35 AM To: Nandini Persad Cc: dev@dpdk.org ; Thomas Mojalon ; Stephen Hemminger Subject: Re: [PATCH v3] doc: add new driver guidelines On 9/12/2024 2:18

Re: [PATCH v3] doc: add new driver guidelines

2024-09-12 Thread Nandini Persad
just say “Avoid”. From: Ferruh Yigit Sent: Thursday, September 12, 2024 1:13:33 AM To: Nandini Persad Cc: dev@dpdk.org ; Thomas Mojalon ; Stephen Hemminger Subject: Re: [PATCH v3] doc: add new driver guidelines On 9/11/2024 5:04 PM, Nandini Persad wrote: >

Re: [PATCH v3] doc: add new driver guidelines

2024-09-11 Thread Nandini Persad
cense tags and copyright notices on all sides. - Don’t introduce public APIs directly from the driver. It's slightly more friendly. Let me know what you think, I'm open to trying another way. On Tue, Sep 10, 2024 at 5:16 PM Ferruh Yigit wrote: > On 9/10/2024 3:58 PM, Nandini Persad w

[PATCH v3] doc: add new driver guidelines

2024-09-10 Thread Nandini Persad
This document was created to assist contributors in creating DPDK drivers, providing suggestions and guidelines for how to upstream effectively. Co-authored-by: Ferruh Yigit Co-authored-by: Thomas Mojalon Signed-off-by: Nandini Persad Acked-by: Chengwen Feng --- doc/guides/contributing

[PATCH] doc: add new driver guidelines

2024-08-13 Thread Nandini Persad
This document was created to assist contributors in creating DPDK drivers, providing suggestions and guidelines on how to upstream effectively. Signed-off-by: Ferruh Yigit , Thomas Monjalon , Nandini Persad --- 0001-doc-add-new-driver-guidelines.patch | 206 +++ doc/guides

[PATCH v2 9/9] doc: reword rcu library section in prog guide

2024-06-20 Thread Nandini Persad
Simple syntax changes made to the rcu library section in programmer's guide. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/rcu_lib.rst | 77 --- 1 file changed, 40 insertions(+), 37 deletions(-) diff --git a/doc/guides/prog_guide/rcu_lib.rst b/doc/g

[PATCH v2 8/9] doc: reword stack library section in prog guide

2024-06-20 Thread Nandini Persad
Minor changes made to wording of the stack library section in prog guide. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/stack_lib.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/guides/prog_guide/stack_lib.rst b/doc/guides/prog_guide/stack_lib.rst

[PATCH v2 7/9] doc: reword cmdline section in prog guide

2024-06-20 Thread Nandini Persad
Minor syntax edits made to the cmdline section. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/cmdline.rst | 34 +++ 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/guides/prog_guide/cmdline.rst b/doc/guides/prog_guide/cmdline.rst index

[PATCH v2 6/9] doc: reword log library section in prog guide

2024-06-20 Thread Nandini Persad
Minor changes made for syntax in the log library section and 7.1 section of the programmer's guide. A couple sentences at the end of the trace library section were also edited. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/cmdline.rst | 24 +++--- doc/g

[PATCH v2 5/9] doc: reword trace library section in prog guide

2024-06-20 Thread Nandini Persad
Minor syntax edits were made to sect the trace library section of prog guide. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/trace_lib.rst | 50 ++--- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/doc/guides/prog_guide/trace_lib.rst b/doc

[PATCH v2 4/9] doc: reword service cores section in prog guide

2024-06-20 Thread Nandini Persad
I've made minor syntax changes to section 8 of programmer's guide, service cores. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/service_cores.rst | 32 - 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/guides/prog_guide/service_co

[PATCH v2 3/9] doc: reword design section in contributors guidelines

2024-06-20 Thread Nandini Persad
Minor editing was made for grammar and syntax of design section. Signed-off-by: Nandini Persad --- .mailmap | 1 + doc/guides/contributing/design.rst | 86 +++--- doc/guides/linux_gsg/sys_reqs.rst | 2 +- 3 files changed, 45 insertions(+), 44

[PATCH v2 2/9] doc: reword argparse section in prog guide

2024-06-20 Thread Nandini Persad
I have made small edits for syntax in this section. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/argparse_lib.rst | 75 +- 1 file changed, 38 insertions(+), 37 deletions(-) diff --git a/doc/guides/prog_guide/argparse_lib.rst b/doc/guides/prog_guide

[PATCH v2 1/9] doc: reword pmd section in prog guide

2024-06-20 Thread Nandini Persad
I made edits for syntax/grammar the PMD section of the prog guide. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/poll_mode_drv.rst | 151 1 file changed, 73 insertions(+), 78 deletions(-) diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides

[PATCH 9/9] doc: reword rcu library section in prog guide

2024-05-13 Thread Nandini Persad
simple syntax changes made to rcu library sectionin programmer's guide Signed-off-by: Nandini Persad --- doc/guides/prog_guide/rcu_lib.rst | 77 --- 1 file changed, 40 insertions(+), 37 deletions(-) diff --git a/doc/guides/prog_guide/rcu_lib.rst b/doc/g

[PATCH 8/9] doc: reword stack library section in prog guide

2024-05-13 Thread Nandini Persad
minor change made to wording Signed-off-by: Nandini Persad --- doc/guides/prog_guide/stack_lib.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/guides/prog_guide/stack_lib.rst b/doc/guides/prog_guide/stack_lib.rst index 975d3ad796..a51df60d13 100644 --- a/doc

[PATCH 7/9] doc: reword cmdline section in prog guide

2024-05-13 Thread Nandini Persad
minor syntax edits Signed-off-by: Nandini Persad --- doc/guides/prog_guide/cmdline.rst | 34 +++ 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/guides/prog_guide/cmdline.rst b/doc/guides/prog_guide/cmdline.rst index 6b10ab6c99..8aa1ef180b 100644

[PATCH 6/9] doc: reword log library section in prog guide

2024-05-13 Thread Nandini Persad
minor changes made for syntax in the log library section and 7.1 section of the programmer's guide. A couple sentences at the end of the trace library section were also edited. Signed-off-by: Nandini Persad --- doc/guides/prog_guide/cmdline.rst | 24 +++--- doc/g

[PATCH 3/9] doc: reword argparse section in prog guide

2024-05-13 Thread Nandini Persad
made small edits to sections 6.1 and 6.2 intro Signed-off-by: Nandini Persad --- doc/guides/prog_guide/argparse_lib.rst | 72 +- 1 file changed, 35 insertions(+), 37 deletions(-) diff --git a/doc/guides/prog_guide/argparse_lib.rst b/doc/guides/prog_guide

[PATCH 2/9] doc: reword pmd section in prog guide

2024-05-13 Thread Nandini Persad
made small edits to section 15.1 and 15.5 Signed-off-by: Nandini Persad --- doc/guides/prog_guide/poll_mode_drv.rst | 151 1 file changed, 73 insertions(+), 78 deletions(-) diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst

[PATCH 5/9] doc: reword trace library section in prog guide

2024-05-13 Thread Nandini Persad
made minor syntax edits to sect 9.1-9.7 of prog guide Signed-off-by: Nandini Persad --- doc/guides/prog_guide/trace_lib.rst | 50 ++--- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/doc/guides/prog_guide/trace_lib.rst b/doc/guides/prog_guide

[PATCH 4/9] doc: reword service cores section in prog guide

2024-05-13 Thread Nandini Persad
made minor syntax changes to section 8 of programmer's guide, service cores Signed-off-by: Nandini Persad --- doc/guides/prog_guide/service_cores.rst | 32 - 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/guides/prog_guide/service_cores.rst

[PATCH 1/9] doc: reword design section in contributors guidelines

2024-05-13 Thread Nandini Persad
minor editing for grammar and syntax of design section Signed-off-by: Nandini Persad --- .mailmap | 1 + doc/guides/contributing/design.rst | 79 ++ doc/guides/linux_gsg/sys_reqs.rst | 2 +- 3 files changed, 38 insertions(+), 44 deletions

[PATCH 0/9] reowrd in prog guide

2024-05-13 Thread Nandini Persad
I reviewed and made small syntax and grammatical edits to sections in the programmer's guide and the design section of the contributor's guidelines. Nandini Persad (9): doc: reword design section in contributors guidelines doc: reword pmd section in prog guide doc: reword argpar