From patchwork Fri May 27 13:21:42 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cian Ferriter X-Patchwork-Id: 111980 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 53701A055E; Fri, 27 May 2022 15:21:48 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id ED99240E78; Fri, 27 May 2022 15:21:47 +0200 (CEST) Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by mails.dpdk.org (Postfix) with ESMTP id 1E53A40E5A for ; Fri, 27 May 2022 15:21:45 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1653657706; x=1685193706; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=Tz2sCtUWulzOsuoRiusatXreDJJCbPOyszDF58piQKg=; b=dQo9dpuvvjTLxKB243CUPHknUzdDWfhoXDHFVLpKbxrrD7vS8Rd/SKE4 egYElS8vHOMQF0hnE6JQ5djZpxafEQECqF9iv4sFGEgMIGRWmz7IafCnF a4kDs6EvKnMsfpQ0frIZe28ygPsVrED5AjXs6LvjpIfPAbBfRHS5NjeEi 6pjBH6TX9pg0h9cLwr5eYgD24Wzv7D3TOmy5jR/SiYMU9sQkwtq7swKMs ZELYYtuy29r+lliZXrTojth/E5kHJ5IqnvcKcM98D2xwog/4ndpkP7hOk 8drWmkZTNEYllmvtwWhH999WJENB0u2vNk+1YZDfQPz9dChM1HwCpaRlg g==; X-IronPort-AV: E=McAfee;i="6400,9594,10359"; a="256547989" X-IronPort-AV: E=Sophos;i="5.91,255,1647327600"; d="scan'208";a="256547989" Received: from orsmga008.jf.intel.com ([10.7.209.65]) by orsmga106.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 May 2022 06:21:45 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.91,255,1647327600"; d="scan'208";a="603882557" Received: from silpixa00399779.ir.intel.com (HELO silpixa00399779.ger.corp.intel.com) ([10.237.223.111]) by orsmga008.jf.intel.com with ESMTP; 27 May 2022 06:21:44 -0700 From: Cian Ferriter To: Reshma Pattan , Stephen Hemminger Cc: dev@dpdk.org, Cian Ferriter Subject: [PATCH] doc: remove reference to pcapng init function Date: Fri, 27 May 2022 13:21:42 +0000 Message-Id: <20220527132142.1336180-1-cian.ferriter@intel.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org 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 Acked-by: Stephen Hemminger --- 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``.