[dpdk-dev,PULL,REQUEST] doc: document modifications in user guides
mbox

Message ID 1417621813-24826-1-git-send-email-bernard.iremonger@intel.com
State Changes Requested, archived
Headers show

Pull-request

git://dpdk.org/next/dpdk-doc master

Message

Iremonger, Bernard Dec. 3, 2014, 3:50 p.m. UTC
These changes are DPDK 1.8 modifications and some corrections to the
Linux Getting Started Guide, the FreeBSD Getting Started Guide,
the Programmers Guide, the Sample Application User Guide,
the TestPMD Application User Guide and the Release Notes.

The following changes since commit b6f80756e7b78a8a2a8688bc475a2cb8f6e3a188:

  kni: create interface in current network namespace (2014-12-03 15:01:08 +0100)

are available in the git repository at:
  git://dpdk.org/next/dpdk-doc  master


Bruce Richardson (3):
      doc: change hardcoded date to auto-generated in guide documents
      doc: adjust line lengths in freebsd getting started guide rst files
      doc: update freebsd getting started guide to document ports install

Doherty, Declan (1):
      doc: link bonding related updates to programmers guide

Pablo de Lara (4):
      doc: added new commands in testpmd application user guide
      doc: fix commands in testpmd application user guide
      doc: moved commands in testpmd application user guide to match testpmd command help order
      doc: fixes in testpmd application user guide

Siobhan Butler (4):
      doc: added distributor sample application to the sample application user guide
      doc: add vhost library section in programmers guide
      doc: updated i40e enabling additonal functionality in linux getting started guide
      doc: remove references to intel dpdk in linux getting started guide

 doc/guides/freebsd_gsg/build_dpdk.rst              |  295 ++++--
 doc/guides/freebsd_gsg/build_sample_apps.rst       |   96 +-
 doc/guides/freebsd_gsg/index.rst                   |    4 +-
 doc/guides/freebsd_gsg/install_from_ports.rst      |  162 +++
 doc/guides/freebsd_gsg/intro.rst                   |   55 +-
 doc/guides/freebsd_gsg/sys_reqs.rst                |  163 ---
 doc/guides/linux_gsg/build_dpdk.rst                |  149 ++--
 doc/guides/linux_gsg/build_sample_apps.rst         |  146 ++-
 doc/guides/linux_gsg/enable_func.rst               |  158 ++-
 doc/guides/linux_gsg/index.rst                     |    2 +-
 doc/guides/linux_gsg/intro.rst                     |   37 +-
 doc/guides/linux_gsg/quick_start.rst               |   61 +-
 doc/guides/linux_gsg/sys_reqs.rst                  |  182 ++--
 doc/guides/prog_guide/img/bond-mode-0.svg          |  638 +++++++++++
 doc/guides/prog_guide/img/bond-mode-1.svg          |  724 +++++++++++++
 doc/guides/prog_guide/img/bond-mode-2.svg          |  702 ++++++++++++
 doc/guides/prog_guide/img/bond-mode-3.svg          |  702 ++++++++++++
 doc/guides/prog_guide/img/bond-mode-4.svg          |  784 ++++++++++++++
 doc/guides/prog_guide/img/bond-mode-5.svg          |  642 +++++++++++
 doc/guides/prog_guide/img/bond-overview.svg        |  121 +++
 doc/guides/prog_guide/img/link_bonding.png         |  Bin 223318 -> 0 bytes
 doc/guides/prog_guide/index.rst                    |    3 +-
 .../prog_guide/link_bonding_poll_mode_drv_lib.rst  |  365 +++++--
 doc/guides/prog_guide/vhost_lib.rst                |  101 ++
 doc/guides/rel_notes/index.rst                     |    2 +-
 doc/guides/sample_app_ug/dist_app.rst              |  177 +++
 doc/guides/sample_app_ug/img/dist_app.svg          |  442 ++++++++
 doc/guides/sample_app_ug/img/dist_perf.svg         |  459 ++++++++
 doc/guides/sample_app_ug/index.rst                 |    7 +-
 doc/guides/testpmd_app_ug/index.rst                |    2 +-
 doc/guides/testpmd_app_ug/testpmd_funcs.rst        | 1129 +++++++++++---------
 31 files changed, 7278 insertions(+), 1232 deletions(-)
 create mode 100644 doc/guides/freebsd_gsg/install_from_ports.rst
 delete mode 100644 doc/guides/freebsd_gsg/sys_reqs.rst
 create mode 100644 doc/guides/prog_guide/img/bond-mode-0.svg
 create mode 100644 doc/guides/prog_guide/img/bond-mode-1.svg
 create mode 100644 doc/guides/prog_guide/img/bond-mode-2.svg
 create mode 100644 doc/guides/prog_guide/img/bond-mode-3.svg
 create mode 100644 doc/guides/prog_guide/img/bond-mode-4.svg
 create mode 100644 doc/guides/prog_guide/img/bond-mode-5.svg
 create mode 100644 doc/guides/prog_guide/img/bond-overview.svg
 delete mode 100644 doc/guides/prog_guide/img/link_bonding.png
 create mode 100644 doc/guides/prog_guide/vhost_lib.rst
 create mode 100644 doc/guides/sample_app_ug/dist_app.rst
 create mode 100644 doc/guides/sample_app_ug/img/dist_app.svg
 create mode 100644 doc/guides/sample_app_ug/img/dist_perf.svg

Comments

Thomas Monjalon Dec. 3, 2014, 6:44 p.m. UTC | #1
Hi Bernard,

These patches won't pulled as is for 2 reasons:
1) I made some comments recently on some of these patches
2) It appears you didn't applied the v5 of Pablo's patchset
	http://dpdk.org/ml/archives/dev/2014-December/009270.html

Below some title rewording to make it concise and more consistent:

2014-12-03 15:50, Bernard Iremonger:
> Bruce Richardson (3):
>       doc: change hardcoded date to auto-generated in guide documents
doc: auto-generate date in guides
>       doc: adjust line lengths in freebsd getting started guide rst files
doc: adjust line lengths in freebsd guide
>       doc: update freebsd getting started guide to document ports install
doc: add freebsd ports
> 
> Doherty, Declan (1):
>       doc: link bonding related updates to programmers guide
doc: update bonding
> 
> Pablo de Lara (4):
>       doc: added new commands in testpmd application user guide
doc: new testpmd commands
>       doc: fix commands in testpmd application user guide
doc: fix testpmd commands
>       doc: moved commands in testpmd application user guide to match testpmd command help order
doc: reorder testpmd commands
>       doc: fixes in testpmd application user guide
doc: fix testpmd guide
> 
> Siobhan Butler (4):
>       doc: added distributor sample application to the sample application user guide
doc: add distributor application
>       doc: add vhost library section in programmers guide
doc: add vhost library
>       doc: updated i40e enabling additonal functionality in linux getting started guide
doc: update i40e
>       doc: remove references to intel dpdk in linux getting started guide
Iremonger, Bernard Dec. 4, 2014, 11:22 a.m. UTC | #2
Hi Thomas,
 
> Hi Bernard,
> 
> These patches won't pulled as is for 2 reasons:
> 1) I made some comments recently on some of these patches

Clearly I was too eager to apply these patches.
Are you happy with of the patches, if so I could a  send a request pull with a reduced patch set

> 2) It appears you didn't applied the v5 of Pablo's patchset
> 	http://dpdk.org/ml/archives/dev/2014-December/009270.html

There was conflict with Pablo's earlier patch set when I synced up with dpdk_main, which I thought I had resolved incorrectly.
When I applied the V5 patch set, I reworked this line "Quit to prompt:", so it should be correct now.
I can rebase and reapply Pablo's V5 patch set if that is a better solution.
 
> Below some title rewording to make it concise and more consistent:
> 
> 2014-12-03 15:50, Bernard Iremonger:
> > Bruce Richardson (3):
> >       doc: change hardcoded date to auto-generated in guide documents
> doc: auto-generate date in guides
> >       doc: adjust line lengths in freebsd getting started guide rst files
> doc: adjust line lengths in freebsd guide
> >       doc: update freebsd getting started guide to document ports install
> doc: add freebsd ports
> >
> > Doherty, Declan (1):
> >       doc: link bonding related updates to programmers guide
> doc: update bonding
> >
> > Pablo de Lara (4):
> >       doc: added new commands in testpmd application user guide
> doc: new testpmd commands
> >       doc: fix commands in testpmd application user guide
> doc: fix testpmd commands
> >       doc: moved commands in testpmd application user guide to match testpmd command help order
> doc: reorder testpmd commands
> >       doc: fixes in testpmd application user guide
> doc: fix testpmd guide
> >
> > Siobhan Butler (4):
> >       doc: added distributor sample application to the sample application user guide
> doc: add distributor application
> >       doc: add vhost library section in programmers guide
> doc: add vhost library
> >       doc: updated i40e enabling additonal functionality in linux getting started guide
> doc: update i40e
> >       doc: remove references to intel dpdk in linux getting started guide
> 
Are the reworded commit lines ok now.

> --
> Thomas

Regards,

Bernard.