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 94830A00C4; Thu, 30 Jun 2022 18:50:39 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3554F4069D; Thu, 30 Jun 2022 18:50:39 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by mails.dpdk.org (Postfix) with ESMTP id 7D1A040694 for <dev@dpdk.org>; Thu, 30 Jun 2022 18:50:37 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1656607837; x=1688143837; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=rEyAjLjSPTSsFQQ1zFgRUc6RknBmDGl0VQVOzDss+6I=; b=O2Lb4Bh1IVZj8r6TAjLJU/3L6P21AOG7BMiexLoNXla2xD4xb9jvEFzk PtaibpojL06hl6C/b/vJgVOprB6R6AmbIOy6EnGFYJR35oUvMQn5P22QO g/7m3tqEq3BCXNQpdpMgx9gFJr1RAn5IEl1OKeBSpkQnb42BjHybcm2kS wiqcH7kM7yhYfObfr+4nVW8Gg+hExHlWPJWGlD/rG4SBbz743Hf+LaOl0 2itctDcHpaEC33g6hFlF3dNAN1oiseWDjwRCM5OE324m9znfbJ3ibBAa2 KFprQAzI4MwtBip3mO/ljTYkUYzAxD8Ev6yMqR8JJBLXPbFmvYURwPeEY g==; X-IronPort-AV: E=McAfee;i="6400,9594,10394"; a="271173510" X-IronPort-AV: E=Sophos;i="5.92,234,1650956400"; d="scan'208";a="271173510" Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 30 Jun 2022 09:50:36 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,234,1650956400"; d="scan'208";a="595877588" Received: from silpixa00401385.ir.intel.com (HELO silpixa00401385.ger.corp.intel.com.) ([10.237.222.133]) by fmsmga007.fm.intel.com with ESMTP; 30 Jun 2022 09:50:35 -0700 From: Bruce Richardson <bruce.richardson@intel.com> To: dev@dpdk.org Cc: Bruce Richardson <bruce.richardson@intel.com> Subject: [PATCH] doc: add deprecation notice for kni example Date: Thu, 30 Jun 2022 17:50:31 +0100 Message-Id: <20220630165031.79183-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 As agreed by DPDK Technical Board, the KNI example app is due to be removed from the repository to discourage use in future projects, given that better alternatives exist. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> --- doc/guides/rel_notes/deprecation.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 4e5b23c53d..ee36fc684d 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -125,3 +125,7 @@ Deprecation Notices applications should be updated to use the ``dmadev`` library instead, with the underlying HW-functionality being provided by the ``ioat`` or ``idxd`` dma drivers + +* examples/kni: The ``kni`` kernel module and library are not recommended for use by new applications - + other technologies such as virtio-user are recommended instead. + Because of this, the example application for kni is deprecated and will be removed in a future release. -- 2.34.1