Skip to content

Improve Linux drivers GSG section

Bruce Richardson dpdk-dev 2 versions – Applied

Status from this message: Applied, thanks.

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest9 patches 1 replyApplied
  2. v19 patches 0 repliesSuperseded

Changes in v2 from the cover letter

* Rebased on top of main, now that other doc patches are applied
* Reworded commit titles to use "doc:" prefix

Patches in v2 Applied

#Subject and filesSizeRepliesApplied
1/9doc: replace special characters for (R) symbol in Linux GSGdoc/guides/linux_gsg/enable_func.rst doc/guides/linux_gsg/linux_drivers.rst doc/guides/linux_gsg/sys_reqs.rst+13 -70 replies
2/9doc: fix missing note on UIO module in Linux GSGdoc/guides/linux_gsg/linux_drivers.rst+5 -00 replies
3/9doc: make UIO safety warning more visible in Linux GSGdoc/guides/linux_gsg/linux_drivers.rst+5 -50 replies
4/9doc: move section on binding drivers up the page in GSGdoc/guides/linux_gsg/linux_drivers.rst+90 -890 replies
5/9doc: emphasise VFIO over UIO-based modules in GSGdoc/guides/linux_gsg/linux_drivers.rst+28 -190 replies
6/9doc: split GSG VFIO section into subsectionsdoc/guides/linux_gsg/linux_drivers.rst+19 -160 replies
7/9doc: move GSG section on UIO to the end of drivers pagedoc/guides/linux_gsg/linux_drivers.rst+52 -520 replies
8/9doc: consolidate all VFIO content on GSG driver pagedoc/guides/linux_gsg/linux_drivers.rst+58 -580 replies
9/9doc: change informational warnings to notes in Linux GSGdoc/guides/linux_gsg/linux_drivers.rst+2 -20 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v2 yet.

Read the v2 thread

Cover letter [PATCH v2 0/9] Improve Linux drivers GSG section

This patchset reworks large parts of the linux drivers section of the Linux Getting Started Guide, so as to make it clearer and easier to read. The overall flow of the page is adjusted so that more important information is nearer the top, and so that all information on VFIO is consolidated into a single section. In terms of the content of the sections, there are some minor changes to adjust what is a warning vs just a "note" in the doc, and there are some updates to increase emphasis on VFIO ovs UIO.

Including stable on CC for the set, as all patches may be candidates for backport to help improve docs for older releases too.

V2:
* Rebased on top of main, now that other doc patches are applied
* Reworded commit titles to use "doc:" prefix

Bruce Richardson (9):
doc: replace special characters for (R) symbol in Linux GSG
doc: fix missing note on UIO module in Linux GSG
doc: make UIO safety warning more visible in Linux GSG
doc: move section on binding drivers up the page in GSG
doc: emphasise VFIO over UIO-based modules in GSG
doc: split GSG VFIO section into subsections
doc: move GSG section on UIO to the end of drivers page
doc: consolidate all VFIO content on GSG driver page
doc: change informational warnings to notes in Linux GSG

 doc/guides/linux_gsg/enable_func.rst   |   8 +-
 doc/guides/linux_gsg/linux_drivers.rst | 396 +++++++++++++------------
 doc/guides/linux_gsg/sys_reqs.rst      |   6 +-
 3 files changed, 217 insertions(+), 193 deletions(-)

--
2.32.0