Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/13091/?format=api
{ "id": 13091, "url": "http://patches.dpdk.org/api/patches/13091/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1464605292-4599-11-git-send-email-remy.horton@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": "<1464605292-4599-11-git-send-email-remy.horton@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1464605292-4599-11-git-send-email-remy.horton@intel.com", "date": "2016-05-30T10:48:12", "name": "[dpdk-dev,v3,10/10] doc: update xstats documentation", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "a7e5add3ff1668d98962da1d8acc7e5b8e39fa5f", "submitter": { "id": 326, "url": "http://patches.dpdk.org/api/people/326/?format=api", "name": "Remy Horton", "email": "remy.horton@intel.com" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1464605292-4599-11-git-send-email-remy.horton@intel.com/mbox/", "series": [], "comments": "http://patches.dpdk.org/api/patches/13091/comments/", "check": "pending", "checks": "http://patches.dpdk.org/api/patches/13091/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id 3CCB56C99;\n\tMon, 30 May 2016 12:48:50 +0200 (CEST)", "from mga04.intel.com (mga04.intel.com [192.55.52.120])\n\tby dpdk.org (Postfix) with ESMTP id D32D569F9\n\tfor <dev@dpdk.org>; Mon, 30 May 2016 12:48:26 +0200 (CEST)", "from orsmga003.jf.intel.com ([10.7.209.27])\n\tby fmsmga104.fm.intel.com with ESMTP; 30 May 2016 03:48:26 -0700", "from rhorton-mobl.ger.corp.intel.com (HELO VM.ir.intel.com)\n\t([163.33.228.212])\n\tby orsmga003.jf.intel.com with ESMTP; 30 May 2016 03:48:25 -0700" ], "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.26,389,1459839600\"; d=\"scan'208\";a=\"817650959\"", "From": "Remy Horton <remy.horton@intel.com>", "To": "dev@dpdk.org", "Date": "Mon, 30 May 2016 11:48:12 +0100", "Message-Id": "<1464605292-4599-11-git-send-email-remy.horton@intel.com>", "X-Mailer": "git-send-email 2.5.5", "In-Reply-To": "<1464605292-4599-1-git-send-email-remy.horton@intel.com>", "References": "<1464605292-4599-1-git-send-email-remy.horton@intel.com>", "Subject": "[dpdk-dev] [PATCH v3 10/10] doc: update xstats documentation", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "patches and discussions about DPDK <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Signed-off-by: Remy Horton <remy.horton@intel.com>\n---\n doc/guides/prog_guide/poll_mode_drv.rst | 25 +++++++++++++++++++++----\n 1 file changed, 21 insertions(+), 4 deletions(-)", "diff": "diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst\nindex 7698692..6cd86dd 100644\n--- a/doc/guides/prog_guide/poll_mode_drv.rst\n+++ b/doc/guides/prog_guide/poll_mode_drv.rst\n@@ -299,10 +299,27 @@ Extended Statistics API\n ~~~~~~~~~~~~~~~~~~~~~~~\n \n The extended statistics API allows each individual PMD to expose a unique set\n-of statistics. The client of the API provides an array of\n-``struct rte_eth_xstats`` type. Each ``struct rte_eth_xstats`` contains a\n-string and value pair. The amount of xstats exposed, and position of the\n-statistic in the array must remain constant during runtime.\n+of statistics. Accessing these from application programs is done via three\n+functions:\n+\n+* ``rte_eth_xstats_count``: Fetches the number of extended statistics.\n+* ``rte_eth_xstats_get``: Fills in an array of ``struct rte_eth_xstats``\n+ with extended statistics.\n+* ``rte_eth_xstats_names``: Fills in an array of ``struct rte_eth_name``\n+ with extended statistic name lookup information.\n+\n+Each ``struct rte_eth_xstats`` contains an identifier and value pair, and\n+each ``struct rte_eth_xstats_name`` contains an identifier and string pair.\n+Each identifier within ``struct rte_eth_xstats`` must have a corresponding\n+entry in ``struct rte_eth_xstats_name`` with a matching identifier. These\n+identifiers, as well as the number of extended statistic exposed, must\n+remain constant during runtime.\n+\n+Note that extended statistic identifiers are driver-specific, and hence\n+might not be the same for different ports. Although it is expected that\n+drivers will make the identifiers used within ``struct rte_eth_xstats`` and\n+``struct rte_eth_xstats_name`` entries match the entries' array index, this\n+property should not be relied on by applications for lookups.\n \n A naming scheme exists for the strings exposed to clients of the API. This is\n to allow scraping of the API for statistics of interest. The naming scheme uses\n", "prefixes": [ "dpdk-dev", "v3", "10/10" ] }