DPDK patches and discussions
 help / color / mirror / Atom feed
From: Cian Ferriter <cian.ferriter@intel.com>
To: Reshma Pattan <reshma.pattan@intel.com>,
	Stephen Hemminger <stephen@networkplumber.org>
Cc: dev@dpdk.org, Cian Ferriter <cian.ferriter@intel.com>
Subject: [PATCH] doc: remove reference to pcapng init function
Date: Fri, 27 May 2022 13:21:42 +0000	[thread overview]
Message-ID: <20220527132142.1336180-1-cian.ferriter@intel.com> (raw)

The rte_pcapng_init function doesn't exist, so remove it from the docs.

Also fix minor mistakes in the file.

Signed-off-by: Cian Ferriter <cian.ferriter@intel.com>

---

The rte_pcapng_init function existed in earlier versions of patches for
this file on the mailing list, but was dropped in favour of
RTE_INIT(pcapng_init) which doesn't need to be called explicitly by the
programmer, if I understand the RTE_INIT macro correctly.
---
 doc/guides/prog_guide/pcapng_lib.rst | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/doc/guides/prog_guide/pcapng_lib.rst b/doc/guides/prog_guide/pcapng_lib.rst
index cc3eccc757..d18ebdbd1f 100644
--- a/doc/guides/prog_guide/pcapng_lib.rst
+++ b/doc/guides/prog_guide/pcapng_lib.rst
@@ -5,14 +5,14 @@ Packet Capture Next Generation Library
 ======================================
 
 Exchanging packet traces becomes more and more critical every day.
-The de facto standard for this is the format define by libpcap;
+The de facto standard for this is the format defined by libpcap;
 but that format is rather old and is lacking in functionality
 for more modern applications.
 The `Pcapng file format`_ is the default capture file format
 for modern network capture processing tools
 such as `wireshark`_ (can also be read by `tcpdump`_).
 
-The Pcapng library is a an API for formatting packet data
+The Pcapng library is an API for formatting packet data
 into a Pcapng file.
 The format conforms to the current `Pcapng RFC`_ standard.
 It is designed to be integrated with the packet capture library.
@@ -20,9 +20,6 @@ It is designed to be integrated with the packet capture library.
 Usage
 -----
 
-Before the library can be used, the function ``rte_pcapng_init``
-should be called once to initialize timestamp computation.
-
 The output stream is created with ``rte_pcapng_fdopen``,
 and should be closed with ``rte_pcapng_close``.
 
-- 
2.25.1


             reply	other threads:[~2022-05-27 13:21 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-27 13:21 Cian Ferriter [this message]
2022-05-27 15:38 ` Stephen Hemminger
2022-06-01 14:41   ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220527132142.1336180-1-cian.ferriter@intel.com \
    --to=cian.ferriter@intel.com \
    --cc=dev@dpdk.org \
    --cc=reshma.pattan@intel.com \
    --cc=stephen@networkplumber.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).