Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/76813/?format=api
{ "id": 76813, "url": "http://patches.dpdk.org/api/patches/76813/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20200907220711.437405-32-thomas@monjalon.net/", "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": "<20200907220711.437405-32-thomas@monjalon.net>", "list_archive_url": "https://inbox.dpdk.org/dev/20200907220711.437405-32-thomas@monjalon.net", "date": "2020-09-07T22:07:11", "name": "[v4,31/31] doc: remove references to make from contributing guide", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "a6ffa999ad4762151231b425dd5f53c0650c77f4", "submitter": { "id": 685, "url": "http://patches.dpdk.org/api/people/685/?format=api", "name": "Thomas Monjalon", "email": "thomas@monjalon.net" }, "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/20200907220711.437405-32-thomas@monjalon.net/mbox/", "series": [ { "id": 12000, "url": "http://patches.dpdk.org/api/series/12000/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=12000", "date": "2020-09-07T22:06:40", "name": "remove make support in DPDK", "version": 4, "mbox": "http://patches.dpdk.org/series/12000/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/76813/comments/", "check": "warning", "checks": "http://patches.dpdk.org/api/patches/76813/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from dpdk.org (dpdk.org [92.243.14.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id CD69DA04AA;\n\tTue, 8 Sep 2020 00:12:49 +0200 (CEST)", "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id A559F1D169;\n\tTue, 8 Sep 2020 00:08:10 +0200 (CEST)", "from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com\n [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id E12081C2B7\n for <dev@dpdk.org>; Tue, 8 Sep 2020 00:08:04 +0200 (CEST)", "from compute7.internal (compute7.nyi.internal [10.202.2.47])\n by mailout.nyi.internal (Postfix) with ESMTP id 93C2C5C00DA;\n Mon, 7 Sep 2020 18:08:04 -0400 (EDT)", "from mailfrontend1 ([10.202.2.162])\n by compute7.internal (MEProxy); Mon, 07 Sep 2020 18:08:04 -0400", "from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184])\n by mail.messagingengine.com (Postfix) with ESMTPA id B06D3328005E;\n Mon, 7 Sep 2020 18:08:03 -0400 (EDT)" ], "DKIM-Signature": [ "v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h=\n from:to:cc:subject:date:message-id:in-reply-to:references\n :mime-version:content-transfer-encoding; s=fm2; bh=3Ojjo6T8qmaLR\n vYmkL2Rvi9HLsdiRHJonV8KLUDf45o=; b=v+F+b0SyQtEREfEaItF8Fo49HXXb7\n RaH8gYqLSaed3KPXOWvA3r+UvVT1jbei4GYUYQQJXHsvB1Qi7ybT5zcIpkJZtZQa\n Hk/3jvrYATOK03cSY+wOXPva1/lcZqfj1idv65boWb3dcI7p0vYVDnbuaGS9U9jg\n sH1E6r/1ex3X1LfUSR1F6hPUxMXRBbUkzLiYhDDG4bgZ5E5P9jfydfAGR09lU2iJ\n ROOD+8No3LuYva9A1R96RTsRu2lM2I1APa+h1HFOEWavBA/YR408FVaHkUvYVrNp\n +pcbQz/BBz677CqKsEy5RHy26U9hW0gQZJCGBA5P6bMUmDCOuW5BX3fSQ==", "v=1; a=rsa-sha256; c=relaxed/relaxed; d=\n messagingengine.com; h=cc:content-transfer-encoding:date:from\n :in-reply-to:message-id:mime-version:references:subject:to\n :x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=\n fm3; bh=3Ojjo6T8qmaLRvYmkL2Rvi9HLsdiRHJonV8KLUDf45o=; b=aGbY6RyG\n ukf4ITvhmtOKOAUuXGbX93Is5xQc1XHOxGom20uqa9zNp35L1CmaMq0ANQK0P1dK\n nOwALAN1Nt3E+SUKhHWo9S+rDInM4nhOibhukEbUr3hkdi3r0joOfIMm0MFqkmgx\n l4ZLpcwpbIAt//5WpKzD1Y/A03yj2HfhP3JrJ02exA4/ZpONfHn1a9q7VQu9zuzN\n S+M9nb/GUfk8M86/LH8qMAuRCp45BrkSzZpNBP/sSpW7LXCFtZvP52Xo/GohW79O\n FW8YkrUxHXM42p2YRmy5WFafGP9jTsq4ZwtQgs+8Ctd2I2ZHZHG1L+xEjthHnWik\n BUKM5yHsjOJMnw==" ], "X-ME-Sender": "<xms:RK9WX-m49WMs6Gqp_tzc3CxAC2ZcgGPKEK9tOaNu4ReWB920P_t1mQ>\n <xme:RK9WX10tgyBalwlXb1qjP8xvpvk6WW5PReyaZuGAfnaKshLZ0dgvpSELDA0jLnMcU\n RX_veRhgno_vEk7xw>", "X-ME-Proxy-Cause": "\n gggruggvucftvghtrhhoucdtuddrgeduiedrudehuddgtdefucetufdoteggodetrfdotf\n fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen\n uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne\n cujfgurhephffvufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpefvhhhomhgr\n shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg\n ftrfgrthhtvghrnhepvdehgfeivdejgedtveehfefhteelfefgieevgfffveefjeegtdfg\n uedthedtgeevnecukfhppeejjedrudefgedrvddtfedrudekgeenucevlhhushhtvghruf\n hiiigvpedufeenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgr\n lhhonhdrnhgvth", "X-ME-Proxy": "<xmx:RK9WX8o2uCGrdCWpMiKrOYApaNBfbpI5qtiy2tOTGn0_VZI461pHYg>\n <xmx:RK9WXyk8xM8akhOVONlgx-lN8g8UXXJSZFS9Q45hgr2Wa2e9IYMfdQ>\n <xmx:RK9WX803qgQNduvuX11-Tn8Qi9bOwBLuNMBdBWolb3aN1AmOxSTy9g>\n <xmx:RK9WX6CRBXOZBUSk-dXViJNVqmbiICBo7xzFffxlzPZ2jFLyIM0lFQ>", "From": "Thomas Monjalon <thomas@monjalon.net>", "To": "dev@dpdk.org", "Cc": "david.marchand@redhat.com, bruce.richardson@intel.com,\n ciara.power@intel.com, Louise Kilheeney <louise.kilheeney@intel.com>", "Date": "Tue, 8 Sep 2020 00:07:11 +0200", "Message-Id": "<20200907220711.437405-32-thomas@monjalon.net>", "X-Mailer": "git-send-email 2.28.0", "In-Reply-To": "<20200907220711.437405-1-thomas@monjalon.net>", "References": "<20200903152717.42095-1-ciara.power@intel.com>\n <20200907220711.437405-1-thomas@monjalon.net>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[dpdk-dev] [PATCH v4 31/31] doc: remove references to make from\n\tcontributing guide", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "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", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "From: Ciara Power <ciara.power@intel.com>\n\nMake is no longer supported for compiling DPDK, references are now\nremoved in the documentation.\n\nSigned-off-by: Ciara Power <ciara.power@intel.com>\nSigned-off-by: Louise Kilheeney <louise.kilheeney@intel.com>\n---\n doc/guides/contributing/design.rst | 127 ++--------------------\n doc/guides/contributing/documentation.rst | 31 +-----\n 2 files changed, 13 insertions(+), 145 deletions(-)", "diff": "diff --git a/doc/guides/contributing/design.rst b/doc/guides/contributing/design.rst\nindex 5fe7f63942..6ce0de97ac 100644\n--- a/doc/guides/contributing/design.rst\n+++ b/doc/guides/contributing/design.rst\n@@ -21,7 +21,7 @@ A file located in a subdir of \"linux\" is specific to this execution environment.\n \n When absolutely necessary, there are several ways to handle specific code:\n \n-* Use a ``#ifdef`` with the CONFIG option in the C code.\n+* Use a ``#ifdef`` with a build definition macro in the C code.\n This can be done when the differences are small and they can be embedded in the same C file:\n \n .. code-block:: c\n@@ -32,30 +32,22 @@ When absolutely necessary, there are several ways to handle specific code:\n titi();\n #endif\n \n-* Use the CONFIG option in the Makefile. This is done when the differences are more significant.\n- In this case, the code is split into two separate files that are architecture or environment specific.\n- This should only apply inside the EAL library.\n-\n-.. note::\n-\n- As in the linux kernel, the ``CONFIG_`` prefix is not used in C code.\n- This is only needed in Makefiles or shell scripts.\n \n Per Architecture Sources\n ~~~~~~~~~~~~~~~~~~~~~~~~\n \n-The following config options can be used:\n+The following macro options can be used:\n \n-* ``CONFIG_RTE_ARCH`` is a string that contains the name of the architecture.\n-* ``CONFIG_RTE_ARCH_I686``, ``CONFIG_RTE_ARCH_X86_64``, ``CONFIG_RTE_ARCH_X86_64_32`` or ``CONFIG_RTE_ARCH_PPC_64`` are defined only if we are building for those architectures.\n+* ``RTE_ARCH`` is a string that contains the name of the architecture.\n+* ``RTE_ARCH_I686``, ``RTE_ARCH_X86_64``, ``RTE_ARCH_X86_64_32`` or ``RTE_ARCH_PPC_64`` are defined only if we are building for those architectures.\n \n Per Execution Environment Sources\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n-The following config options can be used:\n+The following macro options can be used:\n \n-* ``CONFIG_RTE_EXEC_ENV`` is a string that contains the name of the executive environment.\n-* ``CONFIG_RTE_EXEC_ENV_FREEBSD`` or ``CONFIG_RTE_EXEC_ENV_LINUX`` are defined only if we are building for this execution environment.\n+* ``RTE_EXEC_ENV`` is a string that contains the name of the executive environment.\n+* ``RTE_EXEC_ENV_FREEBSD`` or ``RTE_EXEC_ENV_LINUX`` are defined only if we are building for this execution environment.\n \n Mbuf features\n -------------\n@@ -73,111 +65,6 @@ Adding a new static field or flag must be an exception matching many criteria\n like (non exhaustive): wide usage, performance, size.\n \n \n-Library Statistics\n-------------------\n-\n-Description\n-~~~~~~~~~~~\n-\n-This document describes the guidelines for DPDK library-level statistics counter\n-support. This includes guidelines for turning library statistics on and off and\n-requirements for preventing ABI changes when implementing statistics.\n-\n-\n-Mechanism to allow the application to turn library statistics on and off\n-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n-\n-Each library that maintains statistics counters should provide a single build\n-time flag that decides whether the statistics counter collection is enabled or\n-not. This flag should be exposed as a variable within the DPDK configuration\n-file. When this flag is set, all the counters supported by current library are\n-collected for all the instances of every object type provided by the library.\n-When this flag is cleared, none of the counters supported by the current library\n-are collected for any instance of any object type provided by the library:\n-\n-.. code-block:: console\n-\n- # DPDK file config/common_linux, config/common_freebsd, etc.\n- CONFIG_RTE_<LIBRARY_NAME>_STATS_COLLECT=y/n\n-\n-The default value for this DPDK configuration file variable (either \"yes\" or\n-\"no\") is decided by each library.\n-\n-\n-Prevention of ABI changes due to library statistics support\n-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n-\n-The layout of data structures and prototype of functions that are part of the\n-library API should not be affected by whether the collection of statistics\n-counters is turned on or off for the current library. In practical terms, this\n-means that space should always be allocated in the API data structures for\n-statistics counters and the statistics related API functions are always built\n-into the code, regardless of whether the statistics counter collection is turned\n-on or off for the current library.\n-\n-When the collection of statistics counters for the current library is turned\n-off, the counters retrieved through the statistics related API functions should\n-have a default value of zero.\n-\n-\n-Motivation to allow the application to turn library statistics on and off\n-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n-\n-It is highly recommended that each library provides statistics counters to allow\n-an application to monitor the library-level run-time events. Typical counters\n-are: number of packets received/dropped/transmitted, number of buffers\n-allocated/freed, number of occurrences for specific events, etc.\n-\n-However, the resources consumed for library-level statistics counter collection\n-have to be spent out of the application budget and the counters collected by\n-some libraries might not be relevant to the current application. In order to\n-avoid any unwanted waste of resources and/or performance impacts, the\n-application should decide at build time whether the collection of library-level\n-statistics counters should be turned on or off for each library individually.\n-\n-Library-level statistics counters can be relevant or not for specific\n-applications:\n-\n-* For Application A, counters maintained by Library X are always relevant and\n- the application needs to use them to implement certain features, such as traffic\n- accounting, logging, application-level statistics, etc. In this case,\n- the application requires that collection of statistics counters for Library X is\n- always turned on.\n-\n-* For Application B, counters maintained by Library X are only useful during the\n- application debug stage and are not relevant once debug phase is over. In this\n- case, the application may decide to turn on the collection of Library X\n- statistics counters during the debug phase and at a later stage turn them off.\n-\n-* For Application C, counters maintained by Library X are not relevant at all.\n- It might be that the application maintains its own set of statistics counters\n- that monitor a different set of run-time events (e.g. number of connection\n- requests, number of active users, etc). It might also be that the application\n- uses multiple libraries (Library X, Library Y, etc) and it is interested in the\n- statistics counters of Library Y, but not in those of Library X. In this case,\n- the application may decide to turn the collection of statistics counters off for\n- Library X and on for Library Y.\n-\n-The statistics collection consumes a certain amount of CPU resources (cycles,\n-cache bandwidth, memory bandwidth, etc) that depends on:\n-\n-* Number of libraries used by the current application that have statistics\n- counters collection turned on.\n-\n-* Number of statistics counters maintained by each library per object type\n- instance (e.g. per port, table, pipeline, thread, etc).\n-\n-* Number of instances created for each object type supported by each library.\n-\n-* Complexity of the statistics logic collection for each counter: when only\n- some occurrences of a specific event are valid, additional logic is typically\n- needed to decide whether the current occurrence of the event should be counted\n- or not. For example, in the event of packet reception, when only TCP packets\n- with destination port within a certain range should be recorded, conditional\n- branches are usually required. When processing a burst of packets that have been\n- validated for header integrity, counting the number of bits set in a bitmask\n- might be needed.\n-\n PF and VF Considerations\n ------------------------\n \ndiff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst\nindex 375ea64ba8..768453126f 100644\n--- a/doc/guides/contributing/documentation.rst\n+++ b/doc/guides/contributing/documentation.rst\n@@ -222,25 +222,14 @@ Build commands\n ~~~~~~~~~~~~~~\n \n The documentation is built using the standard DPDK build system.\n-Some examples are shown below:\n \n-* Generate all the documentation targets::\n+To enable doc building::\n \n- make doc\n+ meson configure -Denable_docs=true\n \n-* Generate the Doxygen API documentation in Html::\n+See :doc:`../linux_gsg/build_dpdk` for more detail on compiling DPDK with meson.\n \n- make doc-api-html\n-\n-* Generate the guides documentation in Html::\n-\n- make doc-guides-html\n-\n-* Generate the guides documentation in Pdf::\n-\n- make doc-guides-pdf\n-\n-The output of these commands is generated in the ``build`` directory::\n+The output is generated in the ``build`` directory::\n \n build/doc\n |-- html\n@@ -255,10 +244,6 @@ The output of these commands is generated in the ``build`` directory::\n \n Make sure to fix any Sphinx or Doxygen warnings when adding or updating documentation.\n \n-The documentation output files can be removed as follows::\n-\n- make doc-clean\n-\n \n Document Guidelines\n -------------------\n@@ -308,7 +293,7 @@ Line Length\n Long literal command lines can be shown wrapped with backslashes. For\n example::\n \n- testpmd -l 2-3 -n 4 \\\n+ dpdk-testpmd -l 2-3 -n 4 \\\n --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \\\n -- -i --tx-offloads=0x0000002c --enable-lro --txq=2 --rxq=2 \\\n --txd=1024 --rxd=1024\n@@ -460,7 +445,7 @@ Code and Literal block sections\n For long literal lines that exceed that limit try to wrap the text at sensible locations.\n For example a long command line could be documented like this and still work if copied directly from the docs::\n \n- build/app/testpmd -l 0-2 -n3 --vdev=net_pcap0,iface=eth0 \\\n+ ./<build_dir>/app/dpdk-testpmd -l 0-2 -n3 --vdev=net_pcap0,iface=eth0 \\\n --vdev=net_pcap1,iface=eth1 \\\n -- -i --nb-cores=2 --nb-ports=2 \\\n --total-num-mbufs=2048\n@@ -743,9 +728,5 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati\n /** Array of physical page addresses for the mempool buffer. */\n phys_addr_t elt_pa[MEMPOOL_PG_NUM_DEFAULT];\n \n-* Check for Doxygen warnings in new code by checking the API documentation build::\n-\n- make doc-api-html >/dev/null\n-\n * Read the rendered section of the documentation that you have added for correctness, clarity and consistency\n with the surrounding text.\n", "prefixes": [ "v4", "31/31" ] }