mbox series

[ovs-dev,0/8] Split up the DPDK howto

Message ID 20180212181306.6674-1-stephen@that.guru
Headers show
Series Split up the DPDK howto | expand

Message

Stephen Finucane Feb. 12, 2018, 6:12 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.

Now to go back to figure how exactly NUMA affinity works for and affects
PMD threads...

[*] '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'.

Stephen Finucane (8):
  doc: Add an overview of the 'dpdk' port
  doc: Add "PMD" topic document
  doc: Move additional sections to "physical ports" doc
  doc: Move "QoS" guide to its own document
  doc: Add "bridge" topic document
  doc: Move "pdump" guide to its own document
  doc: Split Jumbo Frames guide between two docs
  doc: Final cleanup of the DPDK howto

 Documentation/conf.py                    |   2 +-
 Documentation/howto/dpdk.rst             | 453 +++----------------------------
 Documentation/topics/dpdk/bridge.rst     | 103 +++++++
 Documentation/topics/dpdk/index.rst      |  11 +
 Documentation/topics/dpdk/pdump.rst      |  65 +++++
 Documentation/topics/dpdk/phy.rst        | 242 +++++++++++++++++
 Documentation/topics/dpdk/pmd.rst        | 139 ++++++++++
 Documentation/topics/dpdk/qos.rst        | 100 +++++++
 Documentation/topics/dpdk/vhost-user.rst |  53 +++-
 9 files changed, 740 insertions(+), 428 deletions(-)
 create mode 100644 Documentation/topics/dpdk/bridge.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

Comments

Ben Pfaff March 31, 2018, 6:12 p.m. UTC | #1 
Hi Ian.  I have not seen much feedback on this series.  Are you thinking
about merging it?  Stephen's contributions to the documentation are,
ordinarily, quite valuable.

Thanks,

Ben.

On Mon, Feb 12, 2018 at 06:12:58PM +0000, Stephen Finucane wrote:
> 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.
> 
> Now to go back to figure how exactly NUMA affinity works for and affects
> PMD threads...
> 
> [*] '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'.
> 
> Stephen Finucane (8):
>   doc: Add an overview of the 'dpdk' port
>   doc: Add "PMD" topic document
>   doc: Move additional sections to "physical ports" doc
>   doc: Move "QoS" guide to its own document
>   doc: Add "bridge" topic document
>   doc: Move "pdump" guide to its own document
>   doc: Split Jumbo Frames guide between two docs
>   doc: Final cleanup of the DPDK howto
> 
>  Documentation/conf.py                    |   2 +-
>  Documentation/howto/dpdk.rst             | 453 +++----------------------------
>  Documentation/topics/dpdk/bridge.rst     | 103 +++++++
>  Documentation/topics/dpdk/index.rst      |  11 +
>  Documentation/topics/dpdk/pdump.rst      |  65 +++++
>  Documentation/topics/dpdk/phy.rst        | 242 +++++++++++++++++
>  Documentation/topics/dpdk/pmd.rst        | 139 ++++++++++
>  Documentation/topics/dpdk/qos.rst        | 100 +++++++
>  Documentation/topics/dpdk/vhost-user.rst |  53 +++-
>  9 files changed, 740 insertions(+), 428 deletions(-)
>  create mode 100644 Documentation/topics/dpdk/bridge.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
> 
> -- 
> 2.14.3
> 
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
Stokes, Ian April 3, 2018, 8:59 a.m. UTC | #2 
> Hi Ian.  I have not seen much feedback on this series.  Are you thinking
> about merging it?  Stephen's contributions to the documentation are,
> ordinarily, quite valuable.
> 

Thanks for flagging this, I started reviewing last week and have feedback to give. I'm also going to highlight it at the community call this Wednesday as people have previously expressed interest in reformatting the docs from the current layout there, this is a good opportunity to review these again in the light of this patchset.

Thanks
Ian

> Thanks,
> 
> Ben.
> 
> On Mon, Feb 12, 2018 at 06:12:58PM +0000, Stephen Finucane wrote:
> > 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.
> >
> > Now to go back to figure how exactly NUMA affinity works for and
> > affects PMD threads...
> >
> > [*] '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'.
> >
> > Stephen Finucane (8):
> >   doc: Add an overview of the 'dpdk' port
> >   doc: Add "PMD" topic document
> >   doc: Move additional sections to "physical ports" doc
> >   doc: Move "QoS" guide to its own document
> >   doc: Add "bridge" topic document
> >   doc: Move "pdump" guide to its own document
> >   doc: Split Jumbo Frames guide between two docs
> >   doc: Final cleanup of the DPDK howto
> >
> >  Documentation/conf.py                    |   2 +-
> >  Documentation/howto/dpdk.rst             | 453 +++---------------------
> -------
> >  Documentation/topics/dpdk/bridge.rst     | 103 +++++++
> >  Documentation/topics/dpdk/index.rst      |  11 +
> >  Documentation/topics/dpdk/pdump.rst      |  65 +++++
> >  Documentation/topics/dpdk/phy.rst        | 242 +++++++++++++++++
> >  Documentation/topics/dpdk/pmd.rst        | 139 ++++++++++
> >  Documentation/topics/dpdk/qos.rst        | 100 +++++++
> >  Documentation/topics/dpdk/vhost-user.rst |  53 +++-
> >  9 files changed, 740 insertions(+), 428 deletions(-)  create mode
> > 100644 Documentation/topics/dpdk/bridge.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
> >
> > --
> > 2.14.3
> >
> > _______________________________________________
> > dev mailing list
> > dev@openvswitch.org
> > https://mail.openvswitch.org/mailman/listinfo/ovs-dev