From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 55D1EA0544;
	Fri, 27 May 2022 17:55:59 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 3C292410DC;
	Fri, 27 May 2022 17:55:59 +0200 (CEST)
Received: from mail-pj1-f47.google.com (mail-pj1-f47.google.com
 [209.85.216.47]) by mails.dpdk.org (Postfix) with ESMTP id B605940E78
 for <dev@dpdk.org>; Fri, 27 May 2022 17:55:57 +0200 (CEST)
Received: by mail-pj1-f47.google.com with SMTP id
 q92-20020a17090a17e500b001e0817e77f6so7446514pja.5
 for <dev@dpdk.org>; Fri, 27 May 2022 08:55:57 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=networkplumber-org.20210112.gappssmtp.com; s=20210112;
 h=date:from:to:cc:subject:message-id:in-reply-to:references
 :mime-version:content-transfer-encoding;
 bh=BRt4gbzE0pcJindZol8Jkehxe3n1H9EE14b7fK2JWnI=;
 b=hEKQgyRDx1f8hEKpVcvqpgHB3Mp6xKwVnJx00n6ttvpKJuLLXQmG/paAXUM5s5Hypd
 +WAkRQJnDpDipX5AKm1KNwv3sQi8444A0oJJ/lJGeynI4kcIFYkA+u/bhr7ZtFH3OdFA
 zaHpVhrUfhVRZvEqbfv2exly4rx9vRLHDc1545AzZa60AoDtaprSn3nN8gEq3hLHNG5P
 cJF5jhaCMWjVMml8rj73aiPJPxkRQTCKipPM2AJcaXawc8ooHForUQiiuUu5po8qYxnL
 wFhtCh/MTRETCEtK3oB7J8GTHFOmvzETj59AaIWeYZQxHmSBAFhbiLuVpzct3U0ZAYUv
 PFbg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20210112;
 h=x-gm-message-state:date:from:to:cc:subject:message-id:in-reply-to
 :references:mime-version:content-transfer-encoding;
 bh=BRt4gbzE0pcJindZol8Jkehxe3n1H9EE14b7fK2JWnI=;
 b=kuArWnTbrq/YCYhBwpquogzBnQSzx1tWF9HpCD3icSck3+/6CL/+/2CWEYpPUM5Ppq
 JQ71M2Cv1TkIqVSnpOW+hisebZvdNV14T2FxlrWe32DjJwdAIht3TK3vPQ22Y1rwSly9
 XJPzvtu199MDZALxJ6n0iAySLfAo4eKdszMUAR03QaKKcHAMqTn5R5Hf3hx5ZWbHuAI4
 zy9VZXXpQbkSXTeFLYjqFa3Iqryij98FD00SoZ4FRUaGa7IIQ+yQCPeiTU5Fp1meZzgG
 QBR2UZPK2HSpT8x9i3/+cDVHDptbUwVuK/BPflASrwwxwWCT801IbLErcjk5/ShDD0V1
 T98g==
X-Gm-Message-State: AOAM530Dw4Ig3KfekFr41eYHsN9KlLPs/dyZQLh5r9SnN6k5hKg/iUBw
 tpOhooGclqCrYDsfyrYeuAXjxg==
X-Google-Smtp-Source: ABdhPJx9Etqtbb9Gc8nIwhO1OMcmKs34mglbXdJkNFsXrJWIcvRTbg4Kk5ue0HgydmknehkaxXloxg==
X-Received: by 2002:a17:902:d64d:b0:162:3595:220c with SMTP id
 y13-20020a170902d64d00b001623595220cmr22390449plh.10.1653666956905; 
 Fri, 27 May 2022 08:55:56 -0700 (PDT)
Received: from hermes.local (204-195-112-199.wavecable.com. [204.195.112.199])
 by smtp.gmail.com with ESMTPSA id
 a67-20020a624d46000000b0050dc7628168sm3735043pfb.66.2022.05.27.08.55.56
 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
 Fri, 27 May 2022 08:55:56 -0700 (PDT)
Date: Fri, 27 May 2022 08:38:07 -0700
From: Stephen Hemminger <stephen@networkplumber.org>
To: Cian Ferriter <cian.ferriter@intel.com>
Cc: Reshma Pattan <reshma.pattan@intel.com>, dev@dpdk.org
Subject: Re: [PATCH] doc: remove reference to pcapng init function
Message-ID: <20220527083801.1ac69634@hermes.local>
In-Reply-To: <20220527132142.1336180-1-cian.ferriter@intel.com>
References: <20220527132142.1336180-1-cian.ferriter@intel.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

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>