mbox series

[ovs-dev,v2,0/9] Split up the DPDK how-to

Message ID 20180416143026.24561-1-stephen@that.guru
Headers show
Series Split up the DPDK how-to | expand

Message

Stephen Finucane April 16, 2018, 2:30 p.m. UTC 
The DPDK howto has slowly morphed into a catch all for everything DPDK,
which goes against the original design goal for 'howto' documents [*].
This series attempts to return some sanity to the universe by splitting
this document into many more 'topic' documents. Along the way, we add a
lot of semantic markup, rework some text, and add an overview on
'dpdk'-type ports (the original goal here).

There's a good chance I've made some mistakes in the process and I've
left TODOs for someone to resolve now or at a future date. I welcome
feedback on both of these.

[*] 'howto' documents are supposed to be brief, high-level overviews on
    a particular group of features, with a focus on the user. They're
    not as all-encompassing as a 'tutorial', but not as specific as a
    'topic'.

Changes since v1:
- Addressed comments from Ian Stokes

Stephen Finucane (9):
  doc: Add an overview of the 'dpdk' port
  doc: Add "PMD" topic document
  doc: Move additional sections to "physical ports" doc
  doc: Add "vdev" topic document
  doc: Move "QoS" guide to its own document
  doc: Add "bridge" topic document
  doc: Move "pdump" guide to its own document
  doc: Add "jumbo frames" topic document
  doc: Final cleanup of the DPDK documents

 Documentation/conf.py                      |   2 +-
 Documentation/howto/dpdk.rst               | 454 +++--------------------------
 Documentation/topics/dpdk/bridge.rst       | 104 +++++++
 Documentation/topics/dpdk/index.rst        |  20 +-
 Documentation/topics/dpdk/jumbo-frames.rst |  71 +++++
 Documentation/topics/dpdk/pdump.rst        |  65 +++++
 Documentation/topics/dpdk/phy.rst          | 226 ++++++++++++++
 Documentation/topics/dpdk/pmd.rst          | 156 ++++++++++
 Documentation/topics/dpdk/qos.rst          |  76 +++++
 Documentation/topics/dpdk/ring.rst         |   5 +
 Documentation/topics/dpdk/vdev.rst         |  64 ++++
 Documentation/topics/dpdk/vhost-user.rst   |  28 +-
 12 files changed, 843 insertions(+), 428 deletions(-)
 create mode 100644 Documentation/topics/dpdk/bridge.rst
 create mode 100644 Documentation/topics/dpdk/jumbo-frames.rst
 create mode 100644 Documentation/topics/dpdk/pdump.rst
 create mode 100644 Documentation/topics/dpdk/phy.rst
 create mode 100644 Documentation/topics/dpdk/pmd.rst
 create mode 100644 Documentation/topics/dpdk/qos.rst
 create mode 100644 Documentation/topics/dpdk/vdev.rst