Cover Detail
Show a cover letter.
GET /api/covers/125443/?format=api
{ "id": 125443, "url": "http://patches.dpdk.org/api/covers/125443/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/cover/20230323104040.484708-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": "<20230323104040.484708-1-juraj.linkes@pantheon.tech>", "list_archive_url": "https://inbox.dpdk.org/dev/20230323104040.484708-1-juraj.linkes@pantheon.tech", "date": "2023-03-23T10:40:36", "name": "[RFC,v1,0/4] dts: add dts api docs", "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/20230323104040.484708-1-juraj.linkes@pantheon.tech/mbox/", "series": [ { "id": 27515, "url": "http://patches.dpdk.org/api/series/27515/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=27515", "date": "2023-03-23T10:40:36", "name": "dts: add dts api docs", "version": 1, "mbox": "http://patches.dpdk.org/series/27515/mbox/" } ], "comments": "http://patches.dpdk.org/api/covers/125443/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 E3BB342813;\n\tThu, 23 Mar 2023 11:40:45 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id BC49441101;\n\tThu, 23 Mar 2023 11:40:45 +0100 (CET)", "from mail-ed1-f44.google.com (mail-ed1-f44.google.com\n [209.85.208.44]) by mails.dpdk.org (Postfix) with ESMTP id 65C224021D\n for <dev@dpdk.org>; Thu, 23 Mar 2023 11:40:44 +0100 (CET)", "by mail-ed1-f44.google.com with SMTP id w9so84454071edc.3\n for <dev@dpdk.org>; Thu, 23 Mar 2023 03:40:44 -0700 (PDT)", "from localhost.localdomain (ip-46.34.245.107.o2inet.sk.\n [46.34.245.107]) by smtp.gmail.com with ESMTPSA id\n k10-20020a1709067aca00b009294524ac21sm8472773ejo.60.2023.03.23.03.40.43\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Thu, 23 Mar 2023 03:40:43 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=pantheon-tech.20210112.gappssmtp.com; s=20210112; t=1679568044;\n h=content-transfer-encoding:mime-version:message-id:date:subject:cc\n :to:from:from:to:cc:subject:date:message-id:reply-to;\n bh=rDkeo/v/KKskDhUMaT/MrzylGK8d5B7LNnmlGMplVJQ=;\n b=HtJWlwNADvTFu+mxL1JVOS5RA2e480jLfXfDK47l5WcWn8RcZx0Pwy0taL7OzHLsof\n tXeW2UStrxVnScGY5Kn3dDdjbDe24amSHbKQ4mmiou/bXm0ptz2WsbqlwT2Fc0p83ZOH\n QsxuKyZ/NQ0LJgd9NBblhEVdkspSvDrYlCtxPmgfznWPrY9JPnV3hy9SqvuPsT/+L8wq\n uVd6PXOJWuZqI5wPt4eofqynT25kMmHbngTxNhtEPtJLVwv0Ecytb1YFeX2YtjYYOKdL\n SzHARPofiPIgp7tlL3Sf9GTibg/pVNWMdO3osK+GPQFS1GlKzbc7p+CXOXhEkVB3wm+P\n H+YQ==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20210112; t=1679568044;\n h=content-transfer-encoding:mime-version:message-id:date:subject:cc\n :to:from:x-gm-message-state:from:to:cc:subject:date:message-id\n :reply-to;\n bh=rDkeo/v/KKskDhUMaT/MrzylGK8d5B7LNnmlGMplVJQ=;\n b=NSLTgn4aF+RZqbfjDX4ZJZw5TUDDSBcSa1d2uhFLJpzXyE87JUewa9iWnwIkG7U3F8\n dIVe/7xlQYlwzu+3rCtDlqkkeObSKvJ8sxFc50Z1zkkPFGOAgC/qLkPEIQ3YZ7R2rtjF\n MKhUOJwewMA4C3W7gHsbC5aaAVW8hpq45Wsd8IzbOj3iW/R67MU5nrX+s5zr+ttYsc/7\n DeAUtACnKbd9YGiVWa5RHeLHNMnR9mj2COq3XoOEa8MUk1R1wZ7VNAhhuHwCXEx1dEVi\n j4eBhMWpYR5ahBeCpxPMiWH/+8RLhY8qCMr/TQ3I99kMLESjkhBluS1vlrYpoC6rn8oi\n 1WMw==", "X-Gm-Message-State": "AO0yUKUiOraj7nmSCpSe5N1b19jpr6NJ4eGXEzyCTG0Lnshnr1SJ+Iel\n B1HoGlwpN8iJ2gcj5ZHL8aaxUw==", "X-Google-Smtp-Source": "\n AK7set/XeWgfya+1Wf9f+lZvYN+majeeh6a1Tb7xbiLi5NlrQJ29rMGv27aa4ssyq4cXeV8HVDpqbA==", "X-Received": "by 2002:a17:906:229a:b0:932:9d28:9668 with SMTP id\n p26-20020a170906229a00b009329d289668mr10111013eja.6.1679568044089;\n Thu, 23 Mar 2023 03:40:44 -0700 (PDT)", "From": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "To": "thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, lijuan.tu@intel.com,\n bruce.richardson@intel.com, wathsala.vithanage@arm.com,\n jspewock@iol.unh.edu", "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "Subject": "[RFC PATCH v1 0/4] dts: add dts api docs", "Date": "Thu, 23 Mar 2023 11:40:36 +0100", "Message-Id": "<20230323104040.484708-1-juraj.linkes@pantheon.tech>", "X-Mailer": "git-send-email 2.30.2", "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": "Augment the meson build system with dts api generation. The api docs are\ngenerated from Python docstrings in DTS using Sphinx. The format of\nchoice is the Google format [0].\n\nThe guide html sphinx configuration is used to preserve the same style.\n\nThe build requires the same Python version and dependencies as DTS,\nbecause Sphinx imports the Python modules. Dependencies are installed\nusing 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> doc\n\nThere's only one properly documented module that serves as a\ndemonstration of the style - framework.testbed_model.node.\n\nI didn't figure out how to separate dts build from the rest of the docs,\nwhich I think is required because of the different dependencies.\nI thought the enable_docs option would do this, so I added\nenable_dts_docs, but it doesn't seem to be working. Requesting comment\non this.\n\n[0] https://google.github.io/styleguide/pyguide.html#s3.8.4-comments-in-classes\n\nJuraj Linkeš (4):\n dts: code adjustments for sphinx\n dts: add doc generation dependencies\n dts: add doc generation\n dts: format docstrigs to google format\n\n doc/api/meson.build | 1 +\n doc/guides/conf.py | 22 +-\n doc/guides/meson.build | 1 +\n doc/guides/tools/dts.rst | 29 +\n doc/meson.build | 5 -\n dts/doc-index.rst | 20 +\n dts/framework/config/__init__.py | 11 +\n .../{testbed_model/hw => config}/cpu.py | 13 +\n dts/framework/dts.py | 8 +-\n dts/framework/remote_session/__init__.py | 3 +-\n dts/framework/remote_session/linux_session.py | 2 +-\n dts/framework/remote_session/os_session.py | 12 +-\n .../remote_session/remote/__init__.py | 16 -\n .../{remote => }/remote_session.py | 0\n .../{remote => }/ssh_session.py | 0\n dts/framework/settings.py | 55 +-\n dts/framework/testbed_model/__init__.py | 10 +-\n dts/framework/testbed_model/hw/__init__.py | 27 -\n dts/framework/testbed_model/node.py | 164 ++--\n dts/framework/testbed_model/sut_node.py | 9 +-\n .../testbed_model/{hw => }/virtual_device.py | 0\n dts/main.py | 3 +-\n dts/meson.build | 50 ++\n dts/poetry.lock | 770 ++++++++++++++++--\n dts/pyproject.toml | 7 +\n dts/tests/TestSuite_hello_world.py | 6 +-\n meson.build | 6 +\n meson_options.txt | 2 +\n 28 files changed, 1027 insertions(+), 225 deletions(-)\n create mode 100644 dts/doc-index.rst\n rename dts/framework/{testbed_model/hw => config}/cpu.py (95%)\n delete mode 100644 dts/framework/remote_session/remote/__init__.py\n rename dts/framework/remote_session/{remote => }/remote_session.py (100%)\n rename dts/framework/remote_session/{remote => }/ssh_session.py (100%)\n delete mode 100644 dts/framework/testbed_model/hw/__init__.py\n rename dts/framework/testbed_model/{hw => }/virtual_device.py (100%)\n create mode 100644 dts/meson.build" }