diff mbox series

doc: remove reference to pcapng init function

Message ID 20220527132142.1336180-1-cian.ferriter@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series doc: remove reference to pcapng init function | expand

Checks

Context Check Description
ci/iol-abi-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Cian Ferriter May 27, 2022, 1:21 p.m. UTC
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(-)

Comments

Stephen Hemminger May 27, 2022, 3:38 p.m. UTC | #1
On Fri, 27 May 2022 13:21:42 +0000
Cian Ferriter <cian.ferriter@intel.com> wrote:

> 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``.
>  

Yes, this is leftover from earlier code.

Acked-by: Stephen Hemminger <stephen@networkplumber.org>
Thomas Monjalon June 1, 2022, 2:41 p.m. UTC | #2
27/05/2022 17:38, Stephen Hemminger:
> On Fri, 27 May 2022 13:21:42 +0000
> Cian Ferriter <cian.ferriter@intel.com> wrote:
> 
> > 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>
> 
> Yes, this is leftover from earlier code.
> 
> Acked-by: Stephen Hemminger <stephen@networkplumber.org>

Applied, thanks.
diff mbox series

Patch

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``.