get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

GET /api/patches/133917/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 133917,
    "url": "http://patches.dpdk.org/api/patches/133917/?format=api",
    "web_url": "http://patches.dpdk.org/project/dpdk/patch/20231106171601.160749-17-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": "<20231106171601.160749-17-juraj.linkes@pantheon.tech>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20231106171601.160749-17-juraj.linkes@pantheon.tech",
    "date": "2023-11-06T17:15:54",
    "name": "[v5,16/23] dts: posix and linux sessions docstring update",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "7405524ed0a6cddea4532f71c4fdcc48aee5a330",
    "submitter": {
        "id": 1626,
        "url": "http://patches.dpdk.org/api/people/1626/?format=api",
        "name": "Juraj Linkeš",
        "email": "juraj.linkes@pantheon.tech"
    },
    "delegate": {
        "id": 2642,
        "url": "http://patches.dpdk.org/api/users/2642/?format=api",
        "username": "mcoquelin",
        "first_name": "Maxime",
        "last_name": "Coquelin",
        "email": "maxime.coquelin@redhat.com"
    },
    "mbox": "http://patches.dpdk.org/project/dpdk/patch/20231106171601.160749-17-juraj.linkes@pantheon.tech/mbox/",
    "series": [
        {
            "id": 30173,
            "url": "http://patches.dpdk.org/api/series/30173/?format=api",
            "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30173",
            "date": "2023-11-06T17:15:38",
            "name": "dts: add dts api docs",
            "version": 5,
            "mbox": "http://patches.dpdk.org/series/30173/mbox/"
        }
    ],
    "comments": "http://patches.dpdk.org/api/patches/133917/comments/",
    "check": "success",
    "checks": "http://patches.dpdk.org/api/patches/133917/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 mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 19B41432BB;\n\tMon,  6 Nov 2023 18:18:25 +0100 (CET)",
            "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 768C142D99;\n\tMon,  6 Nov 2023 18:16:30 +0100 (CET)",
            "from mail-ej1-f43.google.com (mail-ej1-f43.google.com\n [209.85.218.43]) by mails.dpdk.org (Postfix) with ESMTP id 0758742D26\n for <dev@dpdk.org>; Mon,  6 Nov 2023 18:16:27 +0100 (CET)",
            "by mail-ej1-f43.google.com with SMTP id\n a640c23a62f3a-9c5b313b3ffso706272966b.0\n for <dev@dpdk.org>; Mon, 06 Nov 2023 09:16:27 -0800 (PST)",
            "from jlinkes-PT-Latitude-5530.. (ip-46.34.243.197.o2inet.sk.\n [46.34.243.197]) by smtp.gmail.com with ESMTPSA id\n s10-20020a170906354a00b009b947aacb4bsm47016eja.191.2023.11.06.09.16.25\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Mon, 06 Nov 2023 09:16:26 -0800 (PST)"
        ],
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=pantheon.tech; s=google; t=1699290986; x=1699895786; 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=HtpE/O7NYRazzLGD2fslpp4IFCJwcEtAC0VMwjolv2s=;\n b=nXDZk+fdNlGA3uEHYKiKFz807uJdHpTyE2IdswApn24TC14yRT0z3z+z2okWo4sD8L\n aZ3vAGfX/Pxh5+VwzFEFd1YIzdBfC3Pe9LansMtvjrN7lV+VOP1q2nqYd3cWnw72Vtp0\n YftmDqCB7XRStVDW3L4QCTWRh73C+cvEY5aDt8RU9XmSlcy2PcQk+wRFk1toXxYFhC8c\n +hUyw/Upr+Fxmq9o0WDMK3hmUdgdqaBXa2nUgt8RfP8gBthMIv2N2IxT24yZCrJZZPXX\n YeD+/0MkC+BSX6qMWQC79vs7Hhlrb9l27iDwOyLL4agWzVFJw+2k6VPhYcCLiRi+cABl\n n6wQ==",
        "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1699290986; x=1699895786;\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=HtpE/O7NYRazzLGD2fslpp4IFCJwcEtAC0VMwjolv2s=;\n b=rEf6+wlkLOplaQO3aCpDdHCl0I99M0joOJbWeRH2uc3MOxSh657UWFF0bI+V0YFp1Y\n K6NNVq8vWmyzhG3x5U68O17pbZTTF+9dZCuGdBhHrjIyt/KmF/aIm/6HWoIAh1/ohqvA\n 3QTVWLr4bv+M6kcEX6uwF7ybHgqlb7/7/Ajw5eU4yb2KBMkJC/AFZAgkiIt3X+hYF5xD\n In/jawuiCwauT6DX4jRB7mvWlecqGfIimFEW2zXwrjOMvINum9B2aQpHDPbXAeVH4b0l\n whhKpv6eC9rDF7yMBV9BDJrQk8UtSk5waR7q8tMEWjG8J4bhe67UeVsUWdmujhGMj0sz\n ZOBw==",
        "X-Gm-Message-State": "AOJu0YzEW9HPiSbGgJmPEvsaFcPMrPLw/17EsFiMg5CyUvrRKl77Tvb1\n RMe1ivcXXCnJDbrJ1v/XUGe89Q==",
        "X-Google-Smtp-Source": "\n AGHT+IHgFJUv4rH+R7DzwwOH4JEmonf9hGjCRIrygdh58tycr1AptjGA3pL5K4eC/lAunzbkx/VjIQ==",
        "X-Received": "by 2002:a17:907:6e88:b0:9dd:878d:1c47 with SMTP id\n sh8-20020a1709076e8800b009dd878d1c47mr8690437ejc.17.1699290986666;\n Mon, 06 Nov 2023 09:16:26 -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 v5 16/23] dts: posix and linux sessions docstring update",
        "Date": "Mon,  6 Nov 2023 18:15:54 +0100",
        "Message-Id": "<20231106171601.160749-17-juraj.linkes@pantheon.tech>",
        "X-Mailer": "git-send-email 2.34.1",
        "In-Reply-To": "<20231106171601.160749-1-juraj.linkes@pantheon.tech>",
        "References": "<20230831100407.59865-1-juraj.linkes@pantheon.tech>\n <20231106171601.160749-1-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": "Format according to the Google format and PEP257, with slight\ndeviations.\n\nSigned-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>\n---\n dts/framework/testbed_model/linux_session.py | 63 ++++++++++-----\n dts/framework/testbed_model/posix_session.py | 81 +++++++++++++++++---\n 2 files changed, 113 insertions(+), 31 deletions(-)",
    "diff": "diff --git a/dts/framework/testbed_model/linux_session.py b/dts/framework/testbed_model/linux_session.py\nindex f472bb8f0f..279954ff63 100644\n--- a/dts/framework/testbed_model/linux_session.py\n+++ b/dts/framework/testbed_model/linux_session.py\n@@ -2,6 +2,13 @@\n # Copyright(c) 2023 PANTHEON.tech s.r.o.\n # Copyright(c) 2023 University of New Hampshire\n \n+\"\"\"Linux OS translator.\n+\n+Translate OS-unaware calls into Linux calls/utilities. Most of Linux distributions are mostly\n+compliant with POSIX standards, so this module only implements the parts that aren't.\n+This intermediate module implements the common parts of mostly POSIX compliant distributions.\n+\"\"\"\n+\n import json\n from ipaddress import IPv4Interface, IPv6Interface\n from typing import TypedDict, Union\n@@ -17,43 +24,51 @@\n \n \n class LshwConfigurationOutput(TypedDict):\n+    \"\"\"The relevant parts of ``lshw``'s ``configuration`` section.\"\"\"\n+\n+    #:\n     link: str\n \n \n class LshwOutput(TypedDict):\n-    \"\"\"\n-    A model of the relevant information from json lshw output, e.g.:\n-    {\n-    ...\n-    \"businfo\" : \"pci@0000:08:00.0\",\n-    \"logicalname\" : \"enp8s0\",\n-    \"version\" : \"00\",\n-    \"serial\" : \"52:54:00:59:e1:ac\",\n-    ...\n-    \"configuration\" : {\n-      ...\n-      \"link\" : \"yes\",\n-      ...\n-    },\n-    ...\n+    \"\"\"A model of the relevant information from ``lshw``'s json output.\n+\n+    e.g.::\n+\n+        {\n+        ...\n+        \"businfo\" : \"pci@0000:08:00.0\",\n+        \"logicalname\" : \"enp8s0\",\n+        \"version\" : \"00\",\n+        \"serial\" : \"52:54:00:59:e1:ac\",\n+        ...\n+        \"configuration\" : {\n+          ...\n+          \"link\" : \"yes\",\n+          ...\n+        },\n+        ...\n     \"\"\"\n \n+    #:\n     businfo: str\n+    #:\n     logicalname: NotRequired[str]\n+    #:\n     serial: NotRequired[str]\n+    #:\n     configuration: LshwConfigurationOutput\n \n \n class LinuxSession(PosixSession):\n-    \"\"\"\n-    The implementation of non-Posix compliant parts of Linux remote sessions.\n-    \"\"\"\n+    \"\"\"The implementation of non-Posix compliant parts of Linux.\"\"\"\n \n     @staticmethod\n     def _get_privileged_command(command: str) -> str:\n         return f\"sudo -- sh -c '{command}'\"\n \n     def get_remote_cpus(self, use_first_core: bool) -> list[LogicalCore]:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.get_remote_cpus`.\"\"\"\n         cpu_info = self.send_command(\"lscpu -p=CPU,CORE,SOCKET,NODE|grep -v \\\\#\").stdout\n         lcores = []\n         for cpu_line in cpu_info.splitlines():\n@@ -65,18 +80,20 @@ def get_remote_cpus(self, use_first_core: bool) -> list[LogicalCore]:\n         return lcores\n \n     def get_dpdk_file_prefix(self, dpdk_prefix: str) -> str:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.get_dpdk_file_prefix`.\"\"\"\n         return dpdk_prefix\n \n-    def setup_hugepages(self, hugepage_amount: int, force_first_numa: bool) -> None:\n+    def setup_hugepages(self, hugepage_count: int, force_first_numa: bool) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.setup_hugepages`.\"\"\"\n         self._logger.info(\"Getting Hugepage information.\")\n         hugepage_size = self._get_hugepage_size()\n         hugepages_total = self._get_hugepages_total()\n         self._numa_nodes = self._get_numa_nodes()\n \n-        if force_first_numa or hugepages_total != hugepage_amount:\n+        if force_first_numa or hugepages_total != hugepage_count:\n             # when forcing numa, we need to clear existing hugepages regardless\n             # of size, so they can be moved to the first numa node\n-            self._configure_huge_pages(hugepage_amount, hugepage_size, force_first_numa)\n+            self._configure_huge_pages(hugepage_count, hugepage_size, force_first_numa)\n         else:\n             self._logger.info(\"Hugepages already configured.\")\n         self._mount_huge_pages()\n@@ -140,6 +157,7 @@ def _configure_huge_pages(\n         )\n \n     def update_ports(self, ports: list[Port]) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.update_ports`.\"\"\"\n         self._logger.debug(\"Gathering port info.\")\n         for port in ports:\n             assert (\n@@ -178,6 +196,7 @@ def _update_port_attr(\n             )\n \n     def configure_port_state(self, port: Port, enable: bool) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.configure_port_state`.\"\"\"\n         state = \"up\" if enable else \"down\"\n         self.send_command(\n             f\"ip link set dev {port.logical_name} {state}\", privileged=True\n@@ -189,6 +208,7 @@ def configure_port_ip_address(\n         port: Port,\n         delete: bool,\n     ) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.configure_port_ip_address`.\"\"\"\n         command = \"del\" if delete else \"add\"\n         self.send_command(\n             f\"ip address {command} {address} dev {port.logical_name}\",\n@@ -197,5 +217,6 @@ def configure_port_ip_address(\n         )\n \n     def configure_ipv4_forwarding(self, enable: bool) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.configure_ipv4_forwarding`.\"\"\"\n         state = 1 if enable else 0\n         self.send_command(f\"sysctl -w net.ipv4.ip_forward={state}\", privileged=True)\ndiff --git a/dts/framework/testbed_model/posix_session.py b/dts/framework/testbed_model/posix_session.py\nindex 1d1d5b1b26..a4824aa274 100644\n--- a/dts/framework/testbed_model/posix_session.py\n+++ b/dts/framework/testbed_model/posix_session.py\n@@ -2,6 +2,15 @@\n # Copyright(c) 2023 PANTHEON.tech s.r.o.\n # Copyright(c) 2023 University of New Hampshire\n \n+\"\"\"POSIX compliant OS translator.\n+\n+Translates OS-unaware calls into POSIX compliant calls/utilities. POSIX is a set of standards\n+for portability between Unix operating systems which not all Linux distributions\n+(or the tools most frequently bundled with said distributions) adhere to. Most of Linux\n+distributions are mostly compliant though.\n+This intermediate module implements the common parts of mostly POSIX compliant distributions.\n+\"\"\"\n+\n import re\n from collections.abc import Iterable\n from pathlib import PurePath, PurePosixPath\n@@ -15,13 +24,21 @@\n \n \n class PosixSession(OSSession):\n-    \"\"\"\n-    An intermediary class implementing the Posix compliant parts of\n-    Linux and other OS remote sessions.\n-    \"\"\"\n+    \"\"\"An intermediary class implementing the POSIX standard.\"\"\"\n \n     @staticmethod\n     def combine_short_options(**opts: bool) -> str:\n+        \"\"\"Combine shell options into one argument.\n+\n+        These are options such as ``-x``, ``-v``, ``-f`` which are combined into ``-xvf``.\n+\n+        Args:\n+            opts: The keys are option names (usually one letter) and the bool values indicate\n+                whether to include the option in the resulting argument.\n+\n+        Returns:\n+            The options combined into one argument.\n+        \"\"\"\n         ret_opts = \"\"\n         for opt, include in opts.items():\n             if include:\n@@ -33,17 +50,19 @@ def combine_short_options(**opts: bool) -> str:\n         return ret_opts\n \n     def guess_dpdk_remote_dir(self, remote_dir: str | PurePath) -> PurePosixPath:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.guess_dpdk_remote_dir`.\"\"\"\n         remote_guess = self.join_remote_path(remote_dir, \"dpdk-*\")\n         result = self.send_command(f\"ls -d {remote_guess} | tail -1\")\n         return PurePosixPath(result.stdout)\n \n     def get_remote_tmp_dir(self) -> PurePosixPath:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.get_remote_tmp_dir`.\"\"\"\n         return PurePosixPath(\"/tmp\")\n \n     def get_dpdk_build_env_vars(self, arch: Architecture) -> dict:\n-        \"\"\"\n-        Create extra environment variables needed for i686 arch build. Get information\n-        from the node if needed.\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.get_dpdk_build_env_vars`.\n+\n+        Supported architecture: ``i686``.\n         \"\"\"\n         env_vars = {}\n         if arch == Architecture.i686:\n@@ -63,6 +82,7 @@ def get_dpdk_build_env_vars(self, arch: Architecture) -> dict:\n         return env_vars\n \n     def join_remote_path(self, *args: str | PurePath) -> PurePosixPath:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.join_remote_path`.\"\"\"\n         return PurePosixPath(*args)\n \n     def copy_from(\n@@ -70,6 +90,7 @@ def copy_from(\n         source_file: str | PurePath,\n         destination_file: str | PurePath,\n     ) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.copy_from`.\"\"\"\n         self.remote_session.copy_from(source_file, destination_file)\n \n     def copy_to(\n@@ -77,6 +98,7 @@ def copy_to(\n         source_file: str | PurePath,\n         destination_file: str | PurePath,\n     ) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.copy_to`.\"\"\"\n         self.remote_session.copy_to(source_file, destination_file)\n \n     def remove_remote_dir(\n@@ -85,6 +107,7 @@ def remove_remote_dir(\n         recursive: bool = True,\n         force: bool = True,\n     ) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.remove_remote_dir`.\"\"\"\n         opts = PosixSession.combine_short_options(r=recursive, f=force)\n         self.send_command(f\"rm{opts} {remote_dir_path}\")\n \n@@ -93,6 +116,7 @@ def extract_remote_tarball(\n         remote_tarball_path: str | PurePath,\n         expected_dir: str | PurePath | None = None,\n     ) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.extract_remote_tarball`.\"\"\"\n         self.send_command(\n             f\"tar xfm {remote_tarball_path} \"\n             f\"-C {PurePosixPath(remote_tarball_path).parent}\",\n@@ -110,6 +134,7 @@ def build_dpdk(\n         rebuild: bool = False,\n         timeout: float = SETTINGS.compile_timeout,\n     ) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.build_dpdk`.\"\"\"\n         try:\n             if rebuild:\n                 # reconfigure, then build\n@@ -140,12 +165,14 @@ def build_dpdk(\n             raise DPDKBuildError(f\"DPDK build failed when doing '{e.command}'.\")\n \n     def get_dpdk_version(self, build_dir: str | PurePath) -> str:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.get_dpdk_version`.\"\"\"\n         out = self.send_command(\n             f\"cat {self.join_remote_path(build_dir, 'VERSION')}\", verify=True\n         )\n         return out.stdout\n \n     def kill_cleanup_dpdk_apps(self, dpdk_prefix_list: Iterable[str]) -> None:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.kill_cleanup_dpdk_apps`.\"\"\"\n         self._logger.info(\"Cleaning up DPDK apps.\")\n         dpdk_runtime_dirs = self._get_dpdk_runtime_dirs(dpdk_prefix_list)\n         if dpdk_runtime_dirs:\n@@ -159,6 +186,14 @@ def kill_cleanup_dpdk_apps(self, dpdk_prefix_list: Iterable[str]) -> None:\n     def _get_dpdk_runtime_dirs(\n         self, dpdk_prefix_list: Iterable[str]\n     ) -> list[PurePosixPath]:\n+        \"\"\"Find runtime directories DPDK apps are currently using.\n+\n+        Args:\n+              dpdk_prefix_list: The prefixes DPDK apps were started with.\n+\n+        Returns:\n+            The paths of DPDK apps' runtime dirs.\n+        \"\"\"\n         prefix = PurePosixPath(\"/var\", \"run\", \"dpdk\")\n         if not dpdk_prefix_list:\n             remote_prefixes = self._list_remote_dirs(prefix)\n@@ -170,9 +205,13 @@ def _get_dpdk_runtime_dirs(\n         return [PurePosixPath(prefix, dpdk_prefix) for dpdk_prefix in dpdk_prefix_list]\n \n     def _list_remote_dirs(self, remote_path: str | PurePath) -> list[str] | None:\n-        \"\"\"\n-        Return a list of directories of the remote_dir.\n-        If remote_path doesn't exist, return None.\n+        \"\"\"Contents of remote_path.\n+\n+        Args:\n+            remote_path: List the contents of this path.\n+\n+        Returns:\n+            The contents of remote_path. If remote_path doesn't exist, return None.\n         \"\"\"\n         out = self.send_command(\n             f\"ls -l {remote_path} | awk '/^d/ {{print $NF}}'\"\n@@ -183,6 +222,17 @@ def _list_remote_dirs(self, remote_path: str | PurePath) -> list[str] | None:\n             return out.splitlines()\n \n     def _get_dpdk_pids(self, dpdk_runtime_dirs: Iterable[str | PurePath]) -> list[int]:\n+        \"\"\"Find PIDs of running DPDK apps.\n+\n+        Look at each \"config\" file found in dpdk_runtime_dirs and find the PIDs of processes\n+        that opened those file.\n+\n+        Args:\n+            dpdk_runtime_dirs: The paths of DPDK apps' runtime dirs.\n+\n+        Returns:\n+            The PIDs of running DPDK apps.\n+        \"\"\"\n         pids = []\n         pid_regex = r\"p(\\d+)\"\n         for dpdk_runtime_dir in dpdk_runtime_dirs:\n@@ -203,6 +253,14 @@ def _remote_files_exists(self, remote_path: PurePath) -> bool:\n     def _check_dpdk_hugepages(\n         self, dpdk_runtime_dirs: Iterable[str | PurePath]\n     ) -> None:\n+        \"\"\"Check there aren't any leftover hugepages.\n+\n+        If any hugegapes are found, emit a warning. The hugepages are investigated in the\n+        \"hugepage_info\" file of dpdk_runtime_dirs.\n+\n+        Args:\n+            dpdk_runtime_dirs: The paths of DPDK apps' runtime dirs.\n+        \"\"\"\n         for dpdk_runtime_dir in dpdk_runtime_dirs:\n             hugepage_info = PurePosixPath(dpdk_runtime_dir, \"hugepage_info\")\n             if self._remote_files_exists(hugepage_info):\n@@ -220,9 +278,11 @@ def _remove_dpdk_runtime_dirs(\n             self.remove_remote_dir(dpdk_runtime_dir)\n \n     def get_dpdk_file_prefix(self, dpdk_prefix: str) -> str:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.get_dpdk_file_prefix`.\"\"\"\n         return \"\"\n \n     def get_compiler_version(self, compiler_name: str) -> str:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.get_compiler_version`.\"\"\"\n         match compiler_name:\n             case \"gcc\":\n                 return self.send_command(\n@@ -240,6 +300,7 @@ def get_compiler_version(self, compiler_name: str) -> str:\n                 raise ValueError(f\"Unknown compiler {compiler_name}\")\n \n     def get_node_info(self) -> NodeInfo:\n+        \"\"\"Overrides :meth:`~.os_session.OSSession.get_node_info`.\"\"\"\n         os_release_info = self.send_command(\n             \"awk -F= '$1 ~ /^NAME$|^VERSION$/ {print $2}' /etc/os-release\",\n             SETTINGS.timeout,\n",
    "prefixes": [
        "v5",
        "16/23"
    ]
}