From patchwork Fri Feb 2 12:39:42 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 608 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 7C7B543A4F; Fri, 2 Feb 2024 13:40:23 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 50CC6402E8; Fri, 2 Feb 2024 13:40:23 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.18]) by mails.dpdk.org (Postfix) with ESMTP id 04F7D402BF for ; Fri, 2 Feb 2024 13:40:21 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1706877622; x=1738413622; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=FW5ufzVBiQRE5esItkqhv5CS+zmJYpHcoYfsJlDNjus=; b=g/gc+rLsilSw+dJGaPz0j9Bvrq2qdVlQTllUEl3R7HtLDxyva7XU3pm7 qP1HROcO/1Ya/3B7Ftc6mDYZxuIfEiotf0xnUt1UKAxP4XWDp59N171vX O2WAubdAcjpFEgCCkNyFHFmtl5DVUsB0GqZmCrQIoeiAO98wao0saOFUd TdyJkr4CRDywVidpV58bZoohR7fi3kRNuzx7Twsk7Db4xLtJQbNLEgWQL dqgER+nQ1OYTW3famCXki1JJxNDxsPMkaThJeB6MvG4NrPyCj9f4Hxhxc JMjPk7WC4xV/uxHLo6f0LFAwa6Ou4uNP9mb8MtQtlNDOgYlZXAirRce5B w==; X-IronPort-AV: E=McAfee;i="6600,9927,10971"; a="54264" X-IronPort-AV: E=Sophos;i="6.05,238,1701158400"; d="scan'208";a="54264" Received: from fmviesa006.fm.intel.com ([10.60.135.146]) by fmvoesa112.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Feb 2024 04:40:21 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.05,238,1701158400"; d="scan'208";a="347529" Received: from silpixa00401385.ir.intel.com ([10.237.214.38]) by fmviesa006.fm.intel.com with ESMTP; 02 Feb 2024 04:40:19 -0800 From: Bruce Richardson To: dev@dpdk.org, jerinj@marvell.com, mattias.ronnblom@ericsson.com Cc: abdullah.sevincer@intel.com, sachin.saxena@oss.nxp.com, hemant.agrawal@nxp.com, pbhagavatula@marvell.com, pravin.pathak@intel.com, Bruce Richardson Subject: [PATCH v3 00/11] improve eventdev API specification/documentation Date: Fri, 2 Feb 2024 12:39:42 +0000 Message-Id: <20240202123953.77166-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20240119174346.108905-1-bruce.richardson@intel.com> References: <20240119174346.108905-1-bruce.richardson@intel.com> 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 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. In tightening up the definitions, there may be subtle changes in meaning which should be checked for carefully by reviewers. Where there was ambiguity, the behaviour of existing code is documented so as to avoid breaking existing apps. V3: * major cleanup following review by Mattias and on-list discussions * old patch 7 split in two and merged with other changes in the same area rather than being standalone. * new patch 11 added at end of series. V2: * additional cleanup and changes * remove "escaped" accidental change to .c file Bruce Richardson (11): 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: improve doxygen comments on config fns eventdev: improve doxygen comments for control APIs eventdev: improve comments on scheduling types eventdev: clarify docs on event object fields and op types eventdev: drop comment for anon union from doxygen lib/eventdev/rte_eventdev.h | 952 +++++++++++++++++++++++------------- 1 file changed, 620 insertions(+), 332 deletions(-) --- 2.40.1