[dpdk-dev,PULL,REQUEST] doc: latest modifications to user guides
mbox

Message ID 1419010853-1480-1-git-send-email-bernard.iremonger@intel.com
State Accepted, archived
Headers show

Pull-request

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

Message

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

The following changes since commit 60c0be5b255054c77a6e4fc0bef777fc9c614275:

  enic: use eal to manage interrupts (2014-12-18 22:52:39 +0100)

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

Bernard Iremonger (1):
      doc: fix typos in prog_guide

Chao Zhu (1):
      doc: add IBM Power description to linux guides

De Lara Guarch, Pablo (1):
      doc: removed intel legal info from linux_gsg

Reshma Pattan (1):
      doc: fix setup menu options in linux gsg

Richardson, Bruce (2):
      doc: update mbuf section of prog_guide
      doc: updated svg files for rte_mbuf changes

Sergio Gonzalez Monroy (1):
      doc: add known issue for iommu and igb_uio

Siobhan Butler (22):
      doc: remove intel references from freebsd gsg
      doc: remove intel legal info from freebsd gsg
      doc: removed intel references from testpmd_ug
      doc: removed intel legal info from testpmd_ug
      doc: moved 1.7 new features to supported features for 1.8 in rel_notes
      doc: added new features to rel_notes
      doc: added to known issue 6.10 and removed fixed issue 6.29 from rel_notes
      doc: moved known issue 6.29 to resolved issues in rel_notes
      doc: remove appendix A from rel_notes
      doc: removed reference to Intel DPDK in rel_notes
      doc: updated resolved issues with old known issues
      doc: updating the list of sample apps in rel_notes
      doc: add udp info to prog_guide for vxlan
      doc: remove intel dpdk in sample app ug
      doc: remove intel legal info from sample app ug
      doc: add vxlan support to rel_notes
      doc: updating from 1.7 to 1.8 release note
      doc: add BSD License to dist sample app svg files
      doc: remove intel dpdk from prog_guide
      doc: removed intel legal info from prog_guide
      doc: updated i40e in linux_gsg
      doc: removed references to intel dpdk in linux_gsg

 doc/guides/freebsd_gsg/build_dpdk.rst              |   78 +++---
 doc/guides/freebsd_gsg/build_sample_apps.rst       |   40 ++--
 doc/guides/freebsd_gsg/index.rst                   |   38 ---
 doc/guides/freebsd_gsg/install_from_ports.rst      |   28 +-
 doc/guides/freebsd_gsg/intro.rst                   |   22 +-
 doc/guides/linux_gsg/build_dpdk.rst                |   72 +++---
 doc/guides/linux_gsg/build_sample_apps.rst         |   46 ++--
 doc/guides/linux_gsg/enable_func.rst               |   48 ++-
 doc/guides/linux_gsg/index.rst                     |   38 ---
 doc/guides/linux_gsg/intro.rst                     |   14 +-
 doc/guides/linux_gsg/quick_start.rst               |   94 +++---
 doc/guides/linux_gsg/sys_reqs.rst                  |   95 ++++---
 doc/guides/prog_guide/dev_kit_build_system.rst     |   24 +-
 doc/guides/prog_guide/dev_kit_root_make_help.rst   |   10 +-
 doc/guides/prog_guide/driver_vm_emul_dev.rst       |    8 +-
 doc/guides/prog_guide/env_abstraction_layer.rst    |   14 +-
 doc/guides/prog_guide/ext_app_lib_make_help.rst    |    2 +-
 doc/guides/prog_guide/extend_intel_dpdk.rst        |   14 +-
 doc/guides/prog_guide/glossary.rst                 |    6 +-
 doc/guides/prog_guide/hash_lib.rst                 |    6 +-
 .../prog_guide/i40e_ixgbe_igb_virt_func_drv.rst    |   72 +++---
 doc/guides/prog_guide/img/mbuf1.svg                |   48 ++--
 doc/guides/prog_guide/img/mbuf2.svg                |   65 ++--
 doc/guides/prog_guide/index.rst                    |   37 ---
 .../intel_dpdk_xen_based_packet_switch_sol.rst     |   36 ++--
 doc/guides/prog_guide/intro.rst                    |   22 +-
 .../prog_guide/ip_fragment_reassembly_lib.rst      |    2 +-
 doc/guides/prog_guide/ivshmem_lib.rst              |   32 +-
 doc/guides/prog_guide/kernel_nic_interface.rst     |   56 ++--
 .../libpcap_ring_based_poll_mode_drv.rst           |    8 +-
 .../prog_guide/link_bonding_poll_mode_drv_lib.rst  |    8 +-
 doc/guides/prog_guide/lpm_lib.rst                  |    2 +-
 doc/guides/prog_guide/malloc_lib.rst               |    6 +-
 doc/guides/prog_guide/mbuf_lib.rst                 |   28 +-
 doc/guides/prog_guide/mempool_lib.rst              |    2 +-
 doc/guides/prog_guide/multi_proc_support.rst       |   64 ++--
 doc/guides/prog_guide/overview.rst                 |   30 +-
 .../prog_guide/packet_classif_access_ctrl.rst      |    4 +-
 doc/guides/prog_guide/packet_distrib_lib.rst       |    4 +-
 doc/guides/prog_guide/packet_framework.rst         |    8 +-
 doc/guides/prog_guide/perf_opt_guidelines.rst      |    4 +-
 doc/guides/prog_guide/poll_mode_drv.rst            |   15 +-
 .../poll_mode_drv_emulated_virtio_nic.rst          |   12 +-
 .../poll_mode_drv_paravirtual_vmxnets_nic.rst      |   24 +-
 doc/guides/prog_guide/power_man.rst                |   10 +-
 doc/guides/prog_guide/profile_app.rst              |    4 +-
 doc/guides/prog_guide/qos_framework.rst            |   28 +-
 doc/guides/prog_guide/ring_lib.rst                 |    2 +-
 doc/guides/prog_guide/source_org.rst               |   10 +-
 .../thread_safety_intel_dpdk_functions.rst         |   24 +-
 doc/guides/prog_guide/timer_lib.rst                |    2 +-
 doc/guides/prog_guide/writing_efficient_code.rst   |   20 +-
 doc/guides/rel_notes/appendices.rst                |  324 --------------------
 doc/guides/rel_notes/faq.rst                       |   14 +-
 doc/guides/rel_notes/index.rst                     |   46 +---
 doc/guides/rel_notes/known_issues.rst              |  313 +++----------------
 doc/guides/rel_notes/new_features.rst              |   27 ++-
 doc/guides/rel_notes/rel_description.rst           |   42 ++--
 doc/guides/rel_notes/resolved_issues.rst           |  271 ++++++++++++++---
 doc/guides/rel_notes/supported_features.rst        |   37 ++-
 doc/guides/rel_notes/supported_os.rst              |    2 +-
 doc/guides/rel_notes/updating_apps.rst             |   25 ++-
 doc/guides/sample_app_ug/cmd_line.rst              |   10 +-
 doc/guides/sample_app_ug/exception_path.rst        |    8 +-
 doc/guides/sample_app_ug/hello_world.rst           |    8 +-
 doc/guides/sample_app_ug/img/dist_app.svg          |   36 +++-
 doc/guides/sample_app_ug/img/dist_perf.svg         |   37 +++-
 doc/guides/sample_app_ug/index.rst                 |   35 ---
 doc/guides/sample_app_ug/intel_quickassist.rst     |   18 +-
 .../sample_app_ug/internet_proto_ip_pipeline.rst   |    4 +-
 doc/guides/sample_app_ug/intro.rst                 |   12 +-
 doc/guides/sample_app_ug/ip_frag.rst               |    6 +-
 doc/guides/sample_app_ug/ip_reassembly.rst         |    6 +-
 doc/guides/sample_app_ug/ipv4_multicast.rst        |    6 +-
 doc/guides/sample_app_ug/kernel_nic_interface.rst  |   34 +-
 .../sample_app_ug/l2_forward_real_virtual.rst      |   12 +-
 doc/guides/sample_app_ug/l3_forward.rst            |    8 +-
 .../sample_app_ug/l3_forward_access_ctrl.rst       |    6 +-
 doc/guides/sample_app_ug/l3_forward_power_man.rst  |   16 +-
 doc/guides/sample_app_ug/l3_forward_virtual.rst    |    8 +-
 doc/guides/sample_app_ug/link_status_intr.rst      |   10 +-
 doc/guides/sample_app_ug/load_balancer.rst         |   12 +-
 doc/guides/sample_app_ug/multi_process.rst         |   34 +-
 doc/guides/sample_app_ug/netmap_compatibility.rst  |   30 +-
 doc/guides/sample_app_ug/qos_metering.rst          |    4 +-
 doc/guides/sample_app_ug/qos_scheduler.rst         |    6 +-
 doc/guides/sample_app_ug/quota_watermark.rst       |   12 +-
 doc/guides/sample_app_ug/test_pipeline.rst         |   10 +-
 doc/guides/sample_app_ug/timer.rst                 |    6 +-
 doc/guides/sample_app_ug/vhost.rst                 |   56 ++--
 doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst   |   10 +-
 doc/guides/testpmd_app_ug/build_app.rst            |    4 +-
 doc/guides/testpmd_app_ug/index.rst                |   46 ---
 doc/guides/testpmd_app_ug/intro.rst                |   18 +-
 doc/guides/testpmd_app_ug/run_app.rst              |    4 +-
 95 files changed, 1294 insertions(+), 1725 deletions(-)
 mode change 100644 => 100755 doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst
 mode change 100644 => 100755 doc/guides/prog_guide/poll_mode_drv.rst
 delete mode 100644 doc/guides/rel_notes/appendices.rst

Comments

Thomas Monjalon Dec. 19, 2014, 10:47 p.m. UTC | #1
> These changes are DPDK 1.8 modifications and some corrections to the
> Linux Getting Started Guide, FreeBSD Getting Started Guide,
> Programmers Guide, the Sample Application User Guide, the Release Notes
> the TestPMD Guide.
> 
> Bernard Iremonger (1):
>       doc: fix typos in prog_guide
> 
> Chao Zhu (1):
>       doc: add IBM Power description to linux guides
> 
> De Lara Guarch, Pablo (1):
>       doc: removed intel legal info from linux_gsg
> 
> Reshma Pattan (1):
>       doc: fix setup menu options in linux gsg
> 
> Richardson, Bruce (2):
>       doc: update mbuf section of prog_guide
>       doc: updated svg files for rte_mbuf changes
> 
> Sergio Gonzalez Monroy (1):
>       doc: add known issue for iommu and igb_uio
> 
> Siobhan Butler (22):
>       doc: remove intel references from freebsd gsg
>       doc: remove intel legal info from freebsd gsg
>       doc: removed intel references from testpmd_ug
>       doc: removed intel legal info from testpmd_ug
>       doc: moved 1.7 new features to supported features for 1.8 in rel_notes
>       doc: added new features to rel_notes
>       doc: added to known issue 6.10 and removed fixed issue 6.29 from rel_notes
>       doc: moved known issue 6.29 to resolved issues in rel_notes
>       doc: remove appendix A from rel_notes
>       doc: removed reference to Intel DPDK in rel_notes
>       doc: updated resolved issues with old known issues
>       doc: updating the list of sample apps in rel_notes
>       doc: add udp info to prog_guide for vxlan
>       doc: remove intel dpdk in sample app ug
>       doc: remove intel legal info from sample app ug
>       doc: add vxlan support to rel_notes
>       doc: updating from 1.7 to 1.8 release note
>       doc: add BSD License to dist sample app svg files
>       doc: remove intel dpdk from prog_guide
>       doc: removed intel legal info from prog_guide
>       doc: updated i40e in linux_gsg
>       doc: removed references to intel dpdk in linux_gsg

Pulled to complete the release 1.8.0.
I made few changes to ordering, titles and other details.

Thanks a lot