Patch Detail

HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 63252,
    "url": "http://patches.dpdk.org/api/patches/63252/?format=api",
    "web_url": "http://patches.dpdk.org/project/dpdk/patch/20191122160359.11625-7-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": "<20191122160359.11625-7-bruce.richardson@intel.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20191122160359.11625-7-bruce.richardson@intel.com",
    "date": "2019-11-22T16:03:57",
    "name": "[6/8] doc: add meson install instructions for FreeBSD",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "e2934cc9afb5ebf4040e3dd76bd16429f1a46147",
    "submitter": {
        "id": 20,
        "url": "http://patches.dpdk.org/api/people/20/?format=api",
        "name": "Bruce Richardson",
        "email": "bruce.richardson@intel.com"
    },
    "delegate": null,
    "mbox": "http://patches.dpdk.org/project/dpdk/patch/20191122160359.11625-7-bruce.richardson@intel.com/mbox/",
    "series": [
        {
            "id": 7590,
            "url": "http://patches.dpdk.org/api/series/7590/?format=api",
            "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=7590",
            "date": "2019-11-22T16:03:53",
            "name": "GSG Documentation updates",
            "version": 1,
            "mbox": "http://patches.dpdk.org/series/7590/mbox/"
        }
    ],
    "comments": "http://patches.dpdk.org/api/patches/63252/comments/",
    "check": "fail",
    "checks": "http://patches.dpdk.org/api/patches/63252/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 7309DA04C3;\n\tFri, 22 Nov 2019 17:05:15 +0100 (CET)",
            "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id C93131BE95;\n\tFri, 22 Nov 2019 17:04:28 +0100 (CET)",
            "from mga02.intel.com (mga02.intel.com [134.134.136.20])\n by dpdk.org (Postfix) with ESMTP id 2843D2BB1\n for <dev@dpdk.org>; Fri, 22 Nov 2019 17:04:17 +0100 (CET)",
            "from fmsmga006.fm.intel.com ([10.253.24.20])\n by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n 22 Nov 2019 08:04:16 -0800",
            "from silpixa00399126.ir.intel.com (HELO\n silpixa00399126.ger.corp.intel.com) ([10.237.223.2])\n by fmsmga006.fm.intel.com with ESMTP; 22 Nov 2019 08:04:15 -0800"
        ],
        "X-Amp-Result": "SKIPPED(no attachment in message)",
        "X-Amp-File-Uploaded": "False",
        "X-ExtLoop1": "1",
        "X-IronPort-AV": "E=Sophos;i=\"5.69,230,1571727600\"; d=\"scan'208\";a=\"408931113\"",
        "From": "Bruce Richardson <bruce.richardson@intel.com>",
        "To": "john.mcnamara@intel.com",
        "Cc": "dev@dpdk.org,\n\tBruce Richardson <bruce.richardson@intel.com>",
        "Date": "Fri, 22 Nov 2019 16:03:57 +0000",
        "Message-Id": "<20191122160359.11625-7-bruce.richardson@intel.com>",
        "X-Mailer": "git-send-email 2.21.0",
        "In-Reply-To": "<20191122160359.11625-1-bruce.richardson@intel.com>",
        "References": "<20191122160359.11625-1-bruce.richardson@intel.com>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "Subject": "[dpdk-dev] [PATCH 6/8] doc: add meson install instructions for\n\tFreeBSD",
        "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": "Update the FreeBSD GSG doc with instructions for installing using meson and\nninja rather than make.\n\nSigned-off-by: Bruce Richardson <bruce.richardson@intel.com>\n---\n doc/guides/freebsd_gsg/build_dpdk.rst | 164 +++++++-------------------\n 1 file changed, 40 insertions(+), 124 deletions(-)",
    "diff": "diff --git a/doc/guides/freebsd_gsg/build_dpdk.rst b/doc/guides/freebsd_gsg/build_dpdk.rst\nindex 7abd85aa5..c5d5379f6 100644\n--- a/doc/guides/freebsd_gsg/build_dpdk.rst\n+++ b/doc/guides/freebsd_gsg/build_dpdk.rst\n@@ -6,147 +6,63 @@\n Compiling the DPDK Target from Source\n =====================================\n \n-System Requirements\n--------------------\n+Prerequisites\n+-------------\n \n-The DPDK and its applications require the GNU make system (gmake)\n-to build on FreeBSD. Optionally, gcc may also be used in place of clang\n-to build the DPDK, in which case it too must be installed prior to\n-compiling the DPDK. The installation of these tools is covered in this\n-section.\n+The following FreeBSD packages are required to build DPDK:\n \n-Compiling the DPDK requires the FreeBSD kernel sources, which should be\n-included during the installation of FreeBSD on the development platform.\n-The DPDK also requires the use of FreeBSD ports to compile and function.\n+* meson\n+* ninja\n+* pkgconf\n \n-To use the FreeBSD ports system, it is required to update and extract the FreeBSD\n-ports tree by issuing the following commands:\n+These can be installed using (as root)::\n \n-.. code-block:: console\n-\n-    portsnap fetch\n-    portsnap extract\n-\n-If the environment requires proxies for external communication, these can be set\n-using:\n-\n-.. code-block:: console\n-\n-    setenv http_proxy <my_proxy_host>:<port>\n-    setenv ftp_proxy <my_proxy_host>:<port>\n-\n-The FreeBSD ports below need to be installed prior to building the DPDK.\n-In general these can be installed using the following set of commands::\n-\n-   cd /usr/ports/<port_location>\n-\n-   make config-recursive\n-\n-   make install\n-\n-   make clean\n-\n-Each port location can be found using::\n-\n-   whereis <port_name>\n-\n-The ports required and their locations are as follows:\n-\n-* dialog4ports: ``/usr/ports/ports-mgmt/dialog4ports``\n-\n-* GNU make(gmake): ``/usr/ports/devel/gmake``\n-\n-* coreutils: ``/usr/ports/sysutils/coreutils``\n-\n-For compiling and using the DPDK with gcc, the compiler must be installed\n-from the ports collection:\n-\n-* gcc: version 4.9 is recommended ``/usr/ports/lang/gcc49``.\n-  Ensure that ``CPU_OPTS`` is selected (default is OFF).\n-\n-When running the make config-recursive command, a dialog may be presented to the\n-user. For the installation of the DPDK, the default options were used.\n-\n-.. note::\n+  pkg install meson pkgconf\n \n-    To avoid multiple dialogs being presented to the user during make install,\n-    it is advisable before running the make install command to re-run the\n-    make config-recursive command until no more dialogs are seen.\n+To compile the required kernel modules for memory management and working\n+with physical NIC devices, the kernel sources for FreeBSD also\n+need to be installed. If not already present on the system, these can be\n+installed via commands like the following, for FreeBSD 12.1 on x86_64::\n \n+  fetch http://ftp.freebsd.org/pub/FreeBSD/releases/amd64/12.1-RELEASE/src.txz\n+  tar -C / -xJvf src.txz\n \n-Install the DPDK and Browse Sources\n------------------------------------\n+To enable the telemetry library in DPDK, the jansson library also needs to\n+be installed, and can be installed via::\n \n-First, uncompress the archive and move to the DPDK source directory:\n+  pkg install jansson\n \n-.. code-block:: console\n-\n-    unzip DPDK-<version>.zip\n-    cd DPDK-<version>\n-\n-The DPDK is composed of several directories:\n-\n-*   lib: Source code of DPDK libraries\n-\n-*   app: Source code of DPDK applications (automatic tests)\n-\n-*   examples: Source code of DPDK applications\n-\n-*   config, buildtools, mk: Framework-related makefiles, scripts and configuration\n-\n-Installation of the DPDK Target Environments\n---------------------------------------------\n-\n-The format of a DPDK target is::\n-\n-   ARCH-MACHINE-EXECENV-TOOLCHAIN\n-\n-Where:\n+Individual drivers may have additional requirements. Consult the relevant\n+driver guide for any driver-specific requirements of interest.\n \n-* ``ARCH`` is: ``x86_64``\n+Building DPDK\n+-------------\n \n-* ``MACHINE`` is: ``native``\n+The following commands can be used to build and install DPDK on a system.\n+The final, install, step generally needs to be run as root::\n \n-* ``EXECENV`` is: ``freebsd``\n+  meson build\n+  cd build\n+  ninja\n+  ninja install\n \n-* ``TOOLCHAIN`` is: ``gcc`` | ``clang``\n-\n-The configuration files for the DPDK targets can be found in the DPDK/config\n-directory in the form of::\n-\n-    defconfig_ARCH-MACHINE-EXECENV-TOOLCHAIN\n+This will install the DPDK libraries and drivers to `/usr/local/lib` with a\n+pkg-config file `libdpdk.pc` installed to `/usr/local/lib/pkgconfig`. The\n+DPDK test applications, such as `dpdk-testpmd` are installed to\n+`/usr/local/bin`. To use these applications, it is recommended that the\n+`contigmem` and `nic_uio` kernel modules be loaded first, as described in\n+the next section.\n \n .. note::\n \n-   Configuration files are provided with the ``RTE_MACHINE`` optimization level set.\n-   Within the configuration files, the ``RTE_MACHINE`` configuration value is set\n-   to native, which means that the compiled software is tuned for the platform\n-   on which it is built.  For more information on this setting, and its\n-   possible values, see the *DPDK Programmers Guide*.\n-\n-To make the target, use ``gmake install T=<target>``.\n-\n-For example to compile for FreeBSD use:\n-\n-.. code-block:: console\n-\n-    gmake install T=x86_64-native-freebsd-clang\n-\n-.. note::\n-\n-   If the compiler binary to be used does not correspond to that given in the\n-   TOOLCHAIN part of the target, the compiler command may need to be explicitly\n-   specified. For example, if compiling for gcc, where the gcc binary is called\n-   gcc4.9, the command would need to be ``gmake install T=<target> CC=gcc4.9``.\n-\n-Browsing the Installed DPDK Environment Target\n-----------------------------------------------\n+        It is recommended that pkg-config be used to query information\n+        about the compiler and linker flags needed to build applications\n+        against DPDK.  In some cases, the path `/usr/local/lib/pkgconfig`\n+        may not be in the default search paths for `.pc` files, which means\n+        that queries for DPDK information may fail. This can be fixed by\n+        setting the appropriate path in `PKG_CONFIG_PATH` environment\n+        variable.\n \n-Once a target is created, it contains all the libraries and header files for the\n-DPDK environment that are required to build customer applications.\n-In addition, the test and testpmd applications are built under the build/app\n-directory, which may be used for testing.  A kmod directory is also present that\n-contains the kernel modules to install.\n \n .. _loading_contigmem:\n \n",
    "prefixes": [
        "6/8"
    ]
}