Improve the new driver contribution guide - Converting passive voice to active voice - Using imperative mood for recommendations - Removing "We recommend" and similar phrases - Simplifying wordy constructions
No technical content changes. Signed-off-by: Stephen Hemminger <[email protected]> --- doc/guides/contributing/new_driver.rst | 62 +++++++++++++------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/doc/guides/contributing/new_driver.rst b/doc/guides/contributing/new_driver.rst index 555e875329..23d986d941 100644 --- a/doc/guides/contributing/new_driver.rst +++ b/doc/guides/contributing/new_driver.rst @@ -6,10 +6,10 @@ Adding a New Driver =================== The DPDK project continuously grows its ecosystem by adding support for new devices. -This document is designed to assist contributors in creating DPDK drivers, +This document assists contributors in creating DPDK drivers, also known as Poll Mode Drivers (PMD). -By having public support for a device, we can ensure accessibility across various +By having public support for a device, we ensure accessibility across various operating systems and guarantee community maintenance in future releases. If a new device is similar to a device already supported by an existing driver, it is more efficient to update the existing driver. @@ -20,8 +20,8 @@ Here are our best practice recommendations for creating a new driver. Early Engagement with the Community ----------------------------------- -When creating a new driver, we highly recommend engaging with the DPDK -community early instead of waiting the work to mature. +When creating a new driver, engage with the DPDK community early +rather than waiting for the work to mature. These public discussions help align development of your driver with DPDK expectations. You may submit a roadmap before the release to inform the community of your plans. @@ -29,31 +29,31 @@ Additionally, sending a Request For Comments (RFC) early in the release cycle, or even during the prior release, is advisable. DPDK is mainly consumed via Long Term Support (LTS) releases. -It is common to target a new PMD to a LTS release. For this, -it is suggested to start upstreaming at least one release before a LTS release. +It is common to target a new PMD to an LTS release. For this, +start upstreaming at least one release before an LTS release. Progressive Work ---------------- -To continually progress your work, we recommend planning +To continually progress your work, plan for incremental upstreaming across multiple patch series or releases. -It's important to prioritize quality of the driver over upstreaming +Prioritize quality of the driver over upstreaming in a single release or single patch series. Finalizing ---------- -Once the driver has been upstreamed, -the author has a responsibility to the community to maintain it. +Once the driver is upstreamed, +the author is responsible for maintaining it. This includes the public test report. Authors must send a public test report after the first upstreaming of the PMD. The same public test procedure may be reproduced regularly per release. -After the PMD is upstreamed, the author should send a patch to update +After the PMD is upstreamed, send a patch to update `the website <https://core.dpdk.org/supported/>`_ with the name of the new PMD and supported devices via the `DPDK web mailing list <https://mails.dpdk.org/listinfo/web>`_. @@ -64,7 +64,7 @@ For more information about the role of maintainers, see :doc:`patches`. Splitting into Patches ---------------------- -We recommend that drivers are split into patches, +Split drivers into patches so that each patch represents a single feature. If the driver code is already developed, it may be challenging to split. However, there are many benefits to doing so. @@ -73,17 +73,17 @@ Splitting patches makes it easier to understand a feature and clarifies the list of components/files that compose that specific feature. It also enables the ability to track -from the source code to the feature it is enabled for, -and helps users to understand the reasoning and intention of implementation. +from the source code to the feature it enables, +and helps users understand the reasoning and intention of implementation. This kind of tracing is regularly required for defect resolution and refactoring. Another benefit of splitting the codebase per feature is that it highlights unnecessary or irrelevant code, as any code not belonging to any specific feature becomes obvious. -Git bisect is also more useful if patches are split per patch. +Git bisect is also more useful if patches are split per feature. -The split should focus on logical features rather than file-based divisions. +Focus the split on logical features rather than file-based divisions. Each patch in the series must compile without errors and should maintain functionality. @@ -92,20 +92,20 @@ Enable the build as early as possible within the series to facilitate continuous integration and testing. This approach ensures a clear and manageable development process. -We suggest splitting patches following this approach: +Split patches following this approach: -* Each patch should be organized logically as a new feature. +* Organize each patch logically as a new feature. * Run test tools per patch (See :ref:`tool_list`). * Update relevant documentation and `<driver>.ini` file with each patch. -The following order in the patch series is as suggested below. +The following order in the patch series is suggested. The first patch should have the driver's skeleton which should include: * Maintainers file update * Driver documentation * Document must have links to official product documentation web page -* The new document should be added into the index (`index.rst`) +* Add the new document to the index (`index.rst`) * Initial `<driver>.ini` file * Release notes announcement for the new driver @@ -152,10 +152,10 @@ Time synchronization, PTP Performance documentation ================================ ================================ -After all features are enabled, +After enabling all features, if there is remaining base code that is not upstreamed, -they can be upstreamed at the end of the patch series. -However, we recommend these patches are still split into logical groups. +upstream it at the end of the patch series. +However, still split these patches into logical groups. Additional Suggestions @@ -185,12 +185,12 @@ Remember to do the following: Dependencies ------------ -At times, drivers may have dependencies to external software. -For driver dependencies, same DPDK rules for dependencies applies. -Dependencies should be publicly and freely available, -drivers which depend on non-available components will not be accepted. +At times, drivers may have dependencies on external software. +For driver dependencies, the same DPDK rules for dependencies apply. +Dependencies should be publicly and freely available; +drivers that depend on unavailable components will not be accepted. If the required dependency is not yet publicly available, -then wait to submit the driver until the dependent library is available. +wait to submit the driver until the dependent library is available. .. _tool_list: @@ -199,10 +199,10 @@ Test Tools ---------- Build and check the driver's documentation. -Make sure there are no warnings, -and driver shows up in the relevant index page. +Ensure there are no warnings +and the driver shows up in the relevant index page. -Be sure to run the following test tools per patch in a patch series: +Run the following test tools per patch in a patch series: * `checkpatches.sh` * `check-git-log.sh` -- 2.51.0
