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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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:
>
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
I have revised these sections to suit the template, but also,
for punctuation, clarity, and removing repitition when necessary.
Signed-off-by: Nandini Persad
---
doc/guides/sample_app_ug/dist_app.rst | 24 +--
.../sample_app_ug/eventdev_pipeline.rst | 20 +--
doc/guides
I have revised these sections to suit the template, but also,
for punctuation, clarity, and removing repetition when necessary.
Signed-off-by: Nandini Persad
---
doc/guides/sample_app_ug/dist_app.rst | 24 +--
.../sample_app_ug/eventdev_pipeline.rst | 20 +--
doc/guides
I'm reviewing the Contributor's Guidelines to be more
clear and concise where necessary.
Signed-off-by: Nandini Persad
---
doc/guides/contributing/coding_style.rst | 105 +++
doc/guides/contributing/design.rst | 9 +-
doc/guides/contributing/new_library.
I have uploaded all these known issues into Bugzilla,
so they are not needed here anymore.
Signed-off-by:
---
doc/guides/rel_notes/known_issues.rst | 875 --
1 file changed, 875 deletions(-)
delete mode 100644 doc/guides/rel_notes/known_issues.rst
diff --git a/doc/guide
I have uploaded all these known issues into Bugzilla,
so they are not needed here anymore.
Signed-off-by:
---
doc/guides/rel_notes/index.rst| 1 -
doc/guides/rel_notes/known_issues.rst | 875 --
2 files changed, 876 deletions(-)
delete mode 100644 doc/guides/re
I have uploaded all these known issues into Bugzilla,
so they are not needed here anymore.
Signed-off-by: Nandini Persad
---
doc/guides/rel_notes/index.rst| 1 -
doc/guides/rel_notes/known_issues.rst | 875 --
2 files changed, 876 deletions(-)
delete mode
Reviewing the Contributor Guidleines for grammar and
comprehension.
Signed-off-by: Nandini Persad
---
doc/guides/contributing/coding_style.rst | 105 +++
doc/guides/contributing/design.rst | 9 +-
doc/guides/contributing/new_library.rst | 31 ---
3 files
46 matches
Mail list logo
