From patchwork Fri Jan 19 17:43:35 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 568 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 6C96143901; Fri, 19 Jan 2024 18:44:07 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2F92C42B71; Fri, 19 Jan 2024 18:44:07 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.12]) by mails.dpdk.org (Postfix) with ESMTP id B1F884027A for ; Fri, 19 Jan 2024 18:44:05 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1705686246; x=1737222246; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=3VzQ5TuDxo0zMo10I8E//vv7vzQFWqJT08SK9l5ExSc=; b=DvI+KnS2ntMYY9fElU35i0C7vCYU5IqTzHWI1K0BaviYWQ8dXhF8suDP b88VYDJS1z6JLVHW6baDbspZjnm7xID6NEEvY83trlzx6TpK4mL98DVYl WpTGJFKCBe3GH5GGQQKY9mqcn7e5DQVPsVTbRTyrILzUHh59zhx0mxlsz STtFwV1YBm3h4P17vbFF0Mg4YpARAoPWF+NY9jMAt+KRcat1/IAuoJUGi KPij7jS9ehTeGnMvHtyELqYWbnJva+SHhv5pEqJ5G5T8dURWgIurAuTjZ GhmezNu5B0OS95NW/on8uGEvbTIhZrDirJhXfpOg/A4iySGMrqF6gaenx g==; X-IronPort-AV: E=McAfee;i="6600,9927,10957"; a="683598" X-IronPort-AV: E=Sophos;i="6.05,204,1701158400"; d="scan'208";a="683598" Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmvoesa106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Jan 2024 09:43:56 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10957"; a="761177756" X-IronPort-AV: E=Sophos;i="6.05,204,1701158400"; d="scan'208";a="761177756" Received: from silpixa00400957.ir.intel.com (HELO silpixa00401385.ir.intel.com) ([10.237.214.26]) by orsmga006.jf.intel.com with ESMTP; 19 Jan 2024 09:43:53 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: jerinj@marvell.com, mattias.ronnblom@ericsson.com, abdullah.sevincer@intel.com, sachin.saxena@oss.nxp.com, hemant.agrawal@nxp.com, pbhagavatula@marvell.com, pravin.pathak@intel.com, Bruce Richardson Subject: [PATCH v2 00/11] improve eventdev API specification/documentation Date: Fri, 19 Jan 2024 17:43:35 +0000 Message-Id: <20240119174346.108905-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20240118134557.73172-1-bruce.richardson@intel.com> References: <20240118134557.73172-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. However, the final two patches are attempting to clarify what, to me anyway, is unclear wording in some key definitions. As such, it probably requires careful review by eventdev PMD maintainers, as different implementaters may have different understandings of what the text meant, and in some cases in "clarifying" I may have changed the meaning in a way that breaks things. 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: fix documentation for counting single-link ports eventdev: improve doxygen comments on config fns eventdev: improve doxygen comments for control APIs eventdev: RFC clarify comments on scheduling types eventdev: RFC, clarify docs on event object fields lib/eventdev/rte_eventdev.h | 773 +++++++++++++++++++++++------------- 1 file changed, 501 insertions(+), 272 deletions(-) --- 2.40.1