Cover Detail
Show a cover letter.
GET /api/covers/670/?format=api
{ "id": 670, "url": "http://patches.dpdk.org/api/covers/670/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/cover/20240221103221.933238-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": "<20240221103221.933238-1-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240221103221.933238-1-bruce.richardson@intel.com", "date": "2024-02-21T10:32:09", "name": "[v4,00/12] 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/20240221103221.933238-1-bruce.richardson@intel.com/mbox/", "series": [ { "id": 31169, "url": "http://patches.dpdk.org/api/series/31169/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=31169", "date": "2024-02-21T10:32:09", "name": "improve eventdev API specification/documentation", "version": 4, "mbox": "http://patches.dpdk.org/series/31169/mbox/" } ], "comments": "http://patches.dpdk.org/api/covers/670/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 5C62143B61;\n\tWed, 21 Feb 2024 11:32:31 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 4AD3D4064C;\n\tWed, 21 Feb 2024 11:32:31 +0100 (CET)", "from mgamail.intel.com (mgamail.intel.com [192.198.163.15])\n by mails.dpdk.org (Postfix) with ESMTP id 00C78402D1\n for <dev@dpdk.org>; Wed, 21 Feb 2024 11:32:28 +0100 (CET)", "from orviesa007.jf.intel.com ([10.64.159.147])\n by fmvoesa109.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 21 Feb 2024 02:32:28 -0800", "from silpixa00401385.ir.intel.com ([10.237.214.38])\n by orviesa007.jf.intel.com with ESMTP; 21 Feb 2024 02:32:27 -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=1708511549; x=1740047549;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=cc29mHOXJ6apKJJ0GX98PYspVZ4lpXzYMDCzB1z8CkQ=;\n b=Jj3m1SdZBbmwux+Q/Cg4GdZ5A+cTIeYXn3t92YmpFseLjZHP8Dm6fuWL\n ASI/e9jxZ7AUB9XlE7tLXxM5F757w0HDk/yPrdwNMpzHDCNdTl6btLwaU\n LPHelGm3WdGPh5SDtF2pwv0G51E+n5L8+ijOFJGr/YTCcUciIoPK98Sn2\n LjWde/dBj0oGMwCAj24KgE/fpxalTAhUkJdCBWOMpIQ9vHgLGpv1lD96b\n pfW2E2YiFp7+QFnMNXt/PdA4Unc98iBJvLgsC8EHqKxAIiBWLrviLO9w2\n grI03hSfK9A63k9h06lC6QN0z6vioM55v+u6pZY1o3I7C8d/Qb/bHXan6 A==;", "X-IronPort-AV": [ "E=McAfee;i=\"6600,9927,10990\"; a=\"2800686\"", "E=Sophos;i=\"6.06,175,1705392000\";\n d=\"scan'208\";a=\"2800686\"", "E=Sophos;i=\"6.06,175,1705392000\";\n d=\"scan'208\";a=\"5392956\"" ], "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org,\n\tjerinj@marvell.com,\n\tmattias.ronnblom@ericsson.com", "Cc": "Bruce Richardson <bruce.richardson@intel.com>", "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", "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\nIn tightening up the definitions, there may be subtle changes in meaning\nwhich should be checked for carefully by reviewers. Where there was\nambiguity, the behaviour of existing code is documented so as to avoid\nbreaking existing apps.\n\nV4:\n* additional rework following comments from Jerin and on-list discussion\n* extra 12th patch to clean up some doxygen issues\n\nV3:\n* major cleanup following review by Mattias and on-list discussions\n* old patch 7 split in two and merged with other changes in the same\n area rather than being standalone.\n* new patch 11 added at end of series.\n\nV2:\n* additional cleanup and changes\n* remove \"escaped\" accidental change to .c file\n\nBruce Richardson (12):\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: improve doxygen comments on config fns\n eventdev: improve doxygen comments for control APIs\n eventdev: improve comments on scheduling types\n eventdev: clarify docs on event object fields and op types\n eventdev: drop comment for anon union from doxygen\n eventdev: fix doxygen processing of event vector struct\n\n lib/eventdev/rte_eventdev.h | 1016 +++++++++++++++++++++++------------\n 1 file changed, 663 insertions(+), 353 deletions(-)\n\n--\n2.40.1" }