691 Commits

Author SHA1 Message Date
Thomas Monjalon
60011cb25a doc: rename ABI chapter to deprecation
This chapter is for ABI and API. That's why a renaming is required.

Remove also the examples which are now in the referenced guidelines.

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-07-18 22:04:30 +02:00
Maryam Tahhan
49f386542a ethdev: remove driver specific stats
Remove non generic stats in rte_stats_strings and mark the relevant
fields in struct rte_eth_stats as deprecated.

Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
2015-07-17 02:26:32 +02:00
Sergio Gonzalez Monroy
53dbab96d5 doc: announce deprecation of librte_malloc
Announce the creation of dummy malloc library for 2.1 and removal of
such library, now integrated in librte_eal, for 2.2 release.

Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
2015-07-16 14:04:12 +02:00
Helin Zhang
58d3da9edd doc: announce ABI changes for unified packet type
Signed-off-by: Helin Zhang <helin.zhang@intel.com>
Acked-by: Jingjing Wu <jingjing.wu@intel.com>
[Thomas: reword with NEXT_ABI option]
Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-07-16 01:45:52 +02:00
Pablo de Lara
520e197b3f doc: announce deprecation of macros in hash API
Two of the macros in rte_hash.h are now deprecated, so this patch
adds notice that they will be removed in 2.2.

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2015-07-13 00:41:42 +02:00
Jijiang Liu
27bb9216bb doc: announce ABI change to support 1024 queues per port
The significant ABI change is planned for struct rte_eth_dev to support
up to 1024 queues per port which will be taken effect from release 2.2.

Signed-off-by: Jijiang Liu <jijiang.liu@intel.com>
Acked-by: Neil Horman <nhorman@tuxdriver.com>
2015-07-11 00:24:21 +02:00
Thomas Monjalon
7cc2bdedd3 doc: link ABI policy to release notes
When moving ABI policy to guidelines, the new doc was referred
without using sphinx link.

Fixes: f1ef9794f9bd ("doc: add ABI guidelines")

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-06-29 16:58:09 +02:00
Neil Horman
f1ef9794f9 doc: add ABI guidelines
People have been asking for ways to use the ABI macros, heres some docs to
clarify their use.  Included is:

* An overview of what ABI is
* Details of the ABI deprecation process
* Details of the versioning macros
* Examples of their use
* Details of how to use the ABI validator

Thanks to John Mcnamara, who duplicated much of this effort at Intel while I was
working on it.  Much of the introductory material was gathered and cleaned up by
him.

Signed-off-by: Neil Horman <nhorman@tuxdriver.com>
CC: John McNamara <john.mcnamara@intel.com>
Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-06-29 16:45:01 +02:00
Pablo de Lara
f1237c33d4 hash: update jhash function with the latest available
Jenkins hash function was developed originally in 1996,
and was integrated in first versions of DPDK.
The function has been improved in 2006,
achieving up to 35% better performance, compared to the original one.

This patch integrates that code into the rte_jhash library.
It also updates the precalculated hash values in the unit test,
as the code now returns different values (expected).

A final note has been added in release notes for stating
the changes made.

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2015-06-16 12:18:55 +02:00
John McNamara
fea1d908d3 doc: fix spellings and typos
Fixed several typos and spelling errors in guide docs.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-04-29 18:34:58 +02:00
Olivier Matz
bbd7782489 mbuf: introduce a new helper to create a pool
Add a new wrapper to rte_mempool_create() to simplify the creation
of a packet mbuf pool.

This wrapper can be used if there is no specific mempool flags, and
no specific mbuf or pool constructor function, which is most of the
use cases.

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Neil Horman <nhorman@tuxdriver.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2015-04-28 11:34:04 +02:00
Olivier Matz
1d493a4949 mbuf: fix data room size calculation in pool init
Deduct the mbuf data room size from mempool->elt_size and priv_size,
instead of using an hardcoded value that is not related to the real
buffer size.

To use rte_pktmbuf_pool_init(), the user can either:
- give a NULL parameter to rte_pktmbuf_pool_init(): in this case, the
  private size is assumed to be 0, and the room size is
  mp->elt_size - sizeof(struct rte_mbuf).
- give the rte_pktmbuf_pool_private filled with appropriate
  data_room_size and priv_size values.

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Neil Horman <nhorman@tuxdriver.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2015-04-27 22:39:20 +02:00
Thomas Monjalon
493db80afd version: 2.0.0
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-04-03 16:13:45 +02:00
Siobhan Butler
97d60e1933 doc: update new features
- Remove duplicate entry
- Added remaining features to list of new features

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-04-03 16:12:13 +02:00
Siobhan Butler
0568c997c1 doc: add known issue with bonding test
Added issue with failing unit test for link bonding to known issues.

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-04-03 16:12:13 +02:00
Siobhan Butler
a925fdc89e doc: remove release version from known issues
Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-04-03 16:12:13 +02:00
Siobhan Butler
c5331c7a1d doc: update tested OS list in release notes
Updated Operating Systems tested during 2.0 in release notes

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-03-31 03:28:34 +02:00
Siobhan Butler
2a96aca9ec doc: update release notes for new sample apps
Updated release notes release description notes:
 - added new sample applications to list: Link Bonding,Skeleton, Callbacks, Jobstats
 - updated copyright date to 2015

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-03-31 03:27:27 +02:00
Siobhan Butler
a73a9510eb doc: update faq
Added some of the questions posted to the mailing list to the FAQ section of release notes.

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-03-31 03:21:41 +02:00
Siobhan Butler
92893bbd40 doc: add warning for fm10k early driver
This patch adds a note to the release notes new features,
as a warning regarding the early status of the FM10K driver for pre-release access

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-03-31 02:55:07 +02:00
Pawel Wodkowski
24b7590ae4 doc: add jobstats library and sample release notes
Signed-off-by: Pawel Wodkowski <pawelx.wodkowski@intel.com>
2015-03-31 02:54:28 +02:00
Pawel Wodkowski
5bf6dc2a63 doc: update bonding mode 6 release notes
Signed-off-by: Pawel Wodkowski <pawelx.wodkowski@intel.com>
2015-03-31 02:10:41 +02:00
John McNamara
fdaeae9937 doc: fix encoding of (r) character
Change encoding of (r) from Latin-1 to UTF8 to match the other
symbols in the doc and to allow it to convert cleanly to PDF.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2015-03-19 11:43:21 +01:00
Chen Jing D(Mark)
b7417fa11c doc: update release notes for fm10k
Add feature list for fm10k driver.

Signed-off-by: Chen Jing D(Mark) <jing.d.chen@intel.com>
Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-03-17 22:16:46 +01:00
Neil Horman
8bfc4e3c4c doc: add ABI documentation
Adding a document describing rudimentary ABI policy and adding notice space for
any deprecation announcements

Signed-off-by: Neil Horman <nhorman@tuxdriver.com>
Acked-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-02-03 16:56:59 +01:00
Thomas Monjalon
6fb3161060 version: 1.8.0
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-12-20 00:38:39 +01:00
Siobhan Butler
5ef25d82fd doc: updating to 1.8 release note
Added instructions for updating from DPDK 1.7.0 to 1.8.0

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20 00:38:39 +01:00
Sergio Gonzalez Monroy
7547be1efc doc: add known issue for iommu and igb_uio
Known issue regarding iommu/VT-d and igb_uio in Linux kernel version 3.15
to 3.17 where unbinding the device from the driver removes the 1:1 mapping
in the iommu resulting in IOMMU/DMAR errors when the device tries to
access memory.

Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20 00:38:39 +01:00
Siobhan Butler
048f830326 doc: move resolved issues
Removed resolved issues from known issues section.
Added new resolved issues to resolved issues section.

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20 00:38:39 +01:00
Siobhan Butler
5b81c76005 doc: add i40e vxlan support to release notes
Added to New and Supported features for VXLAN feature.

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20 00:38:39 +01:00
Siobhan Butler
701e27cf7a doc: add new features to release notes
Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20 00:38:39 +01:00
Siobhan Butler
01aaa0e496 doc: move new features to supported features for 1.8 release
Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20 00:38:39 +01:00
Siobhan Butler
387a6b7c4f doc: update list of sample apps in release notes
Added new and existing names of sample apps to list of
sample apps in release notes.

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20 00:38:39 +01:00
Siobhan Butler
9a0c8345d2 doc: remove licensing overview from release notes
Removing Appendix A from Release Notes as Intel Licensing information is
no longer relevant in this document.

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20 00:38:38 +01:00
Siobhan Butler
073cd6c3c7 doc: remove Intel legal info from release notes
Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20 00:38:38 +01:00
Siobhan Butler
ac8ada004c doc: remove Intel references from release notes
Removed multiple references to Intel(R) DPDK where no longer
relevant.

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-19 23:30:26 +01:00
Pablo de Lara
c75f4e6a7a doc: add vm power mgmt app
Added new section in sample app UG for
the new VM power management app.

Signed-off-by: Alan Carew <alan.carew@intel.com>
Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-17 01:04:07 +01:00
Bruce Richardson
a9bc351cd4 doc: auto-generate date in guides
The index.html file for each of the "guide" docs had a hard-coded
date value in them of June 2014. Rather than update each of these
for each revision, just use the |today| directive to insert the date
at which the document was generated.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-05 17:28:23 +01:00
Thomas Monjalon
a4675d45cc doc: fix eal paths
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-11-18 14:49:54 +01:00
Bernard Iremonger
aae5e11e84 doc: fix file attributes of guides
The file attributes of the rst files have been changed to 644

Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-13 01:36:44 +01:00
Bernard Iremonger
6e718ae062 doc: release notes 1.7
The 1.7 DPDK_Release_Notes document in MSWord has been converted to rst format for
use with Sphinx. There is an rst file for each chapter and an index.rst file
which contains the table of contents.
The top level index file has been modified to include this document.

This is the third document from a set of 6 documents

Signed-off-by:  Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-03 18:13:05 +01:00