From patchwork Wed Feb 21 10:32:09 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 670 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 5C62143B61; Wed, 21 Feb 2024 11:32:31 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 4AD3D4064C; Wed, 21 Feb 2024 11:32:31 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.15]) by mails.dpdk.org (Postfix) with ESMTP id 00C78402D1 for ; Wed, 21 Feb 2024 11:32:28 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1708511549; x=1740047549; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=cc29mHOXJ6apKJJ0GX98PYspVZ4lpXzYMDCzB1z8CkQ=; b=Jj3m1SdZBbmwux+Q/Cg4GdZ5A+cTIeYXn3t92YmpFseLjZHP8Dm6fuWL ASI/e9jxZ7AUB9XlE7tLXxM5F757w0HDk/yPrdwNMpzHDCNdTl6btLwaU LPHelGm3WdGPh5SDtF2pwv0G51E+n5L8+ijOFJGr/YTCcUciIoPK98Sn2 LjWde/dBj0oGMwCAj24KgE/fpxalTAhUkJdCBWOMpIQ9vHgLGpv1lD96b pfW2E2YiFp7+QFnMNXt/PdA4Unc98iBJvLgsC8EHqKxAIiBWLrviLO9w2 grI03hSfK9A63k9h06lC6QN0z6vioM55v+u6pZY1o3I7C8d/Qb/bHXan6 A==; X-IronPort-AV: E=McAfee;i="6600,9927,10990"; a="2800686" X-IronPort-AV: E=Sophos;i="6.06,175,1705392000"; d="scan'208";a="2800686" Received: from orviesa007.jf.intel.com ([10.64.159.147]) by fmvoesa109.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Feb 2024 02:32:28 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.06,175,1705392000"; d="scan'208";a="5392956" Received: from silpixa00401385.ir.intel.com ([10.237.214.38]) by orviesa007.jf.intel.com with ESMTP; 21 Feb 2024 02:32:27 -0800 From: Bruce Richardson To: dev@dpdk.org, jerinj@marvell.com, mattias.ronnblom@ericsson.com Cc: Bruce Richardson Subject: [PATCH v4 00/12] improve eventdev API specification/documentation Date: Wed, 21 Feb 2024 10:32:09 +0000 Message-Id: <20240221103221.933238-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. V4: * additional rework following comments from Jerin and on-list discussion * extra 12th patch to clean up some doxygen issues 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 (12): 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 eventdev: fix doxygen processing of event vector struct lib/eventdev/rte_eventdev.h | 1016 +++++++++++++++++++++++------------ 1 file changed, 663 insertions(+), 353 deletions(-) --- 2.40.1