[PATCH 00/33] Update net driver documentation
Thomas Monjalon
thomas at monjalon.net
Tue Mar 28 18:59:12 CEST 2023
22/03/2023 00:59, Ferruh Yigit:
> Some PMDs has "Pre-Installation Configuration" section in their documentation,
> although section is not clear I assume that is historical from times compile
> time parameters and 'make' build system used, where common make target was
> 'install', so section refers to compile time configuration.
>
> Right now device arguments ("Runtime configuration") is documented under this
> section which is confusing, so updating section name
> from "Pre-Installation Configuration" to "Configuration".
>
> While touching documents trying to keep following template in the documents,
> with section names and order, to have consistent documents without being
> too strict on applying the template:
>
> [Overview]
> Supported Devices
> Supported Features
> Prerequisites
> Configuration
> Compilation Options
> Environment variables
> Runtime Configuration
> Debugging
> Limitations or Known issues
> Testpmd driver specific commands
>
> Note: Patch sent as each driver separately to help review, it can be squashed
> while merging.
Squashed and applied, thanks.
> Other further improvements not covered here can be visiting
> "Building DPDK" sections which has redundant and less useful information,
> and "Usage example" section which has testpmd log, most of the part is same for
> all drivers.
Yes, good idea to remove redundant information and replace with good links.
More information about the dev
mailing list