Skip to contentSkip to conversation

doc: remove reference to pcapng init function

PATCH Applied Cian Ferriter 3 participants 3 messages May 27, 2022 – Jun 1, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: remove reference to pcapng init function

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

Also fix minor mistakes in the file.

---

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(-)
doc/guides/prog_guide/pcapng_lib.rst +2 -5
index cc3eccc757..d18ebdbd1f 100644
@@ -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``.
 
Signature · 1 line
2.25.1
Acked-by on v1 1/1
#1 lore raw
Quoted 38 lines · On Fri, 27 May 2022 13:21:42 +0000 Cian Ferriter <[email protected]>…

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

Also fix minor mistakes in the file.

---

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(-)
doc/guides/prog_guide/pcapng_lib.rst +2 -2
index cc3eccc757..d18ebdbd1f 100644
@@ -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.

doc/guides/prog_guide/pcapng_lib.rst It is designed to be integrated with the packet capture library. · line 25

Quoted 9 lines
doc/guides/prog_guide/pcapng_lib.rst +0 -3
@@ -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``.
 

Yes, this is leftover from earlier code.