From 707be598efc2b2f39f49dbd9c11cae030ab5737c Mon Sep 17 00:00:00 2001 From: Baruch Siach Date: Tue, 29 Nov 2016 11:25:43 +0200 Subject: [PATCH] doc: fix mistakes in prog guide MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit - Remove wrong document description: The Programmer’s Guide intro is not the Release Notes. - Fix heading of section which only deals with Tx queues configuration. - Fix wrong verbatim text paragraphs: Reduce the indentation of these paragraphs since they are not part of the verbatim block. Signed-off-by: Baruch Siach Acked-by: John McNamara --- doc/guides/prog_guide/intro.rst | 2 +- doc/guides/prog_guide/mbuf_lib.rst | 8 ++++---- doc/guides/prog_guide/poll_mode_drv.rst | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/guides/prog_guide/intro.rst b/doc/guides/prog_guide/intro.rst index d6daab3763..9fe1f0c31f 100644 --- a/doc/guides/prog_guide/intro.rst +++ b/doc/guides/prog_guide/intro.rst @@ -44,7 +44,7 @@ Documentation Roadmap The following is a list of DPDK documents in the suggested reading order: -* **Release Notes** (this document): Provides release-specific information, including supported features, +* **Release Notes** : Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on. Also, provides the answers to frequently asked questions in FAQ format. diff --git a/doc/guides/prog_guide/mbuf_lib.rst b/doc/guides/prog_guide/mbuf_lib.rst index 8e616826c9..f0aa21a6d4 100644 --- a/doc/guides/prog_guide/mbuf_lib.rst +++ b/doc/guides/prog_guide/mbuf_lib.rst @@ -175,8 +175,8 @@ a vxlan-encapsulated tcp packet: set out_ip checksum to 0 in the packet set out_udp checksum to pseudo header using rte_ipv4_phdr_cksum() - This is supported on hardware advertising DEV_TX_OFFLOAD_IPV4_CKSUM - and DEV_TX_OFFLOAD_UDP_CKSUM. + This is supported on hardware advertising DEV_TX_OFFLOAD_IPV4_CKSUM + and DEV_TX_OFFLOAD_UDP_CKSUM. - calculate checksum of in_ip:: @@ -228,8 +228,8 @@ a vxlan-encapsulated tcp packet: set in_ip checksum to 0 in the packet set in_tcp checksum to pseudo header using rte_ipv4_phdr_cksum() - This is supported on hardware advertising DEV_TX_OFFLOAD_IPV4_CKSUM, - DEV_TX_OFFLOAD_UDP_CKSUM and DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM. + This is supported on hardware advertising DEV_TX_OFFLOAD_IPV4_CKSUM, + DEV_TX_OFFLOAD_UDP_CKSUM and DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM. The list of flags and their precise meaning is described in the mbuf API documentation (rte_mbuf.h). Also refer to the testpmd source code diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst index bf3ea9fde2..d4c92ea2cf 100644 --- a/doc/guides/prog_guide/poll_mode_drv.rst +++ b/doc/guides/prog_guide/poll_mode_drv.rst @@ -200,8 +200,8 @@ Ethernet* flow control (pause frame) can be configured on the individual port. Refer to the testpmd source code for details. Also, L4 (UDP/TCP/ SCTP) checksum offload by the NIC can be enabled for an individual packet as long as the packet mbuf is set up correctly. See `Hardware Offload`_ for details. -Configuration of Transmit and Receive Queues -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Configuration of Transmit Queues +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Each transmit queue is independently configured with the following information: -- 2.20.1