mbox

[0/9] Improve linux drivers GSG section

Message ID 20220302172217.472279-1-bruce.richardson@intel.com (mailing list archive)
Headers

Message

Bruce Richardson March 2, 2022, 5:22 p.m. UTC 
  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.

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

 doc/guides/linux_gsg/enable_func.rst   |  16 +-
 doc/guides/linux_gsg/linux_drivers.rst | 396 +++++++++++++------------
 doc/guides/linux_gsg/sys_reqs.rst      |  10 +-
 3 files changed, 223 insertions(+), 199 deletions(-)

--
2.32.0