From patchwork Thu Jan 18 13:45:50 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 565 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 243C6438F3; Thu, 18 Jan 2024 14:46:15 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BD4D540285; Thu, 18 Jan 2024 14:46:14 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.13]) by mails.dpdk.org (Postfix) with ESMTP id F364940285 for ; Thu, 18 Jan 2024 14:46:12 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1705585573; x=1737121573; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=9WhGIWjq2HbBeEG+uvQ4P47sTWu727KkFjWeriF3GO0=; b=PsPUm8sJHBWUNYdwcpHnGXCXtyoYytFkYmCHPqdXzHGDjTW6VpD3FfgF cFGsaaSBrJtJDJfv9cvv2DKKLRkNumvr8T/fkh889XbACNvIzmKcN6mts fY3ga1meMwlRlGLMl86SDfeoVvsm8nQy3F4IA9xb8oe6ikEgmcX/5lxXa gBpbeF9wzMQE7WGHiSeL6uFyzYD5BzOjQvAYXvw7QQOqQHw6FYC5ti+47 +pDgDJ9yRdrrx329oEG/6Xg+AXE7wyulkol0KxzM8dei+BF8EHDzZfoS0 qOjawe+zKoEI0OdFEheYBRFck2EBfG4seVAnCp1YgfK+WzZF9GUksDfWz g==; X-IronPort-AV: E=McAfee;i="6600,9927,10956"; a="7542757" X-IronPort-AV: E=Sophos;i="6.05,201,1701158400"; d="scan'208";a="7542757" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orvoesa105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 18 Jan 2024 05:46:12 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10956"; a="734274119" X-IronPort-AV: E=Sophos;i="6.05,201,1701158400"; d="scan'208";a="734274119" Received: from silpixa00400957.ir.intel.com (HELO silpixa00401385.ir.intel.com) ([10.237.214.26]) by orsmga003.jf.intel.com with ESMTP; 18 Jan 2024 05:46:10 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH v1 0/7] improve eventdev API specification/documentation Date: Thu, 18 Jan 2024 13:45:50 +0000 Message-Id: <20240118134557.73172-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.40.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 This patchset makes small rewording improvements to the eventdev doxygen documentation to try and ensure that it is as clear as possible, describes the implementation as accurately as possible, and is consistent within itself. Most changes are just minor rewordings, along with plenty of changes to change references into doxygen links/cross-references. For now I am approx 1/4 way through reviewing the rte_eventdev.h file, but sending v1 now to get any reviews started. Bruce Richardson (7): eventdev: improve doxygen introduction text eventdev: move text on driver internals to proper section eventdev: update documentation on device capability flags eventdev: cleanup doxygen comments on info structure eventdev: improve function documentation for query fns eventdev: improve doxygen comments on configure struct eventdev: fix documentation for counting single-link ports lib/eventdev/rte_eventdev.c | 2 +- lib/eventdev/rte_eventdev.h | 391 +++++++++++++++++++++++------------- 2 files changed, 247 insertions(+), 146 deletions(-) --- 2.40.1