Cover Detail
Show a cover letter.
GET /api/covers/407/?format=api
{ "id": 407, "url": "http://patches.dpdk.org/api/covers/407/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/cover/20231115133606.42081-1-juraj.linkes@pantheon.tech/", "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": "<20231115133606.42081-1-juraj.linkes@pantheon.tech>", "list_archive_url": "https://inbox.dpdk.org/dev/20231115133606.42081-1-juraj.linkes@pantheon.tech", "date": "2023-11-15T13:36:04", "name": "[v1,0/2] dts: api docs generation", "submitter": { "id": 1626, "url": "http://patches.dpdk.org/api/people/1626/?format=api", "name": "Juraj Linkeš", "email": "juraj.linkes@pantheon.tech" }, "mbox": "http://patches.dpdk.org/project/dpdk/cover/20231115133606.42081-1-juraj.linkes@pantheon.tech/mbox/", "series": [ { "id": 30303, "url": "http://patches.dpdk.org/api/series/30303/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30303", "date": "2023-11-15T13:36:04", "name": "dts: api docs generation", "version": 1, "mbox": "http://patches.dpdk.org/series/30303/mbox/" } ], "comments": "http://patches.dpdk.org/api/covers/407/comments/", "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 1BFE443339;\n\tWed, 15 Nov 2023 14:36:10 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 0888940294;\n\tWed, 15 Nov 2023 14:36:10 +0100 (CET)", "from mail-lf1-f54.google.com (mail-lf1-f54.google.com\n [209.85.167.54]) by mails.dpdk.org (Postfix) with ESMTP id 3073B40285\n for <dev@dpdk.org>; Wed, 15 Nov 2023 14:36:08 +0100 (CET)", "by mail-lf1-f54.google.com with SMTP id\n 2adb3069b0e04-507a29c7eefso9521757e87.1\n for <dev@dpdk.org>; Wed, 15 Nov 2023 05:36:08 -0800 (PST)", "from jlinkes-PT-Latitude-5530.pantheon.local\n (81.89.53.154.host.vnet.sk. [81.89.53.154])\n by smtp.gmail.com with ESMTPSA id\n n20-20020a170906b31400b009e656ce2930sm7100749ejz.60.2023.11.15.05.36.06\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Wed, 15 Nov 2023 05:36:07 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=pantheon.tech; s=google; t=1700055367; x=1700660167; darn=dpdk.org;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:from:to:cc:subject:date\n :message-id:reply-to;\n bh=pBTDWek6gqN/rqzLzs626aB76fgLoQao/EdfXWvnnBQ=;\n b=VpxYc9BVyssNwuBmdKSLbPxmH/ISo0ZiW466G7grcyzfxzOLsQZJOg6Erm3xfjdpCk\n 2+wukcooVOdUYQZrfgLl7+febzS8pwfmalkqxBOGd9P+QEPaceexBc2B4gbA2GBctv60\n pQL1Xr3HOGLt0VNv41GRWEbtZzRLUfmxEDQ/bVEOxVmkBW/l0ezwa1IvFyoZC4z2oljH\n b7LJQm5FWhxufvj4pDW8PGQ4cMozeXCpGQ1EJ4x0snqB2+LDRLcrVIrMU/SQi5u7uhlY\n WGY1doObcB3Q4Hjm1qpiZVJmMt55Uzu0ZckeEILFcjz7/tJYwXvSFDzjhMt+EEEXt9/O\n XrYw==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1700055367; x=1700660167;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n :subject:date:message-id:reply-to;\n bh=pBTDWek6gqN/rqzLzs626aB76fgLoQao/EdfXWvnnBQ=;\n b=oERV4DvbLbKurcigRrcqeVOWfEW9EhVqMhJ8s8vkyTsBzQPmrHhNIv/WJHNGX/r1tW\n I7jfhRFlo4HKTOxhiBo3MS2D9RZGmqdW1isKOW8w2XRTlV52GldVxdUxpCgkagSGnFTu\n TIQV7gvGpKfcKHC+x8yf379vBcPXH0/vaPxhMv36yUShF4EVnMoDZCmS7h/u8F4WWmFP\n 6OvYGwQSeZy8gRoZXlahP79rU1xbTCj2BwdCXGRWmtVxsWQA2CO4grtbOwE/uJUf/h6G\n 3ciiz2LbPxs7wxPh7DOHeGqVPz2+OEJpg53vBNLe72zuTby2KTaOU5TQH87pTlmFEPXG\n XM/w==", "X-Gm-Message-State": "AOJu0Yy/2RtLDWNNF83FKjF3VmvEY9MxyMuqx2VS9BMwFDMCAo5USViA\n s4tjguUSKqHcn/uSArMyfM0rEA==", "X-Google-Smtp-Source": "\n AGHT+IGO/Ljf5hEwuFxsHOHl+/QvYLITPvZLvGw/CJ/+y1fuThuSmiL9r6zzACLvV8nOukhYICL5+Q==", "X-Received": "by 2002:a05:6512:1087:b0:509:31c3:288c with SMTP id\n j7-20020a056512108700b0050931c3288cmr11830735lfg.30.1700055367641;\n Wed, 15 Nov 2023 05:36:07 -0800 (PST)", "From": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "To": "thomas@monjalon.net, Honnappa.Nagarahalli@arm.com,\n bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu,\n paul.szczepanek@arm.com, yoan.picchi@foss.arm.com", "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "Subject": "[PATCH v1 0/2] dts: api docs generation", "Date": "Wed, 15 Nov 2023 14:36:04 +0100", "Message-Id": "<20231115133606.42081-1-juraj.linkes@pantheon.tech>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20231108125324.191005-23-juraj.linkes@pantheon.tech>", "References": "<20231108125324.191005-23-juraj.linkes@pantheon.tech>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "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" }, "content": "The generation is done with Sphinx, which DPDK already uses, with\nslightly modified configuration (the sidebar: unlimited depth and better\ncollapsing - I need comment on this).\n\nDependencies are installed using Poetry from the dts directory:\n\npoetry install --with docs\n\nAfter installing, enter the Poetry shell:\n\npoetry shell\n\nAnd then run the build:\nninja -C <meson_build_dir> dts-doc\n\nThis patchet depends on the series which updates the DTS docstrings. The\ntechnical reason for this dependency is the hash value of the\npoetry.lock file, which wouldn't match the contents were the patches to\nbe applied individually (the hash value would need to be recomputed\nafter applying the second patch).\nThe logical reason is that there's basically no point in generating the\ndocumentation with the configuration in this patch series that's\ntailored to the google format, which is contained in the depended\nseries. The generation would produce confusing errors and incomplete,\nnot good looking docs.\n\nThis patch series is much less important that the one updating the\ndocstrings. The docstrings series must be finished and applied as soon\nas possible, as it has a dramatic impact on future development, while\nthis series doesn't hamper other development in any way.\n\nDepends-on: series-30302 (\"dts: docstrings update\")\n\nJuraj Linkeš (2):\n dts: add doc generation dependencies\n dts: add doc generation\n\n buildtools/call-sphinx-build.py | 29 +-\n doc/api/meson.build | 1 +\n doc/guides/conf.py | 34 ++-\n doc/guides/meson.build | 1 +\n doc/guides/tools/dts.rst | 32 +-\n dts/doc/conf_yaml_schema.json | 1 +\n dts/doc/index.rst | 17 ++\n dts/doc/meson.build | 60 ++++\n dts/meson.build | 16 +\n dts/poetry.lock | 499 +++++++++++++++++++++++++++++++-\n dts/pyproject.toml | 7 +\n meson.build | 1 +\n 12 files changed, 681 insertions(+), 17 deletions(-)\n create mode 120000 dts/doc/conf_yaml_schema.json\n create mode 100644 dts/doc/index.rst\n create mode 100644 dts/doc/meson.build\n create mode 100644 dts/meson.build" }