Cover Detail
Show a cover letter.
GET /api/covers/79223/?format=api
{ "id": 79223, "url": "http://patchwork.dpdk.org/api/covers/79223/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/cover/20200929165502.336919-1-bruce.richardson@intel.com/", "project": { "id": 1, "url": "http://patchwork.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": "<20200929165502.336919-1-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20200929165502.336919-1-bruce.richardson@intel.com", "date": "2020-09-29T16:54:56", "name": "[v2,0/6] improve building docs", "submitter": { "id": 20, "url": "http://patchwork.dpdk.org/api/people/20/?format=api", "name": "Bruce Richardson", "email": "bruce.richardson@intel.com" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/cover/20200929165502.336919-1-bruce.richardson@intel.com/mbox/", "series": [ { "id": 12598, "url": "http://patchwork.dpdk.org/api/series/12598/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=12598", "date": "2020-09-29T16:54:57", "name": "improve building docs", "version": 2, "mbox": "http://patchwork.dpdk.org/series/12598/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/covers/79223/comments/", "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 4BAA1A04B5;\n\tTue, 29 Sep 2020 18:56:07 +0200 (CEST)", "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id EB55F1DA86;\n\tTue, 29 Sep 2020 18:55:19 +0200 (CEST)", "from mga04.intel.com (mga04.intel.com [192.55.52.120])\n by dpdk.org (Postfix) with ESMTP id 2F1FF1D91B\n for <dev@dpdk.org>; Tue, 29 Sep 2020 18:55:13 +0200 (CEST)", "from orsmga003.jf.intel.com ([10.7.209.27])\n by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 29 Sep 2020 09:55:08 -0700", "from silpixa00399126.ir.intel.com ([10.237.222.4])\n by orsmga003.jf.intel.com with ESMTP; 29 Sep 2020 09:55:07 -0700" ], "IronPort-SDR": [ "\n I14+lnnghvx+t0ZsdyD9bA4rAlHzNiC1U1Pn0QKdLO349ZNXiug2bNo4Zb4ywyFd+xw2VIH0D6\n VzHouuCcaW5A==", "\n LZ2FNv8poCL14W++XNk2B9P+FfkRiJw6KNcq77O8ivyWTfc/wlAmKTjKWMWRNQiA/0IFOFS6VG\n c6Unq+Q20KgA==" ], "X-IronPort-AV": [ "E=McAfee;i=\"6000,8403,9759\"; a=\"159612212\"", "E=Sophos;i=\"5.77,319,1596524400\"; d=\"scan'208\";a=\"159612212\"", "E=Sophos;i=\"5.77,319,1596524400\"; d=\"scan'208\";a=\"307833173\"" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org", "Cc": "thomas@monjalon.net,\n\tBruce Richardson <bruce.richardson@intel.com>", "Date": "Tue, 29 Sep 2020 17:54:56 +0100", "Message-Id": "<20200929165502.336919-1-bruce.richardson@intel.com>", "X-Mailer": "git-send-email 2.25.1", "In-Reply-To": "<20200929153413.280581-1-bruce.richardson@intel.com>", "References": "<20200929153413.280581-1-bruce.richardson@intel.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[dpdk-dev] [PATCH v2 0/6] improve building docs", "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": "When building the documentation, a lot of text is output, meaning that\nany warnings can be missed in all the text. Unfortunately, ninja merges\nboth stderr and stdout of all tasks so one cannot just redirect stdout to\na separate location as part of the build command to rectify that.\nTherefore, since we rarely care about the output of the doc builds, only\noutput the stderr text and write the standard output text to a log file\nin the relevant build folder (i.e. build/doc/guides or build/doc/api)\n\nRelated to this, we can catch documentation bugs earlier by setting\nWARN_AS_ERRORS for doxygen, meaning the build will fail if any API\ndocumentation warnings as encountered. Rather than setting this globally,\nwe can link it to the global build --werror setting.\n\n---\nV2: added in patches to fix API doc issue, and enable WARN_AS_ERRORS\n\nBruce Richardson (6):\n doc/api: hide verbose doxygen standard output\n doc/api: align output folder with sphinx guides\n doc/api: put output log file in build directory\n doc/guides: suppress printing out standard output\n ethdev: fix mis-named parameter\n doc/api: make doc warnings errors when werror option set\n\n buildtools/call-sphinx-build.py | 6 ++++--\n doc/api/doxy-api.conf.in | 1 +\n doc/api/generate_doxygen.sh | 6 ++++--\n doc/api/meson.build | 10 +++++++---\n lib/librte_ethdev/rte_ethdev.h | 2 +-\n 5 files changed, 17 insertions(+), 8 deletions(-)" }