[PATCH 07/11] doc: improve new library guide style
Stephen Hemminger
stephen at networkplumber.org
Wed Jan 14 23:54:11 CET 2026
Improve the new library contribution guide
- Converting passive voice to active voice
- Simplifying sentence structure
- Using more direct language
No technical content changes.
Signed-off-by: Stephen Hemminger <stephen at networkplumber.org>
---
doc/guides/contributing/new_library.rst | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/doc/guides/contributing/new_library.rst b/doc/guides/contributing/new_library.rst
index 99890beb29..25237b349f 100644
--- a/doc/guides/contributing/new_library.rst
+++ b/doc/guides/contributing/new_library.rst
@@ -10,15 +10,15 @@ Process for approval in principle
Rationale
~~~~~~~~~
-Adding a new library to DPDK with proper RFC and then full patch-sets is a significant work.
-In order to save effort, developers should get an early approval in principle,
-or an early feedback in case the library is not suitable for various reasons.
+Adding a new library to DPDK with proper RFC and then full patch-sets requires significant effort.
+To save effort, developers should seek early approval in principle,
+or early feedback if the library is unsuitable for various reasons.
Process
~~~~~~~
-#. When a contributor would like to add a new library to DPDK code base,
- the contributor must send the following items to DPDK mailing list
+#. When a contributor would like to add a new library to the DPDK code base,
+ the contributor must send the following items to the DPDK mailing list
for Technical Board approval-in-principle.
* Purpose of the library.
@@ -38,13 +38,13 @@ Process
* Any new library dependencies to DPDK.
-#. Technical Board to schedule discussion on this in upcoming Technical Board meeting
- along with author.
+#. Technical Board schedules discussion on this in an upcoming Technical Board meeting
+ along with the author.
Based on the Technical Board schedule and/or author availability,
Technical Board may need a maximum of **five** Technical Board meeting slots.
#. Based on mailing list and Technical Board meeting discussions,
- Technical Board to vote and share the decision in the mailing list.
+ Technical Board votes and shares the decision on the mailing list.
The decision outcome can be any of the following:
* Approved in principle
@@ -53,5 +53,5 @@ Process
#. Once the Technical Board approves the library in principle,
it is safe to start working on the implementation.
- However, the patches will need to meet the usual quality criteria
- in order to be effectively accepted.
+ However, the patches must meet the usual quality criteria
+ to be effectively accepted.
--
2.51.0
More information about the dev
mailing list