Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/44599/?format=api
{ "id": 44599, "url": "https://patches.dpdk.org/api/patches/44599/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20180911204236.21858-4-bluca@debian.org/", "project": { "id": 1, "url": "https://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": "<20180911204236.21858-4-bluca@debian.org>", "list_archive_url": "https://inbox.dpdk.org/dev/20180911204236.21858-4-bluca@debian.org", "date": "2018-09-11T20:42:36", "name": "[v5,4/4] build: generate API documentation with Meson", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "cf13af9ba4134e29d54e461ed4464cf821d0f6c7", "submitter": { "id": 823, "url": "https://patches.dpdk.org/api/people/823/?format=api", "name": "Luca Boccassi", "email": "bluca@debian.org" }, "delegate": { "id": 1, "url": "https://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20180911204236.21858-4-bluca@debian.org/mbox/", "series": [ { "id": 1286, "url": "https://patches.dpdk.org/api/series/1286/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=1286", "date": "2018-09-11T20:42:33", "name": "[v5,1/4] mk: use script to generate examples.dox", "version": 5, "mbox": "https://patches.dpdk.org/series/1286/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/44599/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/44599/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 [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 912894F93;\n\tTue, 11 Sep 2018 22:42:49 +0200 (CEST)", "from mail-wr1-f65.google.com (mail-wr1-f65.google.com\n\t[209.85.221.65]) by dpdk.org (Postfix) with ESMTP id B7A934D27\n\tfor <dev@dpdk.org>; Tue, 11 Sep 2018 22:42:47 +0200 (CEST)", "by mail-wr1-f65.google.com with SMTP id g33-v6so27460373wrd.1\n\tfor <dev@dpdk.org>; Tue, 11 Sep 2018 13:42:47 -0700 (PDT)", "from localhost ([2a01:4b00:f419:6f00:8361:8946:ba2b:d556])\n\tby smtp.gmail.com with ESMTPSA id\n\tf17-v6sm23949443wrs.1.2018.09.11.13.42.45\n\t(version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256);\n\tTue, 11 Sep 2018 13:42:45 -0700 (PDT)" ], "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\n\t:references;\n\tbh=Q7iv5ljMvI9xCPJFp3ZfQ/0wuFwbRCllcEo/b3iQMkA=;\n\tb=XwnLEo9MD6Z+TeWly2N3pz1Y/lAwq4fBC6Be+R5ZJR3yq6BcNZe4FWYPl2Axrka12U\n\tUhtxYiq8JolaFVJkJGL7JDiIlaLbvsS1tXA2VYUhOdsutwQfJeSGXPpRTtZv6GQMZ13k\n\tWYUTnO/zcwYYnK0Tub95qtt6fypPuxnSBLtBNMZn9vOGUwJxNlHhnIHq0nBZOuQooTvS\n\tuxrhnA9IZE9f4/nSf6occP9G/Cht6J+vY8m8QbhmG0d2qOheqj07LN4O03zfAbn2OHr/\n\t5C1EWydxOc7B96uQ6Mue6D1foMi5vZQME6jy1p6AY/+IVryYbT0YWWb6tMOYgVCOIYm3\n\tDKvQ==", "X-Gm-Message-State": "APzg51DXZUPagMgqjc6RGIjsjE8yT/gZb+cipZgLShhUxvFhIbP7/OiQ\n\tX2fL4gOf7qJHI42u6BkoHVZjyTuaLbw=", "X-Google-Smtp-Source": "ANB0VdZO59Ppyrlo9IX9b7wBiJ0v1H4TeTMg98rAn3KuOKeP535G0RlLagIyb4yzZHJLzraT9lK3HA==", "X-Received": "by 2002:a5d:4b90:: with SMTP id\n\tb16-v6mr20851417wrt.168.1536698566983; \n\tTue, 11 Sep 2018 13:42:46 -0700 (PDT)", "From": "Luca Boccassi <bluca@debian.org>", "To": "dev@dpdk.org", "Cc": "bruce.richardson@intel.com, john.mcnamara@intel.com,\n\tmarko.kovacevic@intel.com, thomas@monjalon.net", "Date": "Tue, 11 Sep 2018 21:42:36 +0100", "Message-Id": "<20180911204236.21858-4-bluca@debian.org>", "X-Mailer": "git-send-email 2.18.0", "In-Reply-To": "<20180911204236.21858-1-bluca@debian.org>", "References": "<20180831182055.30772-1-bluca@debian.org>\n\t<20180911204236.21858-1-bluca@debian.org>", "Subject": "[dpdk-dev] [PATCH v5 4/4] build: generate API documentation with\n\tMeson", "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\t<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\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Signed-off-by: Luca Boccassi <bluca@debian.org>\nAcked-by: Bruce Richardson <bruce.richardson@intel.com>\n---\nv2: made doxygen dependency optional, skip doxygen build when not found\nv3: made doxygen dependency mandatory if enable_docs is true, add\n alternative doc target that prints \"doxygen not found\" when doxygen\n is not found and enable_docs is false (default)\nv4: add acked-by\nv5: change install directory to $PREFIX/share/doc/dpdk to match legacy\n makefiles\n\n doc/api/generate_doxygen.sh | 10 +++++++\n doc/api/meson.build | 56 +++++++++++++++++++++++++++++++++++++\n doc/build-sdk-meson.txt | 2 ++\n doc/meson.build | 4 +++\n meson.build | 3 ++\n meson_options.txt | 2 ++\n 6 files changed, 77 insertions(+)\n create mode 100755 doc/api/generate_doxygen.sh\n create mode 100644 doc/api/meson.build\n create mode 100644 doc/meson.build", "diff": "diff --git a/doc/api/generate_doxygen.sh b/doc/api/generate_doxygen.sh\nnew file mode 100755\nindex 0000000000..ab57660958\n--- /dev/null\n+++ b/doc/api/generate_doxygen.sh\n@@ -0,0 +1,10 @@\n+#! /bin/sh -e\n+# SPDX-License-Identifier: BSD-3-Clause\n+# Copyright 2018 Luca Boccassi <bluca@debian.org>\n+\n+DOXYCONF=$1\n+OUTDIR=$2\n+SCRIPTCSS=$3\n+\n+doxygen \"${DOXYCONF}\"\n+\"${SCRIPTCSS}\" \"${OUTDIR}\"/doxygen.css\ndiff --git a/doc/api/meson.build b/doc/api/meson.build\nnew file mode 100644\nindex 0000000000..13fcbb8cd7\n--- /dev/null\n+++ b/doc/api/meson.build\n@@ -0,0 +1,56 @@\n+# SPDX-License-Identifier: BSD-3-Clause\n+# Copyright(c) 2018 Luca Boccassi <bluca@debian.org>\n+\n+doxygen = find_program('doxygen', required: get_option('enable_docs'))\n+\n+if doxygen.found()\n+\t# due to the CSS customisation script, which needs to run on a file that\n+\t# is in a subdirectory that is created at build time and thus it cannot\n+\t# be an individual custom_target, we need to wrap the doxygen call in a\n+\t# script to run the CSS modification afterwards\n+\tgenerate_doxygen = find_program('generate_doxygen.sh')\n+\tgenerate_examples = find_program('generate_examples.sh')\n+\tgenerate_css = find_program('doxy-html-custom.sh')\n+\n+\tinputdir = join_paths(meson.source_root(), 'examples')\n+\thtmldir = join_paths('share', 'doc', 'dpdk')\n+\n+\t# due to the following bug: https://github.com/mesonbuild/meson/issues/4107\n+\t# if install is set to true it will override build_by_default and it will\n+\t# cause the target to always be built. If install were to be always set to\n+\t# false it would be impossible to install the docs.\n+\t# So use a configure option for now.\n+\texample = custom_target('examples.dox',\n+\t\tinput: inputdir,\n+\t\toutput: 'examples.dox',\n+\t\tcommand: [generate_examples, '@INPUT@', '@OUTPUT@'],\n+\t\tinstall: get_option('enable_docs'),\n+\t\tinstall_dir: htmldir,\n+\t\tbuild_by_default: false)\n+\n+\tcdata = configuration_data()\n+\tcdata.set('VERSION', meson.project_version())\n+\tcdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples.dox'))\n+\tcdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api'))\n+\tcdata.set('HTML_OUTPUT', 'api')\n+\tcdata.set('TOPDIR', meson.source_root())\n+\tcdata.set('STRIP_FROM_PATH', meson.source_root())\n+\n+\tdoxy_conf = configure_file(input: 'doxy-api.conf.in',\n+\t\toutput: 'doxy-api.conf',\n+\t\tconfiguration: cdata,\n+\t\tinstall: false)\n+\n+\tdoxy_build = custom_target('doxygen',\n+\t\tdepends: example,\n+\t\tinput: doxy_conf,\n+\t\toutput: 'api',\n+\t\tcommand: [generate_doxygen, '@INPUT@', '@OUTPUT@', generate_css],\n+\t\tinstall: get_option('enable_docs'),\n+\t\tinstall_dir: htmldir,\n+\t\tbuild_by_default: false)\n+\n+\trun_target('doc', command: 'true', depends: doxy_build)\n+else\n+\trun_target('doc', command: ['echo', 'doxygen', 'not', 'found'])\n+endif\ndiff --git a/doc/build-sdk-meson.txt b/doc/build-sdk-meson.txt\nindex 9618e759ea..508e2cb642 100644\n--- a/doc/build-sdk-meson.txt\n+++ b/doc/build-sdk-meson.txt\n@@ -85,6 +85,8 @@ Project-specific options are passed used -Doption=value::\n \n \tmeson -Dmax_lcores=8 smallbuild # scale build for smaller systems\n \n+\tmeson -Denable_docs=true fullbuild # build and install docs\n+\n Examples of setting the same options using meson configure::\n \n \tmeson configure -Dwerror=true\ndiff --git a/doc/meson.build b/doc/meson.build\nnew file mode 100644\nindex 0000000000..afca2e7133\n--- /dev/null\n+++ b/doc/meson.build\n@@ -0,0 +1,4 @@\n+# SPDX-License-Identifier: BSD-3-Clause\n+# Copyright(c) 2018 Luca Boccassi <bluca@debian.org>\n+\n+subdir('api')\ndiff --git a/meson.build b/meson.build\nindex 9999e8640a..09506ec48c 100644\n--- a/meson.build\n+++ b/meson.build\n@@ -34,6 +34,9 @@ subdir('usertools')\n subdir('app')\n subdir('test')\n \n+# build docs\n+subdir('doc')\n+\n # build any examples explicitly requested - useful for developers\n if get_option('examples') != ''\n \tsubdir('examples')\ndiff --git a/meson_options.txt b/meson_options.txt\nindex f20887212a..d38ba56e29 100644\n--- a/meson_options.txt\n+++ b/meson_options.txt\n@@ -2,6 +2,8 @@ option('allow_invalid_socket_id', type: 'boolean', value: false,\n \tdescription: 'allow out-of-range NUMA socket id\\'s for platforms that don\\'t report the value correctly')\n option('enable_kmods', type: 'boolean', value: true,\n \tdescription: 'build kernel modules')\n+option('enable_docs', type: 'boolean', value: false,\n+\tdescription: 'build documentation')\n option('examples', type: 'string', value: '',\n \tdescription: 'Comma-separated list of examples to build by default')\n option('include_subdir_arch', type: 'string', value: '',\n", "prefixes": [ "v5", "4/4" ] }