Cover Detail
Show a cover letter.
GET /api/covers/568/?format=api
{ "id": 568, "url": "http://patches.dpdk.org/api/covers/568/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/cover/20240119174346.108905-1-bruce.richardson@intel.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20240119174346.108905-1-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240119174346.108905-1-bruce.richardson@intel.com", "date": "2024-01-19T17:43:35", "name": "[v2,00/11] improve eventdev API specification/documentation", "submitter": { "id": 20, "url": "http://patches.dpdk.org/api/people/20/?format=api", "name": "Bruce Richardson", "email": "bruce.richardson@intel.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/cover/20240119174346.108905-1-bruce.richardson@intel.com/mbox/", "series": [ { "id": 30860, "url": "http://patches.dpdk.org/api/series/30860/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30860", "date": "2024-01-19T17:43:35", "name": "improve eventdev API specification/documentation", "version": 2, "mbox": "http://patches.dpdk.org/series/30860/mbox/" } ], "comments": "http://patches.dpdk.org/api/covers/568/comments/", "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "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])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 6C96143901;\n\tFri, 19 Jan 2024 18:44:07 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 2F92C42B71;\n\tFri, 19 Jan 2024 18:44:07 +0100 (CET)", "from mgamail.intel.com (mgamail.intel.com [192.198.163.12])\n by mails.dpdk.org (Postfix) with ESMTP id B1F884027A\n for <dev@dpdk.org>; Fri, 19 Jan 2024 18:44:05 +0100 (CET)", "from orsmga006.jf.intel.com ([10.7.209.51])\n by fmvoesa106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 19 Jan 2024 09:43:56 -0800", "from silpixa00400957.ir.intel.com (HELO\n silpixa00401385.ir.intel.com) ([10.237.214.26])\n by orsmga006.jf.intel.com with ESMTP; 19 Jan 2024 09:43:53 -0800" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n d=intel.com; i=@intel.com; q=dns/txt; s=Intel;\n t=1705686246; x=1737222246;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=3VzQ5TuDxo0zMo10I8E//vv7vzQFWqJT08SK9l5ExSc=;\n b=DvI+KnS2ntMYY9fElU35i0C7vCYU5IqTzHWI1K0BaviYWQ8dXhF8suDP\n b88VYDJS1z6JLVHW6baDbspZjnm7xID6NEEvY83trlzx6TpK4mL98DVYl\n WpTGJFKCBe3GH5GGQQKY9mqcn7e5DQVPsVTbRTyrILzUHh59zhx0mxlsz\n STtFwV1YBm3h4P17vbFF0Mg4YpARAoPWF+NY9jMAt+KRcat1/IAuoJUGi\n KPij7jS9ehTeGnMvHtyELqYWbnJva+SHhv5pEqJ5G5T8dURWgIurAuTjZ\n GhmezNu5B0OS95NW/on8uGEvbTIhZrDirJhXfpOg/A4iySGMrqF6gaenx g==;", "X-IronPort-AV": [ "E=McAfee;i=\"6600,9927,10957\"; a=\"683598\"", "E=Sophos;i=\"6.05,204,1701158400\";\n d=\"scan'208\";a=\"683598\"", "E=McAfee;i=\"6600,9927,10957\"; a=\"761177756\"", "E=Sophos;i=\"6.05,204,1701158400\"; d=\"scan'208\";a=\"761177756\"" ], "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org", "Cc": "jerinj@marvell.com, mattias.ronnblom@ericsson.com,\n abdullah.sevincer@intel.com, sachin.saxena@oss.nxp.com,\n hemant.agrawal@nxp.com, pbhagavatula@marvell.com, pravin.pathak@intel.com,\n Bruce Richardson <bruce.richardson@intel.com>", "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", "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>,\n <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>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "This patchset makes rewording improvements to the eventdev doxygen\ndocumentation to try and ensure that it is as clear as possible,\ndescribes the implementation as accurately as possible, and is\nconsistent within itself.\n\nMost changes are just minor rewordings, along with plenty of changes to\nchange references into doxygen links/cross-references.\n\nHowever, the final two patches are attempting to clarify what, to me\nanyway, is unclear wording in some key definitions. As such, it probably\nrequires careful review by eventdev PMD maintainers, as different\nimplementaters may have different understandings of what the text meant,\nand in some cases in \"clarifying\" I may have changed the meaning in a\nway that breaks things.\n\nV2:\n* additional cleanup and changes\n* remove \"escaped\" accidental change to .c file\n\nBruce Richardson (11):\n eventdev: improve doxygen introduction text\n eventdev: move text on driver internals to proper section\n eventdev: update documentation on device capability flags\n eventdev: cleanup doxygen comments on info structure\n eventdev: improve function documentation for query fns\n eventdev: improve doxygen comments on configure struct\n eventdev: fix documentation for counting single-link ports\n eventdev: improve doxygen comments on config fns\n eventdev: improve doxygen comments for control APIs\n eventdev: RFC clarify comments on scheduling types\n eventdev: RFC, clarify docs on event object fields\n\n lib/eventdev/rte_eventdev.h | 773 +++++++++++++++++++++++-------------\n 1 file changed, 501 insertions(+), 272 deletions(-)\n\n--\n2.40.1" }