From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH v2 07/12] doc: improve new library guide style
Date: Fri, 16 Jan 2026 12:14:25 -0800 [thread overview]
Message-ID: <20260116201738.74578-8-stephen@networkplumber.org> (raw)
In-Reply-To: <20260116201738.74578-1-stephen@networkplumber.org>
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@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
next prev parent reply other threads:[~2026-01-16 20:18 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-14 22:54 [PATCH 00/11] doc: improve contributing documentation clarity and style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 01/11] doc: correct grammar and typos in design guide Stephen Hemminger
2026-01-14 22:54 ` [PATCH 02/11] doc: improve ABI policy documentation style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 03/11] doc: improve coding style guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 04/11] doc: improve documentation guidelines style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 05/11] doc: improve Linux uAPI header documentation Stephen Hemminger
2026-01-14 22:54 ` [PATCH 06/11] doc: improve new driver guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 07/11] doc: improve new library guide style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 08/11] doc: improve patch submission guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 09/11] doc: improve stable releases documentation Stephen Hemminger
2026-01-14 22:54 ` [PATCH 10/11] doc: improve unit test guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 11/11] doc: improve vulnerability process documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 00/12] doc: improve contributing documentation clarity and style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 01/12] doc: correct grammar and typos in design guide Stephen Hemminger
2026-03-31 22:41 ` Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 02/12] doc: improve ABI policy documentation style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 03/12] doc: improve coding style guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 04/12] doc: improve documentation guidelines style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 05/12] doc: improve Linux uAPI header documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 06/12] doc: improve new driver guide readability Stephen Hemminger
2026-01-16 20:14 ` Stephen Hemminger [this message]
2026-01-16 20:14 ` [PATCH v2 08/12] doc: improve patch submission " Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 09/12] doc: improve stable releases documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 10/12] doc: improve vulnerability process documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 11/12] doc: improve unit test guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 12/12] doc: fix grammar and style in ABI versioning guide Stephen Hemminger
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260116201738.74578-8-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox